Skip to content

Fix/oxlint2 #324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 9, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ We're thrilled to introduce agentic planning on GitHub for CodeRabbit chat as Ge

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

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

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.
Expand Down Expand Up @@ -124,8 +124,8 @@ We're thrilled to introduce agentic planning on GitHub for CodeRabbit chat as an
We are continually expanding our support for static analysis tools. We've recently added support for:

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

Expand Down
36 changes: 20 additions & 16 deletions docs/tools/oxlint.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: oxlint
sidebar_label: oxlint
description: CodeRabbit's guide to oxlint.
title: Oxlint
sidebar_label: Oxlint
description: CodeRabbit's guide to Oxlint.
---

```mdx-code-block
Expand All @@ -10,37 +10,41 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
<ProPlanNotice />
```

[oxlint](https://github.com/oxc-project/oxc) is a blazingly fast JavaScript/TypeScript linter written in Rust that is 50-100x faster than ESLint.
[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.

## Files
## Supported Files

oxlint will run on files with the following extensions:
Oxlint will run on files with the following extensions:

- `.js`
- `.mjs`
- `.cjs`
- `.jsx`
- `.ts`
- `.mts`
- `.cts`
- `.tsx`
- `.vue`
- `.astro`
- `.svelte`

## Configuration

oxlint supports the following config files:
Oxlint supports the following configuration file:

- `oxlint.json`
- `.oxlintrc`
- `.oxlintrc.json`
- `oxlint.config.json`

:::note

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.
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 `.oxlintrc.json` Oxlint config to run.

## Rule Configuration
Oxlint does not require configuration to run if Biome is disabled and Oxlint is enabled.

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.
:::

## Links

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