Skip to content

chore: improve oxlint example #83898

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

Merged
merged 5 commits into from
Sep 18, 2025
+7 −4
Merged

chore: improve oxlint example #83898

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
764e236
chore: improve oxlint example
TheAlexLichter Sep 17, 2025
7e59ac0
mention eslint core
TheAlexLichter Sep 17, 2025
280c99d
Merge branch 'canary' into chore/update-oxlint-config
TheAlexLichter Sep 17, 2025
55f3b72
Point to remove $schema
icyJoseph Sep 18, 2025
2d3da59
Merge branch 'canary' into chore/update-oxlint-config
icyJoseph Sep 18, 2025
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
5 changes: 3 additions & 2 deletions examples/with-oxlint/.oxlintrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"$schema": "./node_modules/oxlint/configuration_schema.json",
"plugins": ["react", "unicorn", "oxc", "typescript", "nextjs"]
"$schema": "https://raw.githubusercontent.com/oxc-project/oxc/refs/tags/oxlint_v1.16.0/npm/oxlint/configuration_schema.json",
"plugins": ["eslint", "react", "unicorn", "oxc", "typescript", "nextjs"],
"ignorePatterns": ["node_modules/**", ".next/**", "dist/**", "build/**"]
}
6 changes: 4 additions & 2 deletions examples/with-oxlint/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@ This example shows how to configure [Oxlint](https://oxc.rs/docs/guide/usage/lin

Linting via Oxlint in this example includes type-aware linting through the `oxlint-tsgolint` integration, which is [in technical preview](https://oxc.rs/blog/2025-08-17-oxlint-type-aware.html) at the time of writing.

In [`.oxlintrc.json`](./.oxlintrc.json), the plugins `react`, `unicorn`, `typescript`, `nextjs`, and `oxc` are enabled.
In [`.oxlintrc.json`](./.oxlintrc.json), the plugins `eslint`, `react`, `unicorn`, `typescript`, `nextjs`, and `oxc` are enabled.

The first four are [Rust-based Oxlint plugins](https://oxc.rs/docs/guide/usage/linter/plugins.html#supported-plugins) that port rules from the corresponding ESLint plugins.
The first five are [Rust-based Oxlint plugins](https://oxc.rs/docs/guide/usage/linter/plugins.html#supported-plugins) that port rules from the ESLint core and the corresponding ESLint plugins.

The `oxc` plugin provides Oxc-specific rules along with some rules ported from Deepscan.

Further, Oxlint will not lint your `.next`, `dist`, `build` and `node_modules` directories based on the configured `ignorePatterns`.

## Deploy your own

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/vercel/next.js/tree/canary/examples/with-oxlint&project-name=with-oxlint&repository-name=with-oxlint)
Expand Down
Loading