# 使用 npm
npm install -D oxlint
 
# 使用 pnpm
pnpm add -D oxlint
 
# 使用 yarn
yarn add -D oxlint

{
  "$schema": "./node_modules/oxlint/configuration_schema.json",
  "rules": {
    "no-debugger": "error",
    "no-console": "warn",
    "eqeqeq": ["error", "always"],
    "no-unused-vars": "warn"
  },
  "env": {
    "browser": true,
    "es2024": true,
    "node": true
  },
  "categories": {
    "correctness": "warn",
    "suspicious": "warn",
    "pedantic": "off",
    "restriction": "off",
    "nursery": "off"
  }
}

# 检查当前项目
npx oxlint
 
# 检查指定目录
npx oxlint src/
 
# 只检查特定文件类型
npx oxlint --ignore-pattern dist/ --ignore-pattern node_modules/ .
 
# 指定规则级别
npx oxlint --deny no-debugger --allow no-console

{
  "scripts": {
    "lint": "oxlint src/ --config oxlintrc.json",
    "lint:fix": "oxlint src/ --fix"
  }
}

{
  "rules": {
    "no-unsafe-assignment": "error",
    "no-unsafe-member-access": "error",
    "no-unsafe-call": "error"
  }
}

npx oxlint --fix src/

# 零配置直接运行
npx oxlint

// package.json scripts
{
  "scripts": {
    "lint": "oxlint src/",
    "format": "oxfmt src/",
    "check": "oxlint src/ && oxfmt --check src/"
  }
}

# Monorepo 根目录检查
npx oxlint packages/*/src/ apps/*/src/

# GitHub Actions 示例
- name: Lint
  run: npx oxlint --deny-warnings src/

// lint-staged 配置
{
  "*.{js,ts,tsx,jsx}": ["oxlint --fix"]
}

{
  "$schema": "./node_modules/oxlint/configuration_schema.json",
  "rules": {
    "no-debugger": "error",
    "no-console": ["warn", { "allow": ["warn", "error"] }],
    "eqeqeq": ["error", "always"],
    "no-unused-vars": ["warn", { "argsIgnorePattern": "^_" }]
  },
  "categories": {
    "correctness": "warn",
    "suspicious": "warn",
    "pedantic": "off",
    "restriction": "off",
    "nursery": "off"
  },
  "env": {
    "browser": true,
    "node": true,
    "es2024": true
  },
  "globals": {
    "MY_GLOBAL": "readonly"
  },
  "ignorePatterns": [
    "dist/",
    "node_modules/",
    "*.min.js"
  ],
  "overrides": [
    {
      "files": ["**/*.test.ts", "**/*.spec.ts"],
      "rules": {
        "no-console": "off"
      }
    }
  ],
  "plugins": ["react", "typescript", "import"]
}

npm install -D vite-plugin-oxlint

// vite.config.ts
import { defineConfig } from 'vite'
import oxlint from 'vite-plugin-oxlint'
 
export default defineConfig({
  plugins: [oxlint()],
})

// turbo.json
{
  "tasks": {
    "lint": {
      "inputs": ["src/**/*.ts", "src/**/*.tsx", "oxlintrc.json"]
    }
  }
}

oxlint [options] [files...]
 
# 常用参数
--config, -c <path>      指定配置文件路径
--fix                    自动修复可修复的问题
--deny <rule>            将规则提升为 error 级别
--warn <rule>            将规则设置为 warn 级别
--allow <rule>           关闭指定规则
--deny-warnings          将 warning 视为错误（CI 场景）
--ignore-pattern <glob>  忽略匹配的文件
--threads <number>       指定并行线程数（默认 CPU 核心数）
--format <format>        输出格式：default, json, github
--type-aware             启用类型感知规则

# 第一阶段：并行运行，对比结果
npx oxlint --format json > oxlint-results.json
npx eslint --format json > eslint-results.json
 
# 第二阶段：逐步关闭已覆盖的 ESLint 规则
# 在 .eslintrc 中关闭 Oxlint 已覆盖的规则
 
# 第三阶段：完全切换

# CI 环境中将 warning 也视为错误，确保代码质量
npx oxlint --deny-warnings src/

// .eslintrc.json - 关闭 Oxlint 已覆盖的规则
{
  "rules": {
    // Oxlint 已覆盖，关闭 ESLint 版本
    "no-debugger": "off",
    "no-console": "off",
 
    // Oxlint 尚未覆盖，保留 ESLint
    "custom-plugin/rule": "error"
  }
}

// .husky/pre-commit
{
  "hooks": {
    "pre-commit": "lint-staged"
  }
}
 
// lint-staged.config.js
module.exports = {
  '*.{js,ts,tsx,jsx}': ['oxlint --fix --no-warn'],
}

{
  "categories": {
    "correctness": "error",
    "suspicious": "warn",
    "pedantic": "off"
  },
  "overrides": [
    {
      "files": ["*.test.ts", "*.spec.ts"],
      "categories": {
        "suspicious": "off"
      }
    }
  ]
}

{
  "scripts": {
    "lint": "oxlint src/",
    "lint:fix": "oxlint src/ --fix",
    "format": "oxfmt src/",
    "format:check": "oxfmt --check src/",
    "quality": "pnpm lint && pnpm format:check"
  }
}