Skip to content

Commit 50a9d8f

Browse files
Fix/oxlint2 (#324)
* fix capitalization * update oxlint docs * fix links * link and note fixes
1 parent 3bd6ed9 commit 50a9d8f

File tree

2 files changed

+23
-19
lines changed

2 files changed

+23
-19
lines changed

‎docs/changelog.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ We're thrilled to introduce agentic planning on GitHub for CodeRabbit chat as Ge
6666

6767
We've expanded our static analysis capabilities with two new tools:
6868

69-
- **oxlint**: A high-performance JavaScript/TypeScript linter written in Rust.
69+
- **Oxlint**: A high-performance JavaScript/TypeScript linter written in Rust.
7070
- **Prisma Lint**: A dedicated linter for Prisma schema files to help enforce consistent conventions and best practices.
7171

7272
Both tools can be configured through their respective config files or through CodeRabbit's settings page. See our [tools documentation](https://docs.coderabbit.ai/tools/) for more details.
@@ -124,8 +124,8 @@ We're thrilled to introduce agentic planning on GitHub for CodeRabbit chat as an
124124
We are continually expanding our support for static analysis tools. We've recently added support for:
125125

126126
- SQLFluff
127-
- Added oxlint for faster linting
128-
- oxlint is a blazingly fast JavaScript/TypeScript linter written in Rust
127+
- Added Oxlint for faster linting
128+
- Oxlint is a blazingly fast JavaScript/TypeScript linter written in Rust
129129
- Replaces ESLint for basic linting while maintaining ESLint for more complex rules
130130
- Up to 50-100x faster than traditional ESLint
131131

‎docs/tools/oxlint.md

+20-16
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: oxlint
3-
sidebar_label: oxlint
4-
description: CodeRabbit's guide to oxlint.
2+
title: Oxlint
3+
sidebar_label: Oxlint
4+
description: CodeRabbit's guide to Oxlint.
55
---
66

77
```mdx-code-block
@@ -10,37 +10,41 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
1010
<ProPlanNotice />
1111
```
1212

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

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

17-
oxlint will run on files with the following extensions:
17+
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`
3035
- `.oxlintrc.json`
31-
- `oxlint.config.json`
3236

3337
:::note
3438

35-
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.
39+
If no Oxlint config file is found and Biome is enabled, CodeRabbit will use Biome instead as Oxlint functionality is included within Biome.
3640

37-
:::
41+
If Biome is not enabled or an Oxlint config file is found, CodeRabbit will use the `.oxlintrc.json` Oxlint config to run.
3842

39-
## Rule Configuration
43+
Oxlint does not require configuration to run if Biome is disabled and Oxlint is enabled.
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+
:::
4246

4347
## Links
4448

45-
- [oxlint GitHub Repository](https://github.com/oxc-project/oxc)
46-
- [oxlint Website](https://oxc.rust-server.org)
49+
- [Oxlint GitHub Repository](https://github.com/oxc-project/oxc/releases/)
50+
- [Oxlint Website](https://oxc.rs/docs/guide/usage/linter)

0 commit comments

Comments
 (0)