From 4c370192357282684708e04815bb86692b05929a Mon Sep 17 00:00:00 2001 From: alex Date: Fri, 9 May 2025 12:34:36 -0400 Subject: [PATCH 1/4] fix capitalization --- docs/changelog.md | 6 +++--- docs/tools/oxlint.md | 28 ++++++++++++++-------------- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index 656a0b5..24e903f 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -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. @@ -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 diff --git a/docs/tools/oxlint.md b/docs/tools/oxlint.md index 8a93cbd..e5bd9db 100644 --- a/docs/tools/oxlint.md +++ b/docs/tools/oxlint.md @@ -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 @@ -10,11 +10,11 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; ``` -[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://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: +Oxlint will run on files with the following extensions: - `.js` - `.jsx` @@ -23,24 +23,24 @@ oxlint will run on files with the following extensions: ## Configuration -oxlint supports the following config files: +Oxlint supports the following config files: -- `oxlint.json` -- `.oxlintrc` -- `.oxlintrc.json` -- `oxlint.config.json` +- `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. +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. +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) +- [Oxlint Website](https://oxc.rust-server.org) From ca12739de34737832f61b7a20add1ff7ebf9054f Mon Sep 17 00:00:00 2001 From: alex Date: Fri, 9 May 2025 12:50:46 -0400 Subject: [PATCH 2/4] update oxlint docs --- docs/tools/oxlint.md | 31 +++++++++++++++++++++++-------- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/docs/tools/oxlint.md b/docs/tools/oxlint.md index e5bd9db..956172e 100644 --- a/docs/tools/oxlint.md +++ b/docs/tools/oxlint.md @@ -12,23 +12,27 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; [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 +## Supported Files 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` +- `.oxlintrc.json` :::note @@ -36,9 +40,20 @@ Oxlint does not require configuration to run. If no Oxlint config file is found ::: -## Rule Configuration +## Integration Details -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. +When running Oxlint, CodeRabbit: + +1. Checks if Oxlint is enabled in your configuration +2. Verifies if a `.oxlintrc.json` configuration file exists +3. Processes files in parallel with a limit of 5 concurrent tasks +4. Uses the `--format=json` and `--deny-warnings` flags for consistent output +5. Maps the output to standardized findings with: + - Start line number + - End line number + - Error message + - Category (rule code) + - Severity level ## Links From eae7b4cfa45a0c778db481d7cc57c7de5ffe66aa Mon Sep 17 00:00:00 2001 From: alex Date: Fri, 9 May 2025 12:53:16 -0400 Subject: [PATCH 3/4] fix links --- docs/tools/oxlint.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/tools/oxlint.md b/docs/tools/oxlint.md index 956172e..a4d061d 100644 --- a/docs/tools/oxlint.md +++ b/docs/tools/oxlint.md @@ -10,7 +10,7 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; ``` -[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. ## Supported Files @@ -57,5 +57,5 @@ When running Oxlint, CodeRabbit: ## 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/tag/oxlint_v0.16.10) +- [Oxlint Website](https://oxc.rs/docs/guide/usage/linter) From aeb737bbdb2b26403458285e6bfd41fc4e4263b8 Mon Sep 17 00:00:00 2001 From: alex Date: Fri, 9 May 2025 12:57:02 -0400 Subject: [PATCH 4/4] link and note fixes --- docs/tools/oxlint.md | 21 +++++---------------- 1 file changed, 5 insertions(+), 16 deletions(-) diff --git a/docs/tools/oxlint.md b/docs/tools/oxlint.md index a4d061d..fd5e7e2 100644 --- a/docs/tools/oxlint.md +++ b/docs/tools/oxlint.md @@ -36,26 +36,15 @@ Oxlint supports the following configuration file: :::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. -::: - -## Integration Details +If Biome is not enabled or an Oxlint config file is found, CodeRabbit will use the `.oxlintrc.json` Oxlint config to run. -When running Oxlint, CodeRabbit: +Oxlint does not require configuration to run if Biome is disabled and Oxlint is enabled. -1. Checks if Oxlint is enabled in your configuration -2. Verifies if a `.oxlintrc.json` configuration file exists -3. Processes files in parallel with a limit of 5 concurrent tasks -4. Uses the `--format=json` and `--deny-warnings` flags for consistent output -5. Maps the output to standardized findings with: - - Start line number - - End line number - - Error message - - Category (rule code) - - Severity level +::: ## Links -- [Oxlint GitHub Repository](https://github.com/oxc-project/oxc/releases/tag/oxlint_v0.16.10) +- [Oxlint GitHub Repository](https://github.com/oxc-project/oxc/releases/) - [Oxlint Website](https://oxc.rs/docs/guide/usage/linter)