feat: examples for flat configs and type information

package.json

@@ -3,7 +3,7 @@
   "version": "0.0.0",
   "description": "Various examples of working with typescript-eslint. 📝",
   "main": "index.js",
-  "repository": "https://github.com/typescript-eslint/typescript-eslint-examples",
+  "repository": "typescript-eslint/typescript-eslint-examples",
   "author": "Josh Goldberg <git@joshuakgoldberg.com>",
   "license": "MIT",
   "workspaces": [

packages/flat-config-disable-type-checked/README.md

@@ -0,0 +1,27 @@
+# Example: Flat Config and disable-type-checked
+
+An example of using the [`typescript-eslint`](https://typescript-eslint.io/packages/typescript-eslint) package to lint TypeScript code with type information.
+
+## Setup
+
+```shell
+npm i
+```
+
+## Usage
+
+```shell
+npm run lint
+```
+
+```plaintext
+> flat-config-untyped@0.0.0 lint
+> eslint .
+
+
+~/typescript-eslint-examples/packages/flat-config-disable-type-checked/eslint.config.js
+  6:7  error  'unused' is assigned a value but never used  @typescript-eslint/no-unused-vars
+
+~/typescript-eslint-examples/packages/flat-config-disable-type-checked/src/index.ts
+  8:5  error  Unexpected `await` of a non-Promise (non-"Thenable") value  @typescript-eslint/await-thenable
+```

packages/flat-config-disable-type-checked/eslint.config.js

@@ -0,0 +1,22 @@
+// @ts-check
+
+import eslint from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+const unused = true;
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  ...tseslint.configs.recommendedTypeChecked,
+  {
+    languageOptions: {
+      parserOptions: {
+        project: true,
+      },
+    },
+  },
+  {
+    files: ["*.js"],
+    ...tseslint.configs.disableTypeChecked,
+  }
+);

packages/flat-config-disable-type-checked/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "flat-config-disable-type-checked",
+  "version": "0.0.0",
+  "description": "Example of using `typescript-eslint` with ESLint's flat config and type information, with disable-type-checked for .js files.",
+  "main": "index.ts",
+  "repository": {
+    "directory": "packages/flat-config-disable-type-checked",
+    "type": "git",
+    "url": "https://github.com/typescript-eslint/typescript-eslint-examples"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "typescript-eslint": "*",
+    "typescript": "^5.3.3",
+    "eslint": "^8.56.0"
+  },
+  "scripts": {
+    "lint": "eslint ."
+  },
+  "type": "module"
+}

packages/flat-config-disable-type-checked/src/index.ts

@@ -0,0 +1,10 @@
+export interface GreetOptions {
+  message: string;
+  times: number;
+}
+
+export async function greet({ message, times }: GreetOptions) {
+  for (let i = 0; i < times; i += 1) {
+    await console.log(message);
+  }
+}

packages/flat-config-disable-type-checked/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "strict": true
+  },
+  "include": ["src"]
+}

packages/flat-config-typed-tsconfig/README.md

@@ -0,0 +1,27 @@
+# Example: Flat Config Typed with a TSConfig
+
+An example of using the [`typescript-eslint`](https://typescript-eslint.io/packages/typescript-eslint) package to lint TypeScript code with type information and a `tsconfig.eslint.json`.
+
+## Setup
+
+```shell
+npm i
+```
+
+## Usage
+
+```shell
+npm run lint
+```
+
+```plaintext
+> flat-config-typed@0.0.0 lint
+> eslint .
+
+
+~/typescript-eslint-examples/packages/flat-config-typed-tsconfig/eslint.config.js
+  6:8  error  Async function 'unecessarilyAsync' has no 'await' expression  @typescript-eslint/require-await
+
+~/typescript-eslint-examples/packages/flat-config-typed-tsconfig/src/index.ts
+  8:5  error  Unexpected `await` of a non-Promise (non-"Thenable") value  @typescript-eslint/await-thenable
+```

packages/flat-config-typed-tsconfig/eslint.config.js

@@ -0,0 +1,20 @@
+// @ts-check
+
+import eslint from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+export async function unecessarilyAsync() {
+  return true;
+}
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  ...tseslint.configs.recommendedTypeChecked,
+  {
+    languageOptions: {
+      parserOptions: {
+        project: "tsconfig.eslint.json",
+      },
+    },
+  }
+);

packages/flat-config-typed-tsconfig/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "flat-config-typed-tsconfig",
+  "version": "0.0.0",
+  "description": "Example of using `typescript-eslint` with ESLint's flat config, type information, and a `tsconfig.eslint.json`.",
+  "main": "index.ts",
+  "repository": {
+    "directory": "packages/flat-config-typed-tsconfig",
+    "type": "git",
+    "url": "https://github.com/typescript-eslint/typescript-eslint-examples"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@types/eslint__js": "^8.42.3",
+    "eslint": "^8.56.0",
+    "typescript": "^5.3.3",
+    "typescript-eslint": "*"
+  },
+  "scripts": {
+    "lint": "eslint ."
+  },
+  "type": "module"
+}

packages/flat-config-typed-tsconfig/src/index.ts

@@ -0,0 +1,10 @@
+export interface GreetOptions {
+  message: string;
+  times: number;
+}
+
+export async function greet({ message, times }: GreetOptions) {
+  for (let i = 0; i < times; i += 1) {
+    await console.log(message);
+  }
+}

packages/flat-config-typed-tsconfig/tsconfig.eslint.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "allowJs": true,
+    "noEmit": true
+  },
+  "include": ["."]
+}

packages/flat-config-typed-tsconfig/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "strict": true
+  },
+  "include": ["src"]
+}

packages/flat-config-typed/README.md

@@ -0,0 +1,24 @@
+# Example: Flat Config (Typed)
+
+An example of using the [`typescript-eslint`](https://typescript-eslint.io/packages/typescript-eslint) package to lint TypeScript code with type information.
+
+## Setup
+
+```shell
+npm i
+```
+
+## Usage
+
+```shell
+npm run lint
+```
+
+```plaintext
+> flat-config-typed@0.0.0 lint
+> eslint src
+
+
+~/typescript-eslint-examples/packages/flat-config-typed/src/index.ts
+  8:5  error  Unexpected `await` of a non-Promise (non-"Thenable") value  @typescript-eslint/await-thenable
+```

packages/flat-config-typed/eslint.config.js

@@ -0,0 +1,16 @@
+// @ts-check
+
+import eslint from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  ...tseslint.configs.recommendedTypeChecked,
+  {
+    languageOptions: {
+      parserOptions: {
+        project: true,
+      },
+    },
+  }
+);

packages/flat-config-typed/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "flat-config-typed",
+  "version": "0.0.0",
+  "description": "Example of using `typescript-eslint` with ESLint's flat config and type information.",
+  "main": "index.ts",
+  "repository": {
+    "directory": "packages/flat-config-typed",
+    "type": "git",
+    "url": "https://github.com/typescript-eslint/typescript-eslint-examples"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "typescript-eslint": "*",
+    "typescript": "^5.3.3",
+    "eslint": "^8.56.0"
+  },
+  "scripts": {
+    "lint": "eslint src"
+  },
+  "type": "module"
+}

packages/flat-config-typed/src/index.ts

@@ -0,0 +1,10 @@
+export interface GreetOptions {
+  message: string;
+  times: number;
+}
+
+export async function greet({ message, times }: GreetOptions) {
+  for (let i = 0; i < times; i += 1) {
+    await console.log(message);
+  }
+}

packages/flat-config-typed/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "strict": true
+  },
+  "include": ["src"]
+}