@baptistecrouzet/nuxt-oxlint 1.1.4

package/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026-Present - Baptiste Crouzet pro.baptiste.crouzet@gmail.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,279 @@
+# Nuxt Oxlint
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![License][license-src]][license-href]
+[![Nuxt][nuxt-src]][nuxt-href]
+
+> Integrate [Oxlint](https://oxc.rs/docs/guide/usage/linter.html) into your Nuxt project — and see lint output directly in the dev server terminal on every save.
+
+<div align="center">
+
+<img src="./docs/screenshots/MainNuxtOxlint.png" alt="Nuxt Oxlint" width="820"/>
+
+<br/>
+
+</div>
+
+Heavily inspired by [`@nuxt/eslint`](https://eslint.nuxt.com), but built for **Oxlint**: a Rust-powered linter built on the Oxc compiler stack, that is orders of magnitude faster than ESLint.
+
+<!-- - [🏀 Online playground](https://stackblitz.com/github/BaptisteCrouzet/nuxt-oxlint?file=playground%2Fapp.vue) -->
+
+## Features
+
+- ⚡ &nbsp;**Fast** — Oxlint is written in Rust and runs in milliseconds even on large codebases (50 to 100 times faster than ESLint ([`see benchmarks`](https://github.com/oxc-project/bench-linter))
+- 🖥 &nbsp;**Dev server output** — lint results appear directly in the terminal at every file save, without leaving your editor
+- 🔧 &nbsp;**Fully configurable** — exposes all `vite-plugin-oxlint` options (config file, rules, format, auto-fix…)
+- 🚫 &nbsp;**Zero runtime overhead** — dev-only, nothing shipped to the browser
+
+
+## Table of contents
+
+- [How it works](#how-it-works)
+- [Requirements](#requirements)
+- [Quick Setup](#quick-setup)
+- [Configuration](#configuration)
+- [Available options](#available-options)
+- [Migrating from @nuxt/eslint](#migrating-from-nuxeslint)
+- [Roadmap](#roadmap)
+- [Contribution](#contribution)
+
+
+## How it works
+
+`nuxt-oxlint` wraps [`vite-plugin-oxlint`](https://github.com/52-entertainment/vite-plugin-oxlint) and registers it inside Nuxt's Vite pipeline via `addVitePlugin`. On every file change detected by the Vite watcher, Oxlint is spawned on the modified file and its output is printed in the dev server terminal.
+
+## Requirements
+
+- Nuxt ≥ 4 (Nuxt 4 with `compatibilityVersion: 5` not tested but accepted)
+- [`oxlint`](https://npmx.dev/package/oxlint) installed in your project as a dev dependency
+
+## Quick Setup
+
+1. Install the module and the oxlint binary
+```bash
+pnpm add -D @baptistecrouzet/nuxt-oxlint oxlint
+```
+
+2. Add it to your nuxt.config.ts
+```ts
+// nuxt.config.ts
+export default defineNuxtConfig({
+  modules: ['nuxt-oxlint'],
+  oxlint: {
+    checker: true, // enable with defaults
+  },
+})
+```
+
+That's it ! Start your dev server and oxlint will run on every save.
+
+## Configuration
+
+All options live under the `oxlint` key in `nuxt.config.ts`.
+
+```ts
+// nuxt.config.ts
+export default defineNuxtConfig({
+  modules: ['nuxt-oxlint'],
+
+  oxlint: {
+    // Set to `true` to enable with defaults, or pass an options object.
+    checker: {
+      // Path to an oxlint config file (default: oxlintrc.json)
+      // it can also be oxlint.config.ts or vite.config.ts
+      // See : https://oxc.rs/docs/guide/usage/linter/config.html
+      configFile: '.oxlintrc.json',
+
+      // Directory to lint (default: project root as '.')
+      path: 'app',
+
+      // For your glob patterns or files to ignore
+      // ignorePattern: 'path/to/dummy/files/beeing/never/linted.ts'
+
+      // Rules to enable / disable / warn
+      // See : https://oxc.rs/docs/guide/usage/linter/rules.html
+      allow: ['debugger'],
+      deny: ['correctness'],
+      warn: ['suspicious'],
+
+      // Path to the oxlint binary (useful in monorepos)
+      // oxlintPath: '/path/to/node_modules/.bin/oxlint',
+
+      // Output format: default | stylish | github | gitlab | json | unix | ...
+      // See : https://oxc.rs/docs/guide/usage/linter/output-formats.html
+      format: 'default',
+
+      // Suppress warnings, only report errors (default: false)
+      // Same as running : oxlint --quiet
+      quiet: false,
+
+      // Attempt an auto-fix on triggered rules, if an autofix exists
+      fix: false
+
+      // Fail the dev build on lint errors (default: false)
+      failOnError: false,
+
+      // Fail the dev build on lint warnings (default: false)
+      failOnWarning: false,
+
+      // Run oxlint when the dev server starts (default: true)
+      lintOnStart: true,
+
+      // CLI flags additionnaly passed to oxlint
+      // See : https://oxc.rs/docs/guide/usage/linter/cli.html
+      // params: '--report-unused-disable-directives --type-aware'
+    },
+  },
+  // Display the path to the oxlint config file in the terminal when the dev server starts
+  displayConfigfileOnStart: false,
+})
+```
+
+### Available options
+
+All options from [`vite-plugin-oxlint`](https://github.com/52-entertainment/vite-plugin-oxlint#options) are supported:
+
+| Option | Type | Default | Description |
+|---|---|---|---|
+| `configFile` | `string` | `oxlintrc.json` | Path to the oxlint config file |
+| `path` | `string` | `.` | Directory where oxlint runs |
+| `ignorePattern` | `string \| string[]` | — | Glob patterns to ignore |
+| `allow` | `string[]` | — | Rules/categories to turn off |
+| `deny` | `string[]` | — | Rules/categories to turn on |
+| `warn` | `string[]` | — | Rules/categories to warn |
+| `oxlintPath` | `string` | — | Explicit path to the oxlint binary |
+| `format` | `string` | `default` | Output format |
+| `quiet` | `boolean` | `false` | Only report errors |
+| `fix` | `boolean` | `false` | Auto-fix issues |
+| `failOnError` | `boolean` | `false` | Fail build on errors |
+| `failOnWarning` | `boolean` | `false` | Fail build on warnings |
+| `lintOnStart` | `boolean` | `true` | Lint all files on dev server start |
+| `params` | `string` | — | Extra raw CLI flags |
+
+## Migrating from `@nuxt/eslint`
+
+### 1. Swap the packages
+
+```bash
+pnpm remove @nuxt/eslint
+pnpm add -D nuxt-oxlint oxlint
+```
+
+### 2. Update `nuxt.config.ts`
+
+```diff
+  export default defineNuxtConfig({
+    modules: [
+-     '@nuxt/eslint',
++     'nuxt-oxlint',
+    ],
+-   eslint: {
+-     checker: true,
+-   },
++   oxlint: {
++     checker: true,
++   },
+  })
+```
+
+### 3. (Optional) Keep ESLint for rules not yet covered by Oxlint
+
+Oxlint covers [more than 840 rules](https://oxc.rs/docs/guide/usage/linter/rules.html) out of the box, including popular plugins.
+If you still rely on ESLint plugins that Oxlint doesn't support yet, you can run both in parallel:
+
+```bash
+pnpm add -D @nuxt/eslint eslint-plugin-oxlint
+```
+
+```ts
+// nuxt.config.ts
+export default defineNuxtConfig({
+  modules: ['@nuxt/eslint', 'nuxt-oxlint'],
+  eslint: { checker: true },
+  oxlint: { checker: true },
+})
+```
+
+Then add [`eslint-plugin-oxlint`](https://github.com/oxc-project/eslint-plugin-oxlint) to your ESLint config to automatically turn off rules already handled by Oxlint — avoiding double reports:
+
+```js
+// eslint.config.mjs
+import oxlint from 'eslint-plugin-oxlint'
+
+export default [
+  // … your other rules
+  ...oxlint.buildFromOxlintConfigFile('.oxlintrc.json'),
+]
+```
+
+## Roadmap
+
+It could be better to go further :
+
+- Add a nuxt devtool tab in order to edit the config in live
+  - Display some toggles for enabled categories (and the amount of corresponding rules)
+  - Display the configFile used
+  - Add two butons : "Save to config file" / "Save to nuxt.config"
+  - button "reset to defaults"
+  - button "Re-lint now"
+  - button "Try to fix fixable things"
+- Add a tool for migrating from eslint in devtools
+ - Display the number of supported rules
+ - Display the numer of not supported rules
+ - Display the unsupported configuration entries or options
+ - Display the transposed configuration
+ - Add a button or script helping to switch to Oxlint
+- Explore typecheck option of oxlint and add some hints in the readme or warnings if needed
+- Display a summary bar: X errors, Y warnings, Z files
+
+
+## Contribution
+
+<details>
+  <summary>Local development</summary>
+
+  ```bash
+  # Install dependencies
+  pnpm install
+
+  # Generate type stubs
+  pnpm dev:prepare
+
+  # Develop with the playground
+  pnpm dev
+
+  # Build the module
+  pnpm prepack
+
+  # Run ESLint
+  pnpm lint
+
+  # Run Vitest
+  pnpm test
+  pnpm test:watch
+  ```
+
+</details>
+
+<details>
+  <summary>Contributing</summary>
+
+  * Conventional commits are required
+  * This is not an official Nuxt module
+  * Be kind
+
+</details>
+
+<!-- Badges -->
+[npm-version-src]: https://img.shields.io/npm/v/nuxt-oxlint/latest.svg?style=flat&colorA=020420&colorB=00DC82
+[npm-version-href]: https://npmjs.com/package/nuxt-oxlint
+
+[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-oxlint.svg?style=flat&colorA=020420&colorB=00DC82
+[npm-downloads-href]: https://npmjs.com/package/nuxt-oxlint
+
+[license-src]: https://img.shields.io/npm/l/nuxt-oxlint.svg?style=flat&colorA=020420&colorB=00DC82
+[license-href]: https://npmjs.com/package/nuxt-oxlint
+
+[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
+[nuxt-href]: https://nuxt.com

package/dist/module.d.mts

@@ -0,0 +1,28 @@
+import * as _nuxt_schema from '@nuxt/schema';
+import oxlintPlugin from 'vite-plugin-oxlint';
+
+type CheckerOptions = NonNullable<Parameters<typeof oxlintPlugin>[0]>;
+interface ModuleOptions {
+    /**
+     * Enable the oxlint checker in the Vite dev server.
+     * Set to `true` to use defaults, or pass an options object to customize.
+     *
+     * Requires `oxlint` to be installed in the project.
+     * @see https://github.com/52-entertainment/vite-plugin-oxlint for available and default options.
+     * @default false
+     */
+    checker?: boolean | CheckerOptions;
+    /**
+     * Display the path to the oxlint config file in the terminal when the dev server starts.
+     * Attempts to find common config file names in the project root directory.
+     * This can help confirm that the correct config file is being used.
+     * @see findConfigFile function for the list of config file names that are checked.
+     * @default false
+     * @remarks This option only affects the display of the config file path in the terminal. It does not affect whether the checker is enabled or how it functions.
+     */
+    displayConfigfileOnStart?: boolean;
+}
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
+
+export { _default as default };
+export type { CheckerOptions, ModuleOptions };

package/dist/module.json

@@ -0,0 +1,9 @@
+{
+  "name": "nuxt-oxlint",
+  "configKey": "oxlint",
+  "version": "1.1.4",
+  "builder": {
+    "@nuxt/module-builder": "1.0.2",
+    "unbuild": "unknown"
+  }
+}

package/dist/module.mjs

@@ -0,0 +1,60 @@
+import { defineNuxtModule, useLogger, addVitePlugin } from '@nuxt/kit';
+import { promises } from 'node:fs';
+import { join } from 'node:path';
+
+const module$1 = defineNuxtModule({
+  meta: {
+    name: "nuxt-oxlint",
+    configKey: "oxlint"
+  },
+  defaults: {
+    checker: false,
+    displayConfigfileOnStart: false
+  },
+  async setup(options, nuxt) {
+    if (!options.checker || !nuxt.options.dev) {
+      return;
+    }
+    const logger = useLogger("nuxt:oxlint");
+    if (nuxt.options.builder !== "@nuxt/vite-builder") {
+      logger.warn("nuxt-oxlint checker only supports the Vite builder. Checker will not be enabled.");
+      return;
+    }
+    const checkerOptions = typeof options.checker === "object" ? options.checker : {};
+    if (options.displayConfigfileOnStart) {
+      await logConfigFilePath(logger, checkerOptions.configFile || null, nuxt.options.rootDir);
+    }
+    const vitePluginOxlint = await import('vite-plugin-oxlint').then(
+      (m) => "default" in m ? m.default : m
+    );
+    addVitePlugin(() => vitePluginOxlint(checkerOptions), { server: false });
+  }
+});
+async function findConfigFile(rootDir) {
+  const configFiles = [".oxlintrc", ".oxlintrc.json", ".oxlintrc.js", "oxlint.config.js", "config/oxlint.config.js"];
+  return new Promise((resolve) => {
+    for (const fileName of configFiles) {
+      const filePath = join(rootDir, fileName);
+      promises.access(filePath).then(() => {
+        resolve(filePath);
+      }).catch(() => {
+      });
+    }
+    resolve(null);
+  });
+}
+async function logConfigFilePath(logger, filePath, rootDir) {
+  try {
+    const configFilePath = await findConfigFile(rootDir);
+    if (configFilePath) {
+      logger.info(`Using oxlint config file: ${configFilePath}`);
+    } else {
+      logger.info("No oxlint config file found in the project root.");
+      logger.info(`Using oxlint defaults. You can create a config file in the project root to customize the behavior.`);
+    }
+  } catch (error) {
+    logger.error("Error finding oxlint config file:", error);
+  }
+}
+
+export { module$1 as default };

package/dist/runtime/plugin.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/runtime/server/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../../../.nuxt/tsconfig.server.json",
+}

package/dist/types.d.mts

@@ -0,0 +1,3 @@
+export { default } from './module.mjs'
+
+export { type CheckerOptions, type ModuleOptions } from './module.mjs'

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@baptistecrouzet/nuxt-oxlint",
+  "version": "1.1.4",
+  "description": "Nuxt module for OXLint, a linting tool for Nuxt projects. Help developers to switch to Oxlint",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/BaptisteCrouzet/nuxt-oxlint.git"
+  },
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.mts",
+      "import": "./dist/module.mjs"
+    }
+  },
+  "main": "./dist/module.mjs",
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/types.d.mts"
+      ]
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "workspaces": [
+    "playground"
+  ],
+  "scripts": {
+    "prepack": "nuxt-module-build build",
+    "dev": "npm run dev:prepare && nuxt dev playground",
+    "dev:build": "nuxt build playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxt prepare playground",
+    "publish:check-auth": "npm whoami --registry=https://registry.npmjs.org && npm whoami --registry=https://npm.pkg.github.com",
+    "publish:dry-run:npm": "npm publish --dry-run --access public --registry=https://registry.npmjs.org",
+    "publish:dry-run:github": "npm publish --dry-run --registry=https://npm.pkg.github.com --@baptistecrouzet:registry=https://npm.pkg.github.com",
+    "publish:npm": "npm publish --access public --registry=https://registry.npmjs.org",
+    "publish:github": "npm publish --registry=https://npm.pkg.github.com --@baptistecrouzet:registry=https://npm.pkg.github.com",
+    "publish:all": "npm run publish:check-auth && npm run publish:npm && npm run publish:github",
+    "release": "npm run lint && npm run test && npm run prepack && changelogen --release && npm run publish:all && git push --follow-tags",
+    "lint": "eslint .",
+    "test": "vitest run",
+    "test:watch": "vitest watch",
+    "test:types": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit"
+  },
+  "peerDependencies": {
+    "oxlint": ">=0.9.0"
+  },
+  "dependencies": {
+    "@nuxt/kit": "^4.4.8",
+    "vite-plugin-oxlint": "^2.1.2"
+  },
+  "devDependencies": {
+    "@nuxt/devtools": "^3.2.4",
+    "@nuxt/eslint-config": "^1.16.0",
+    "@nuxt/module-builder": "^1.0.2",
+    "@nuxt/schema": "^4.4.8",
+    "@nuxt/test-utils": "^4.0.3",
+    "@types/node": "latest",
+    "changelogen": "^0.6.2",
+    "eslint": "^10.6.0",
+    "nuxt": "^4.4.8",
+    "oxlint": "^1.73.0",
+    "typescript": "~6.0.3",
+    "vitest": "^4.1.10",
+    "vue-tsc": "^3.3.7"
+  }
+}