examples/with-oxlint/README.md
This example shows how to configure Oxlint to work with a Next.js application.
Linting via Oxlint in this example includes type-aware linting through the oxlint-tsgolint integration, which is in technical preview at the time of writing.
In .oxlintrc.json, the plugins eslint, react, unicorn, typescript, nextjs, and oxc are enabled.
The first five are Rust-based Oxlint 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.
Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:
npx create-next-app --example with-oxlint with-oxlint-app
yarn create next-app --example with-oxlint with-oxlint-app
pnpm create next-app --example with-oxlint with-oxlint-app
npm run lint
yarn lint
pnpm lint
Deploy it to the cloud with Vercel (Documentation).