Skip to content

Commit ca12739

Browse files
update oxlint docs
1 parent 4c37019 commit ca12739

File tree

1 file changed

+23
-8
lines changed

1 file changed

+23
-8
lines changed

docs/tools/oxlint.md

+23-8
Original file line numberDiff line numberDiff line change
@@ -12,33 +12,48 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
1212

1313
[Oxlint](https://github.com/oxc-project/oxc) is a blazingly fast JavaScript/TypeScript linter written in Rust that is 50-100x faster than ESLint.
1414

15-
## Files
15+
## Supported Files
1616

1717
Oxlint will run on files with the following extensions:
1818

1919
- `.js`
20+
- `.mjs`
21+
- `.cjs`
2022
- `.jsx`
2123
- `.ts`
24+
- `.mts`
25+
- `.cts`
2226
- `.tsx`
27+
- `.vue`
28+
- `.astro`
29+
- `.svelte`
2330

2431
## Configuration
2532

26-
Oxlint supports the following config files:
33+
Oxlint supports the following configuration file:
2734

28-
- `Oxlint.json`
29-
- `.Oxlintrc`
30-
- `.Oxlintrc.json`
31-
- `Oxlint.config.json`
35+
- `.oxlintrc.json`
3236

3337
:::note
3438

3539
Oxlint does not require configuration to run. If no Oxlint config file is found and Biome is enabled, CodeRabbit will use Biome instead as Oxlint functionality is included within Biome. If Biome is not enabled or an Oxlint config file is found, CodeRabbit will use the default Oxlint config.
3640

3741
:::
3842

39-
## Rule Configuration
43+
## Integration Details
4044

41-
While Oxlint embraces convention over configuration, you can customize rules in your config file if needed. The config file should be in JSON format. See the [Oxlint documentation](https://oxc-project.github.io) for more details on available rules and configuration options.
45+
When running Oxlint, CodeRabbit:
46+
47+
1. Checks if Oxlint is enabled in your configuration
48+
2. Verifies if a `.oxlintrc.json` configuration file exists
49+
3. Processes files in parallel with a limit of 5 concurrent tasks
50+
4. Uses the `--format=json` and `--deny-warnings` flags for consistent output
51+
5. Maps the output to standardized findings with:
52+
- Start line number
53+
- End line number
54+
- Error message
55+
- Category (rule code)
56+
- Severity level
4257

4358
## Links
4459

0 commit comments

Comments
 (0)