Skip to content

Commit 6861313

Browse files
docs: fill out README.md table
Fixes #11.
1 parent f816530 commit 6861313

File tree

3 files changed

+13
-4
lines changed

3 files changed

+13
-4
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# typescript-eslint Examples
22

33
Various examples of working with typescript-eslint. 📝
4-
We may add to this over time, or we may get rid of it in favor of [typescript-eslint.io](https://typescript-eslint.io).
5-
We'll see.
4+
5+
| Example | Use Case |
6+
| --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
7+
| [`eslint-plugin-example-typed-linting`](./examples/eslint-plugin-example-typed-linting) | ESLint plugin showing typed linting with `@typescript-eslint/utils`. |
8+
| [`flat-config-disable-type-checked`](./examples/flat-config-disable-type-checked) | Linting TypeScript code with type information, disabling typed rules on `*.js` files. |
9+
| [`flat-config-typed`](./examples/flat-config-typed) | Linting TypeScript code with type information using Project Service. |
10+
| [`flat-config-typed-tsconfig`](./examples/flat-config-typed-tsconfig) | Linting TypeScript code with type information and a `tsconfig.eslint.json`. |
11+
| [`flat-config-untyped`](./examples/flat-config-untyped) | Linting TypeScript code without type information. |
12+
| [`node-test-floating-promises`](./examples/node-test-floating-promises) | Using `node:test` along the `@typescript-eslint/no-floating-promises` `allowForKnownSafeCalls` option. |
13+
| [`typed-rule-via-linter`](./examples/typed-rule-via-linter) | Running a single typed rule via ESLint's `Linter` class. |
14+
| [`typescript-estree-standalone`](./examples/typescript-estree-standalone) | Using the `@typescript-eslint/estree` package to generate an AST standalone (without ESLint). |

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Example: Flat Config and disable-type-checked
22

3-
An example of using the [`typescript-eslint`](https://typescript-eslint.io/packages/typescript-eslint) package to lint TypeScript code with type information.
3+
An example of using the [`typescript-eslint`](https://typescript-eslint.io/packages/typescript-eslint) package to lint TypeScript code with type information, disabling type checked rules on `*.js` files.
44

55
## Setup
66

packages/flat-config-typed/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Example: Flat Config (Typed)
22

3-
An example of using the [`typescript-eslint`](https://typescript-eslint.io/packages/typescript-eslint) package to lint TypeScript code with type information.
3+
An example of using the [`typescript-eslint`](https://typescript-eslint.io/packages/typescript-eslint) package to lint TypeScript code with type information using Project Service.
44

55
## Setup
66

0 commit comments

Comments
 (0)