Skip to content

Commit 8b3fae6

Browse files
Copilotcamchenry
Copilot
and
camchenry
committed
Format docs to fix line length issues - improve readability by breaking long lines
Co-authored-by: camchenry <[email protected]>
1 parent 3554a4d commit 8b3fae6

File tree

2 files changed

+30
-20
lines changed

2 files changed

+30
-20
lines changed

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

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,18 @@ Oxlint is designed to catch erroneous or useless code without requiring any conf
1515
:::info
1616
At this stage, Oxlint can be used to fully replace ESLint in small to medium projects.
1717

18-
For larger projects, our advice is to turn off ESLint rules via [eslint-plugin-oxlint](https://www.npmjs.com/package/eslint-plugin-oxlint),
18+
For larger projects, our advice is to turn off ESLint rules via
19+
[eslint-plugin-oxlint](https://www.npmjs.com/package/eslint-plugin-oxlint),
1920
and run Oxlint before ESLint in your local or CI setup for a quicker feedback loop.
2021
:::
2122

2223
## Features
2324

24-
- 50 - 100 times faster than ESLint, and scales with the number of CPU cores ([benchmark](https://github.com/oxc-project/bench-javascript-linter)).
25-
- Over 520 rules with a growing list from `eslint`, `typescript`, `eslint-plugin-react`, `eslint-plugin-jest`, `eslint-plugin-unicorn`, `eslint-plugin-jsx-a11y` and [many more](https://github.com/oxc-project/oxc/issues/481).
25+
- 50 - 100 times faster than ESLint, and scales with the number of CPU cores
26+
([benchmark](https://github.com/oxc-project/bench-javascript-linter)).
27+
- Over 520 rules with a growing list from `eslint`, `typescript`, `eslint-plugin-react`,
28+
`eslint-plugin-jest`, `eslint-plugin-unicorn`, `eslint-plugin-jsx-a11y` and
29+
[many more](https://github.com/oxc-project/oxc/issues/481).
2630
- Supports
2731
- [`.oxlintrc.json` configuration file](./linter/config).
2832
- [Nested configuration file](./linter/nested-config)
@@ -34,7 +38,8 @@ and run Oxlint before ESLint in your local or CI setup for a quicker feedback lo
3438
- Supports:
3539
- JavaScript and TypeScript by their extensions `js`, `mjs`, `cjs`, `jsx`, `ts`, `mts`, `cts` and `tsx`.
3640
- `<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).
41+
- [type-aware rules](https://typescript-eslint.io/getting-started/typed-linting) defined by
42+
`typescript-eslint` (preview, requires `--type-aware` flag and `oxlint-tsgolint` package).
3843
- No support for:
3944
- [stylistic rules](https://eslint.style).
4045

@@ -52,7 +57,8 @@ Oxlint supports type-aware rules in preview mode. To enable type-aware linting:
5257
pnpm dlx oxlint --type-aware
5358
```
5459

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).
60+
For more details and the list of supported type-aware rules, see the
61+
[type-aware linting announcement](/blog/2025-08-17-oxlint-type-aware).
5662

5763
## Installation
5864

@@ -104,7 +110,8 @@ $ bun add -D oxlint
104110

105111
:::
106112

107-
`oxlint` does not require Node.js, the binaries can be downloaded from the [latest GitHub releases](https://github.com/oxc-project/oxc/releases/latest).
113+
`oxlint` does not require Node.js, the binaries can be downloaded from the
114+
[latest GitHub releases](https://github.com/oxc-project/oxc/releases/latest).
108115

109116
## Command-line Interface
110117

@@ -116,13 +123,16 @@ See [Configuration File](./linter/config)
116123

117124
## Migrate from eslint flat config
118125

119-
If you have an existing `eslint.config.*` file, you can convert it to an `.oxlintrc.json` config with [oxlint-migrate](https://github.com/oxc-project/oxlint-migrate).
126+
If you have an existing `eslint.config.*` file, you can convert it to an `.oxlintrc.json` config with
127+
[oxlint-migrate](https://github.com/oxc-project/oxlint-migrate).
120128

121129
## Integration
122130

123131
### ESLint
124132

125-
If you are looking for a way to use oxlint in projects that still need ESLint, you can use [eslint-plugin-oxlint](https://github.com/oxc-project/eslint-plugin-oxlint) to turn off ESLint rules that are already supported by oxlint. So you can enjoy the speed of oxlint while still using ESLint.
133+
If you are looking for a way to use oxlint in projects that still need ESLint, you can use
134+
[eslint-plugin-oxlint](https://github.com/oxc-project/eslint-plugin-oxlint) to turn off ESLint rules
135+
that are already supported by oxlint. So you can enjoy the speed of oxlint while still using ESLint.
126136

127137
### lint-staged
128138

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -82,19 +82,19 @@ 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/). Type-aware rules are supported in preview (use `--type-aware` flag). |
86-
| `unicorn` | ✅ | [#684](https://github.com/oxc-project/oxc/issues/684) | Rules ported from [`eslint-plugin-unicorn`](https://github.com/sindresorhus/eslint-plugin-unicorn) |
87-
| `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) |
88-
| `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) |
89-
| `nextjs` | | [#1929](https://github.com/oxc-project/oxc/issues/1929) | Rules ported from [`eslint-plugin-next`](https://nextjs.org/docs/pages/building-your-application/configuring/eslint#eslint-plugin) |
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). |
86+
| `unicorn` | ✅ | [#684](https://github.com/oxc-project/oxc/issues/684) | Rules from [`eslint-plugin-unicorn`](https://github.com/sindresorhus/eslint-plugin-unicorn) |
87+
| `react` | | [#1022](https://github.com/oxc-project/oxc/issues/1022), [#2174](https://github.com/oxc-project/oxc/issues/2174) | Rules 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) |
88+
| `react-perf` | | [#2041](https://github.com/oxc-project/oxc/issues/2041) | Rules from [`eslint-plugin-react-perf`](https://github.com/cvazac/eslint-plugin-react-perf) |
89+
| `nextjs` | | [#1929](https://github.com/oxc-project/oxc/issues/1929) | Rules from [`eslint-plugin-next`](https://nextjs.org/docs/pages/building-your-application/configuring/eslint#eslint-plugin) |
9090
| `oxc` | ✅ | N/A | Custom oxc-specific rules, as well as some rules ported from [deepscan](https://deepscan.io/) |
91-
| `import` | | [#1117](https://github.com/oxc-project/oxc/issues/1117) | Rules ported from [`eslint-plugin-import`](https://github.com/import-js/eslint-plugin-import) |
92-
| `jsdoc` | | [#1170](https://github.com/oxc-project/oxc/issues/1170) | Rules ported from [`eslint-plugin-jsdoc`](https://github.com/gajus/eslint-plugin-jsdoc) |
93-
| `jsx-a11y` | | [#1141](https://github.com/oxc-project/oxc/issues/1141) | Rules ported from [`eslint-plugin-jsx-a11y`](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y) |
94-
| `node` | | [#493](https://github.com/oxc-project/oxc/issues/493) | Rules ported from [`eslint-plugin-n`](https://github.com/eslint-community/eslint-plugin-n) |
95-
| `promise` | | [#4655](https://github.com/oxc-project/oxc/issues/4655) | Rules ported from [`eslint-plugin-promise`](https://github.com/eslint-community/eslint-plugin-promise) |
96-
| `jest` | | [#492](https://github.com/oxc-project/oxc/issues/492) | Rules ported from [`eslint-plugin-jest`](https://github.com/jest-community/eslint-plugin-jest) |
97-
| `vitest` | | [#4656](https://github.com/oxc-project/oxc/issues/4656) | Rules ported from [`eslint-plugin-vitest`](https://github.com/vitest-dev/eslint-plugin-vitest) |
91+
| `import` | | [#1117](https://github.com/oxc-project/oxc/issues/1117) | Rules from [`eslint-plugin-import`](https://github.com/import-js/eslint-plugin-import) |
92+
| `jsdoc` | | [#1170](https://github.com/oxc-project/oxc/issues/1170) | Rules from [`eslint-plugin-jsdoc`](https://github.com/gajus/eslint-plugin-jsdoc) |
93+
| `jsx-a11y` | | [#1141](https://github.com/oxc-project/oxc/issues/1141) | Rules from [`eslint-plugin-jsx-a11y`](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y) |
94+
| `node` | | [#493](https://github.com/oxc-project/oxc/issues/493) | Rules from [`eslint-plugin-n`](https://github.com/eslint-community/eslint-plugin-n) |
95+
| `promise` | | [#4655](https://github.com/oxc-project/oxc/issues/4655) | Rules from [`eslint-plugin-promise`](https://github.com/eslint-community/eslint-plugin-promise) |
96+
| `jest` | | [#492](https://github.com/oxc-project/oxc/issues/492) | Rules from [`eslint-plugin-jest`](https://github.com/jest-community/eslint-plugin-jest) |
97+
| `vitest` | | [#4656](https://github.com/oxc-project/oxc/issues/4656) | Rules from [`eslint-plugin-vitest`](https://github.com/vitest-dev/eslint-plugin-vitest) |
9898

9999
## Adding New Plugins
100100

0 commit comments

Comments
 (0)