Skip to content

Commit 3554a4d

Browse files
committed
Update docs to reflect type-aware linting support in preview
1 parent 4cd0796 commit 3554a4d

File tree

2 files changed

+18
-2
lines changed

2 files changed

+18
-2
lines changed

src/docs/guide/usage/linter.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,26 @@ and run Oxlint before ESLint in your local or CI setup for a quicker feedback lo
3434
- Supports:
3535
- JavaScript and TypeScript by their extensions `js`, `mjs`, `cjs`, `jsx`, `ts`, `mts`, `cts` and `tsx`.
3636
- `<script>` content of `.vue`, `.astro` and `.svelte` files.
37+
- [type-aware rules](https://typescript-eslint.io/getting-started/typed-linting) defined by `typescript-eslint` (preview, requires `--type-aware` flag and `oxlint-tsgolint` package).
3738
- No support for:
38-
- [type-aware rules](https://typescript-eslint.io/getting-started/typed-linting) defined by `typescript-eslint`.
3939
- [stylistic rules](https://eslint.style).
4040

41+
### Type-Aware Linting (Preview)
42+
43+
Oxlint supports type-aware rules in preview mode. To enable type-aware linting:
44+
45+
1. Install the required dependency:
46+
```bash
47+
pnpm add -D oxlint-tsgolint@latest
48+
```
49+
50+
2. Run oxlint with the `--type-aware` flag:
51+
```bash
52+
pnpm dlx oxlint --type-aware
53+
```
54+
55+
For more details and the list of supported type-aware rules, see the [type-aware linting announcement](/blog/2025-08-17-oxlint-type-aware).
56+
4157
## Installation
4258

4359
Run `oxlint` directly at the root of your repository:

src/docs/guide/usage/linter/plugins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ plan`](https://github.com/oxc-project/oxc/issues/481) issue on GitHub.
8282

8383
| Plugin Name | Default? | Issue | Notes |
8484
| ------------ | -------- | ---------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
85-
| `typescript` || [#2180](https://github.com/oxc-project/oxc/issues/2180) | TypeScript-specific rules from [`@typescript-eslint`](https://typescript-eslint.io/rules/). We do not currently support rules that require type information. |
85+
| `typescript` || [#2180](https://github.com/oxc-project/oxc/issues/2180) | TypeScript-specific rules from [`@typescript-eslint`](https://typescript-eslint.io/rules/). Type-aware rules are supported in preview (use `--type-aware` flag). |
8686
| `unicorn` || [#684](https://github.com/oxc-project/oxc/issues/684) | Rules ported from [`eslint-plugin-unicorn`](https://github.com/sindresorhus/eslint-plugin-unicorn) |
8787
| `react` | | [#1022](https://github.com/oxc-project/oxc/issues/1022), [#2174](https://github.com/oxc-project/oxc/issues/2174) | Rules ported from [`eslint-plugin-react`](https://www.npmjs.com/package/eslint-plugin-react) and [`eslint-plugin-react-hooks`](https://www.npmjs.com/package/eslint-plugin-react-hooks) |
8888
| `react-perf` | | [#2041](https://github.com/oxc-project/oxc/issues/2041) | Rules ported from [`eslint-plugin-react-perf`](https://github.com/cvazac/eslint-plugin-react-perf) |

0 commit comments

Comments
 (0)