oxc-nuxt

Oxc Nuxt

Nuxt module to provide oxlint and oxfmt integration for doing amazing things.

• ✨  Release Notes
• 🏀  Online playground

Features

• Integrates Oxc's linting capabilities into your Nuxt app
• Adds nuxt auto-imports as globals

Quick Setup

Install the module to your Nuxt application with one command:

npx nuxt module add oxc-nuxt

Create a oxlint.config.ts file in the root of your project with the following content:

import { withNuxt } from './.nuxt/oxlint.mjs';

export default withNuxt({
  // Your custom Oxc rules and configurations go here. For example:
});

Add the below to lint commands to your package.json script section:

{
  "scripts": {
    ...
    "lint": "oxlint --type-aware --type-check",
    "lint:fix": "oxlint --type-aware --type-check --fix",
    ...
  },
}

That's it! You can now use Oxc Nuxt in your Nuxt app ✨

Contribution

Install dependencies

pnpm install

Generate type stubs

pnpm run dev:prepare

Develop with the playground

pnpm run dev

Build the playground

pnpm run dev:build

Run Oxlint

pnpm run lint

Run Oxfmt

pnpm run format

Run Vitest

pnpm run test

pnpm run test:watch

Release new version

pnpm run release