Skip to content

fix oxlint #288

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix oxlint #288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 5 additions & 1 deletion docs/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,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:

- **OXC**: 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 @@ -104,6 +104,10 @@ 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
- Replaces ESLint for basic linting while maintaining ESLint for more complex rules
- Up to 50-100x faster than traditional ESLint

## February 25, 2025

Expand Down
46 changes: 0 additions & 46 deletions docs/tools/oxc.md
View file
Open in desktop

This file was deleted.

46 changes: 46 additions & 0 deletions docs/tools/oxlint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: oxlint
sidebar_label: oxlint
description: CodeRabbit's guide to oxlint.
---

```mdx-code-block
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.

## Files

oxlint will run on files with the following extensions:

- `.js`
- `.jsx`
- `.ts`
- `.tsx`

## Configuration

oxlint supports the following config files:

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

:::

## Rule Configuration

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)
10 changes: 5 additions & 5 deletions docs/tools/tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ Remove extraneous f prefix
| GitLab Pipelines | [Pipeline Remediation][Pipeline] | CI/CD Failure Remediation |
| Go | [golangci-lint][golangci-lint] | Code Quality |
| Helm | [Checkov][Checkov] | Code Security |
| Javascript | [Biome][Biome], [OXC][OXC] | Code Quality |
| Javascript | [Biome][Biome], [oxlint][oxlint] | Code Quality |
| JSON, JSONC | [Biome][Biome] | Code Quality |
| JSX | [Biome][Biome], [OXC][OXC] | Code Quality |
| JSX | [Biome][Biome], [oxlint][oxlint] | Code Quality |
| Kotlin | [detekt][detekt] | Code Quality |
| Kubernetes | [Checkov][Checkov] | Code Security |
| Markdown | [markdownlint][markdownlint], [LanguageTool][LanguageTool] | Code Quality, Grammar Checking |
Expand All @@ -76,8 +76,8 @@ Remove extraneous f prefix
| SQL | [SQLFluff][SQLFluff] | Code Quality |
| Swift | [SwiftLint][SwiftLint] | Code Quality |
| Terraform | [Checkov][Checkov] | Code Security |
| TSX | [Biome][Biome], [OXC][OXC] | Code Quality |
| Typescript | [Biome][Biome], [OXC][OXC] | Code Quality |
| TSX | [Biome][Biome], [oxlint][oxlint] | Code Quality |
| Typescript | [Biome][Biome], [oxlint][oxlint] | Code Quality |
| YAML | [YAMLlint][YAMLlint] | Code Quality |
| Prisma | [Prisma Lint][PrismaLint] | Code Quality |

Expand Down Expand Up @@ -105,5 +105,5 @@ Remove extraneous f prefix
[Semgrep]: ./semgrep.md
[Pipeline]: ./pipeline-remediation.md
[PrismaLint]: ./prisma-lint.md
[OXC]: ./oxc.md
[oxlint]: ./oxlint.md
[ShopifyCLI]: ./shopify-cli.md