### Minimal Setup

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/package-overview.md

A minimal setup example using the 'flat/recommended' configuration.

```javascript
import oxlint from 'eslint-plugin-oxlint';
export default [...oxlint.configs['flat/recommended']];
```

--------------------------------

### Plugins Configuration Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/oxlint-config-schema.md

Example showing how to specify custom plugins.

```json
{
  "plugins": ["typescript", "react", "nextjs"]
}
```

--------------------------------

### Usage Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/api-reference.md

Example of how to build configurations using oxlint.buildFromOxlintConfig.

```typescript
const configs = oxlint.buildFromOxlintConfig(
  {
    categories: { correctness: 'warn' },
    rules: { eqeqeq: 'error' }
  },
  {
    typeAware: true,
    withNursery: false
  }
);
```

--------------------------------

### Extends Configuration Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/oxlint-config-schema.md

Example demonstrating the use of the 'extends' property to include multiple configurations.

```json
{
  "extends": [
    "./.oxlintrc.base.json",
    "./.oxlintrc.team-standards.json",
    {
      "plugins": ["react"],
      "rules": { "react/no-unused-state": "off" }
    }
  ]
}
```

--------------------------------

### Full Example Oxlint Configuration

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/oxlint-config-schema.md

A comprehensive example of an Oxlint configuration file, including extends, plugins, categories, rules, overrides, ignorePatterns, and options.

```json
{
  "extends": [
    "./.oxlintrc.base.json",
    "./.oxlintrc.framework.json"
  ],
  "plugins": ["typescript", "react", "nextjs"],
  "categories": {
    "correctness": "error",
    "suspicious": "warn",
    "pedantic": "warn",
    "style": "off",
    "restriction": "warn",
    "perf": "warn"
  },
  "rules": {
    "eqeqeq": "error",
    "no-console": "warn",
    "no-alert": "error",
    "no-unused-vars": "warn",
    "@typescript-eslint/no-unused-vars": [
      "warn",
      {
        "argsIgnorePattern": "^_",
        "varsIgnorePattern": "^ _"
      }
    ],
    "react/display-name": "off",
    "react/jsx-no-target-blank": "error"
  },
  "overrides": [
    {
      "files": ["**/__tests__/**/*.ts", "**/*.test.ts"],
      "plugins": ["jest"],
      "rules": {
        "no-console": "off",
        "jest/no-disabled-tests": "error"
      }
    },
    {
      "files": ["scripts/**/*.ts"],
      "rules": {
        "no-console": "off"
      }
    }
  ],
  "ignorePatterns": [
    "node_modules",
    "dist",
    "build",
    ".next",
    "out",
    "coverage"
  ],
  "options": {
    "typeAware": true
  }
}
```

--------------------------------

### Installation

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/README.md

Install the eslint-plugin-oxlint package as a development dependency.

```shell
pnpm add -D eslint-plugin-oxlint
```

--------------------------------

### Installation

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/package-overview.md

Install the eslint-plugin-oxlint and oxlint packages as development dependencies.

```bash
npm install --save-dev eslint-plugin-oxlint oxlint
```

--------------------------------

### From File

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/package-overview.md

An example showing how to build configuration directly from an '.oxlintrc.json' file.

```javascript
import oxlint from 'eslint-plugin-oxlint';
export default [
  ...oxlint.buildFromOxlintConfigFile('./.oxlintrc.json')
];
```

--------------------------------

### Integration with buildFromOxlintConfigFile

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/oxlint-config-schema.md

Example of loading configuration from a file using buildFromOxlintConfigFile.

```typescript
const configs = oxlint.buildFromOxlintConfigFile('./.oxlintrc.json', {
  typeAware: true
});
```

--------------------------------

### buildFromOxlintConfigFile() Usage Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/api-reference.md

Example demonstrating how to use buildFromOxlintConfigFile to generate ESLint configurations by reading from an oxlint configuration file.

```typescript
import oxlint from 'eslint-plugin-oxlint';

// Read from .oxlintrc.json
const configs = oxlint.buildFromOxlintConfigFile('./.oxlintrc.json', {
  typeAware: true,
  withNursery: false
});

export default [
  ...oxlint.configs['flat/recommended'],
  ...configs
];
```

--------------------------------

### .oxlintrc.json Configuration Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/REFERENCE.md

An example of a .oxlintrc.json file showing various configuration options.

```json
{
  "extends": ["./.oxlintrc.base.json"],
  "plugins": ["typescript", "react"],
  "categories": {
    "correctness": "error",
    "suspicious": "warn"
  },
  "rules": {
    "eqeqeq": "error",
    "no-console": "warn"
  },
  "overrides": [
    {
      "files": ["**/*.test.ts"],
      "rules": { "no-console": "off" }
    }
  ],
  "ignorePatterns": ["node_modules", "dist"],
  "options": { "typeAware": true }
}
```

--------------------------------

### Example JSON configuration with overrides

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/oxlint-config-schema.md

Demonstrates how to configure rules and apply file-specific overrides.

```json
{
  "rules": { "no-console": "off" },
  "overrides": [
    {
      "files": ["src/**/*.test.ts"],
      "rules": { "no-console": "off" },
      "plugins": ["jest"]
    },
    {
      "files": ["scripts/**/*.ts"],
      "plugins": ["node"]
    }
  ]
}
```

--------------------------------

### OxlintOptions Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/types.md

Example of an OxlintConfig object with options.

```typescript
const config: OxlintConfig = {
  plugins: ['typescript'],
  options: {
    typeAware: true,
    typeCheck: true
  }
};
```

--------------------------------

### Example JSON configuration with options

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/oxlint-config-schema.md

Illustrates Oxlint-specific options that affect rule processing.

```json
{
  "options": {
    "typeAware": true,
    "typeCheck": true
  }
}
```

--------------------------------

### Rules Configuration Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/oxlint-config-schema.md

Example of explicitly configuring individual rules, overriding category settings.

```json
{
  "rules": {
    "eqeqeq": "error",
    "no-console": "warn",
    "no-unused-vars": 0,
    "@typescript-eslint/no-unused-vars": ["error", { "argsIgnorePattern": "^_"}],
    "react/display-name": "off"
  }
}
```

--------------------------------

### Minimal Setup

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/REFERENCE.md

Minimal ESLint configuration using eslint-plugin-oxlint.

```javascript
// eslint.config.js
import oxlint from 'eslint-plugin-oxlint';
export default [...oxlint.configs['flat/recommended']];
```

--------------------------------

### Categories Configuration Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/oxlint-config-schema.md

Example of configuring rule categories and their severity levels.

```json
{
  "categories": {
    "correctness": "error",
    "suspicious": "warn",
    "pedantic": "warn",
    "style": "off",
    "restriction": "warn",
    "perf": "warn",
    "nursery": "off"
  }
}
```

--------------------------------

### Usage: Legacy config example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/README.md

Example of using eslint-plugin-oxlint with legacy configuration (eslint < 9.0).

```javascript
// .eslintrc.js
module.exports = {
  ... // other config
  extends: [
    ... // other presets
    "plugin:oxlint/recommended",
  ],
}
```

--------------------------------

### Enabling Nursery Rules Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/configuration.md

Demonstrates how to enable experimental nursery rules.

```typescript
const configs = oxlint.buildFromOxlintConfig(
  {
    categories: { nursery: 'warn' }
  },
  { withNursery: true }
);
```

--------------------------------

### JSONC Support Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/oxlint-config-schema.md

Example of oxlint configuration using JSONC format, allowing comments.

```jsonc
{
  // Enable correctness and suspicious rules
  "categories": {
    "correctness": "warn",
    "suspicious": "warn",
    /* Style rules are disabled by default */
    "style": "off"
  }
}
```

--------------------------------

### Pre-built Configurations

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/REFERENCE.md

Examples of using pre-built configurations for ESLint.

```javascript
import oxlint from 'eslint-plugin-oxlint';

// Recommended (correctness rules only)
oxlint.configs['flat/recommended']
oxlint.configs.recommended  // Legacy format

// All rules (all categories)
oxlint.configs['flat/all']
oxlint.configs.all  // Legacy format

// Plugin-specific
oxlint.configs['flat/typescript']
oxlint.configs['flat/react']
oxlint.configs['flat/nextjs']
// ... see configuration.md for full list

// Category-specific
oxlint.configs['flat/correctness']
oxlint.configs['flat/suspicious']
```

--------------------------------

### Usage: Flat config example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/README.md

Example of using eslint-plugin-oxlint with flat config (eslint >= 9.0).

```javascript
// eslint.config.js
import oxlint from 'eslint-plugin-oxlint';
export default [
  ...// other plugins
  ...oxlint.configs['flat/recommended'], // oxlint should be the last one
];
```

--------------------------------

### buildFromOxlintConfig() Usage Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/api-reference.md

Example demonstrating how to use buildFromOxlintConfig to generate ESLint configurations from an oxlint configuration object.

```typescript
import oxlint from 'eslint-plugin-oxlint';

const configs = oxlint.buildFromOxlintConfig({
  plugins: ['typescript', 'react'],
  categories: {
    correctness: 'warn',
    suspicious: 'warn'
  },
  rules: {
    'eqeqeq': 'error'
  }
});

export default [
  ...oxlint.configs['flat/recommended'],
  ...configs
];
```

--------------------------------

### EslintPluginOxlintConfig Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/types.md

Example of an EslintPluginOxlintConfig object.

```typescript
const config: EslintPluginOxlintConfig = {
  name: 'oxlint/recommended',
  rules: {
    'eqeqeq': 'off',
    '@typescript-eslint/no-unused-vars': 'off'
  }
};
```

--------------------------------

### Integration with buildFromOxlintConfig

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/oxlint-config-schema.md

Example of using the buildFromOxlintConfig function with configuration options.

```typescript
const configs = oxlint.buildFromOxlintConfig({
  plugins: ["typescript"],
  categories: { correctness: "error" },
  rules: { eqeqeq: "error" },
  overrides: [
    {
      files: ["**/*.test.ts"],
      rules: { "no-console": "off" }
    }
  ],
  ignorePatterns: ["node_modules", "dist"]
}, {
  typeAware: true,
  withNursery: false
});
```

--------------------------------

### OxlintConfig Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/types.md

Example of an OxlintConfig object.

```typescript
const config: OxlintConfig = {
  rules: {
    'eqeqeq': 'error',
    'no-unused-vars': 'warn',
    '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
    'react/no-unused-state': 'off'
  }
};
```

--------------------------------

### Invalid Extended Config Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/oxlint-config-schema.md

Example of an invalid extended configuration structure.

```json
{
  "extends": ["./missing-base.json"]
}
```

--------------------------------

### JSONC Support Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/function-reference.md

An example demonstrating the support for JSONC format, including single-line and multi-line comments, and trailing commas in configuration files.

```jsonc
{
  // Enable correctness rules
  "categories": {
    "correctness": "error",
    "suspicious": "warn",
  },
  /* Disable style rules */
  "rules": {
    "eqeqeq": "error"
  }
}
```

--------------------------------

### OxlintConfigCategories Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/types.md

Example of configuring categories in OxlintConfig.

```typescript
const config: OxlintConfig = {
  categories: {
    correctness: 'error',
    suspicious: 'warn',
    style: 'off'
  }
};
```

--------------------------------

### Combining Multiple Configurations

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/configuration.md

Example demonstrating how to combine multiple flat configurations and custom ESLint rules.

```javascript
import oxlint from 'eslint-plugin-oxlint';

export default [
  // Core rules
  ...oxlint.configs['flat/recommended'],
  
  // Framework-specific
  ...oxlint.configs['flat/react'],
  ...oxlint.configs['flat/nextjs'],
  
  // Additional categories
  ...oxlint.configs['flat/suspicious'],
  
  // Custom ESLint config
  {
    files: ['src/**/*.ts'],
    rules: {
      'some-rule': 'warn'
    }
  }
];
```

--------------------------------

### Vite+ CLI Commands

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/AGENTS.md

Commands to interact with the Vite+ toolchain, including installation, checking, and running tasks.

```bash
vp help
vp <command> --help
```

```bash
vp install
```

```bash
vp check
```

```bash
vp test
```

```bash
vp run <script>
```

--------------------------------

### eslint.config.js Configuration Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/REFERENCE.md

An example of an ESLint flat config file using eslint-plugin-oxlint.

```javascript
import oxlint from 'eslint-plugin-oxlint';

export default [
  ...oxlint.configs['flat/recommended'],
  ...oxlint.configs['flat/react'],
  {
    files: ['src/**/*.test.ts'],
    rules: { 'no-console': 'off' }
  }
];
```

--------------------------------

### Configuration from .oxlintrc.json File Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/configuration.md

An ESLint configuration that loads settings from an .oxlintrc.json file.

```javascript
import oxlint from 'eslint-plugin-oxlint';

export default [
  ...oxlint.configs['flat/recommended'],
  ...oxlint.buildFromOxlintConfigFile('./.oxlintrc.json')
];
```

--------------------------------

### Example of Default Plugins

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/constants-and-mappings.md

When no plugins are specified, the effective plugins include the defaults ('unicorn', 'typescript') plus the automatically added 'eslint'.

```json
{
  // No plugins specified
  "categories": { "correctness": "error" }
}
```

```text
Effective plugins: ['unicorn', 'typescript', 'eslint']
```

--------------------------------

### OxlintConfigExtends Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/types.md

Example of using the extends field in OxlintConfig.

```typescript
const config: OxlintConfig = {
  extends: [
    './.oxlintrc.base.json',
    {
      plugins: ['react'],
      rules: { 'eqeqeq': 'error' }
    }
  ]
};
```

--------------------------------

### Example JSON configuration with ignorePatterns

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/oxlint-config-schema.md

Shows how to specify glob patterns for files to be ignored during linting.

```json
{
  "ignorePatterns": [
    "node_modules",
    "dist",
    "build",
    "*.d.ts",
    "**/*.config.js",
    ".next"
  ]
}
```

--------------------------------

### Example Configuration

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/types.md

Demonstrates how to build Oxlint configurations with specific options like type awareness and nursery rules.

```typescript
const configs = buildFromOxlintConfig(
  { categories: { correctness: 'warn' } },
  {
    typeAware: true,
    withNursery: false
  }
);
```

--------------------------------

### Building Custom Configurations

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/configuration.md

Example of using `buildFromOxlintConfig` to create a custom ESLint configuration.

```javascript
import oxlint from 'eslint-plugin-oxlint';

const customConfigs = oxlint.buildFromOxlintConfig({
  plugins: ['typescript', 'react'],
  categories: {
    correctness: 'error',
    suspicious: 'warn',
    style: 'off'
  },
  rules: {
    'eqeqeq': 'error',
    '@typescript-eslint/no-unused-vars': 'warn'
  }
});

export default [
  ...customConfigs
];
```

--------------------------------

### Example Return Value

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/function-reference.md

An example of the array of EslintPluginOxlintConfig objects returned by buildFromOxlintConfig for a config with one override and ignorePatterns.

```typescript
[
  { name: 'oxlint/oxlint-config-ignore-patterns', ignores: [...] },
  { name: 'oxlint/from-oxlint-config', rules: { ... } },
  { name: 'oxlint/vue-svelte-astro-exceptions', ignores: [...], rules: { ... } },
  { name: 'oxlint/from-oxlint-config-override-0', files: [...], rules: { ... } }
]
```

--------------------------------

### Migrating from ESLint-Only Config - Before

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/usage-patterns.md

Example of an ESLint-only configuration before migration.

```javascript
import react from 'eslint-plugin-react';
import prettier from 'eslint-config-prettier';

export default [
  react.configs.recommended,
  prettier
];
```

--------------------------------

### Configuration Merging Behavior: Extends Merging Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/oxlint-config-schema.md

Demonstrates how configurations specified in 'extends' are merged, including plugins and rules.

```json
{
  "extends": [
    {"plugins": ["react"], "rules": {"react/display-name": "warn"}},
    {"rules": {"react/display-name": "error"}}
  ],
  "plugins": ["typescript"]
}

Results in:
{
  "plugins": ["react", "typescript"],
  "rules": {"react/display-name": "error"}
}
```

--------------------------------

### Migrating from ESLint-Only Config - After

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/usage-patterns.md

Example of an ESLint + oxlint configuration after migration.

```javascript
import oxlint from 'eslint-plugin-oxlint';
import react from 'eslint-plugin-react';
import prettier from 'eslint-config-prettier';

export default [
  // Disable rules oxlint handles
  ...oxlint.configs['flat/recommended'],
  ...oxlint.configs['flat/react'],
  
  // Keep other configs
  react.configs.recommended,
  prettier
];
```

--------------------------------

### Strict Setup

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/REFERENCE.md

ESLint configuration for enabling all rules.

```javascript
export default [...oxlint.configs['flat/all']];
```

--------------------------------

### Example Usage of buildFromOxlintConfigFile

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/function-reference.md

Shows different ways to use buildFromOxlintConfigFile to load Oxlint configurations from JSON/JSONC files, including with options and custom paths.

```typescript
import oxlint from 'eslint-plugin-oxlint';

// Load from .oxlintrc.json
const configs = oxlint.buildFromOxlintConfigFile('./.oxlintrc.json');

// Load with options
const strictConfigs = oxlint.buildFromOxlintConfigFile(
  './.oxlintrc.json',
  {
    typeAware: true,
    withNursery: false
  }
);

// Load from custom path
const ciConfigs = oxlint.buildFromOxlintConfigFile(
  process.env.OXLINT_CONFIG || './.oxlintrc.json'
);

export default [...configs];
```

--------------------------------

### Full Control

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/package-overview.md

An example demonstrating full control over configuration, including plugins, categories, rules, and overrides.

```javascript
import oxlint from 'eslint-plugin-oxlint';

export default [
  ...oxlint.buildFromOxlintConfig({
    plugins: ['typescript', 'react'],
    categories: {
      correctness: 'error',
      suspicious: 'warn'
    },
    rules: { eqeqeq: 'error' },
    overrides: [{
      files: ['**/*.test.ts'],
      rules: { 'no-console': 'off' }
    }]
  })
];
```

--------------------------------

### Example JSON configuration for override 'files' property

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/oxlint-config-schema.md

Demonstrates the 'files' property within an override, specifying glob patterns.

```json
{
  "files": [
    "src/**/*.test.ts",
    "tests/**/*.ts",
    "**/__tests__/**/*.ts"
  ]
}
```

--------------------------------

### Basic Integration: Recommended Rules

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/usage-patterns.md

The simplest setup, recommended for most projects. Disables ESLint correctness rules that oxlint already checks.

```javascript
// eslint.config.js
import oxlint from 'eslint-plugin-oxlint';

export default [
  ...oxlint.configs['flat/recommended']
];
```

--------------------------------

### Valid JSON

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/function-reference.md

Example of a valid JSON configuration.

```json
{"rules": {"eqeqeq": "error"}}
```

--------------------------------

### Error Handling: File Not Found

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/oxlint-config-schema.md

Example of handling a file not found error when loading configuration.

```typescript
buildFromOxlintConfigFile('missing.json')
// Returns: []
// Logs: "eslint-plugin-oxlint: could not find oxlint config file: missing.json"
```

--------------------------------

### Main Export

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/package-overview.md

Example of importing the main export of the eslint-plugin-oxlint package.

```typescript
import oxlint from 'eslint-plugin-oxlint';
// Access: oxlint.configs, oxlint.buildFromOxlintConfig, oxlint.buildFromOxlintConfigFile
```

--------------------------------

### React/Next.js Project Configuration Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/configuration.md

An ESLint configuration tailored for React and Next.js projects.

```javascript
import oxlint from 'eslint-plugin-oxlint';

export default [
  ...oxlint.configs['flat/recommended'],
  ...oxlint.configs['flat/react'],
  ...oxlint.configs['flat/nextjs']
];
```

--------------------------------

### Use Recommended as Base

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/usage-patterns.md

Best practice: Start your ESLint configuration with `oxlint.configs['flat/recommended']` to include essential correctness rules.

```javascript
export default [
  ...oxlint.configs['flat/recommended'],
  // ... additional configs
];
```

--------------------------------

### Subpath Exports

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/package-overview.md

Examples of importing specific modules from eslint-plugin-oxlint.

```typescript
import rulesByScope from 'eslint-plugin-oxlint/rules-by-scope';
import rulesByCategory from 'eslint-plugin-oxlint/rules-by-category';
```

--------------------------------

### JSON Configuration (.oxlintrc.json)

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/oxlint-config-schema.md

Example of a typical oxlint configuration file in JSON format.

```json
{
  "extends": ["./path/to/config.json"],
  "plugins": ["typescript", "react"],
  "categories": {
    "correctness": "warn",
    "suspicious": "warn",
    "style": "off"
  },
  "rules": {
    "eqeqeq": "error",
    "no-console": "warn",
    "typescript/no-unused-vars": "off"
  },
  "overrides": [
    {
      "files": ["src/**/*.test.ts"],
      "rules": {
        "no-console": "off"
      }
    }
  ],
  "ignorePatterns": [
    "node_modules",
    "dist",
    "*.d.ts"
  ],
  "options": {
    "typeAware": true,
    "typeCheck": true
  }
}
```

--------------------------------

### Type-Aware TypeScript Project Configuration Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/configuration.md

An ESLint configuration for a type-aware TypeScript project.

```javascript
const customConfigs = oxlint.buildFromOxlintConfig(
  {
    plugins: ['typescript'],
    categories: { correctness: 'error' },
    options: { typeAware: true }
  },
  { typeAware: true }
);

export default [...customConfigs];
```

--------------------------------

### Example Usage of buildFromOxlintConfig

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/function-reference.md

Demonstrates simple and complex usage of the buildFromOxlintConfig function to generate ESLint configurations from Oxlint settings.

```typescript
import oxlint from 'eslint-plugin-oxlint';

// Simple usage
const configs = oxlint.buildFromOxlintConfig({
  plugins: ['typescript'],
  categories: { correctness: 'error' }
});

// Complex usage
const advancedConfigs = oxlint.buildFromOxlintConfig({
  plugins: ['typescript', 'react'],
  categories: {
    correctness: 'error',
    suspicious: 'warn'
  },
  rules: {
    'eqeqeq': 'error',
    'no-console': ['warn', { allow: ['warn', 'error'] }]
  },
  overrides: [
    {
      files: ['**/*.test.ts'],
      rules: { 'no-console': 'off' }
    }
  ],
  ignorePatterns: ['dist', 'node_modules']
}, {
  typeAware: true,
  withNursery: false
});

export default advancedConfigs;
```

--------------------------------

### Rule Scope Matching Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/configuration.md

Demonstrates how to specify rules with or without scope prefixes, including Oxlint's auto-mapping.

```typescript
const config = {
  rules: {
    // Plain name — matches this rule in any plugin
    'eqeqeq': 'error',
    
    // Scoped — matches only this plugin's version
    '@typescript-eslint/no-unused-vars': 'off',
    'react/no-unused-state': 'warn',
    
    // Oxlint format — auto-mapped
    'typescript/no-unused-vars': 'off'
  }
};
```

--------------------------------

### Configuration Merging Behavior: Override Rules Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/oxlint-config-schema.md

Shows how rules can be disabled at the base level and re-enabled in overrides.

```json
{
  "rules": {"no-console": "off"},
  "overrides": [
    {
      "files": ["src/**"],
      "rules": {"no-console": "warn"}
    }
  ]
}
```

--------------------------------

### Usage - Flat Config

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/api-reference.md

Example of using flat configurations with ESLint 9+.

```typescript
// ESLint 9+ flat config
import oxlint from 'eslint-plugin-oxlint';

export default [
  ...oxlint.configs['flat/recommended']
];
```

--------------------------------

### Usage: Detect rules from .oxlintrc.json (Flat config)

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/README.md

Example of using eslint-plugin-oxlint to build configs from an .oxlintrc.json file with flat configuration.

```javascript
// eslint.config.js
import oxlint from 'eslint-plugin-oxlint';
export default [
  ..., // other plugins
  ...oxlint.buildFromOxlintConfigFile('./.oxlintrc.json'),
];
```

--------------------------------

### Usage: Build from oxlint config object (Flat config)

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/README.md

Example of using eslint-plugin-oxlint to build configs from an oxlint configuration object.

```javascript
// eslint.config.js
import oxlint from 'eslint-plugin-oxlint';
export default [
  ..., // other plugins
  ...oxlint.buildFromOxlintConfig({
    categories: {
      correctness: 'warn'
    },
    rules: {
      eqeqeq: 'warn'
    }
  }),
];
```

--------------------------------

### Category-Based Flat Config Usage

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/configuration.md

Example of combining category-based flat configurations for correctness and style.

```javascript
export default [
  ...oxlint.configs['flat/correctness'],
  ...oxlint.configs['flat/style']
];
```

--------------------------------

### Flat Config (ESLint 9+)

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/package-overview.md

Example of how to configure eslint-plugin-oxlint using ESLint's flat config system.

```javascript
import oxlint from 'eslint-plugin-oxlint';

export default [
  ...oxlint.configs['flat/recommended']
];
```

--------------------------------

### Strict Configuration Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/configuration.md

An ESLint configuration that enables all available rules using the flat config.

```javascript
export default [
  ...oxlint.configs['flat/all']
];
```

--------------------------------

### Legacy Config Format

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/configuration.md

Example of using legacy configuration format for ESLint versions before 9.0.

```typescript
configs.recommended  // Contains correctness rules
configs.all         // Contains all stable rules
```

```javascript
module.exports = {
  extends: ['plugin:oxlint/recommended'],
  // ... other config
};
```

--------------------------------

### Rule Processing Order Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/configuration.md

Illustrates how later rule settings can override earlier ones, using categories and explicit rules.

```javascript
{
  categories: { correctness: 'error' },  // All correctness rules off
  rules: {
    'eqeqeq': 'error'  // Except this one stays enabled
  }
}
```

--------------------------------

### getEsLintRuleName Examples

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/function-reference.md

Examples of using the getEsLintRuleName function.

```typescript
getEsLintRuleName('eqeqeq')                      // → 'eqeqeq'
getEsLintRuleName('typescript/no-unused-vars')   // → '@typescript-eslint/no-unused-vars'
getEsLintRuleName('unknown-rule')                // → undefined
```

--------------------------------

### Flat Config All Rules

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/configuration.md

Example of using the flat configuration for all stable rules (excluding nursery) for ESLint 9+.

```typescript
oxlint.configs['flat/all']  // Type: FlatConfig
```

```javascript
export default [
  ...oxlint.configs['flat/all']
];
```

--------------------------------

### Flat Config Recommended

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/configuration.md

Example of using the recommended flat configuration for ESLint 9+ which includes only correctness rules.

```typescript
oxlint.configs['flat/recommended']  // Type: FlatConfig
```

```javascript
import oxlint from 'eslint-plugin-oxlint';

export default [
  ...oxlint.configs['flat/recommended']
];
```

--------------------------------

### Plugin-Specific Flat Config Usage

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/configuration.md

Example of combining plugin-specific flat configurations for React and Next.js.

```javascript
export default [
  ...oxlint.configs['flat/react'],
  ...oxlint.configs['flat/nextjs']
];
```

--------------------------------

### OxlintConfigOverride Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/types.md

Example of an OxlintConfig object with overrides.

```typescript
const config: OxlintConfig = {
  plugins: ['typescript'],
  rules: { 'no-console': 'off' },
  overrides: [
    {
      files: ['src/**/*.test.ts'],
      rules: { 'no-console': 'off' }
    },
    {
      files: ['scripts/**/*.ts'],
      plugins: ['node'],
      rules: { 'node/no-unsupported-features/es-syntax': 'error' }
    }
  ]
};
```

--------------------------------

### OxlintConfigIgnorePatterns Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/types.md

Example of an OxlintConfig object with ignorePatterns.

```typescript
const config: OxlintConfig = {
  ignorePatterns: [
    'node_modules/**',
    'dist/**',
    'coverage/**'
  ]
};
```

--------------------------------

### Extends Path Resolution Example

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/function-reference.md

Illustrates how relative paths in the 'extends' array are resolved relative to the directory of the main configuration file.

```json
{
  "extends": [
    "./base.json",
    "./team/standards.json"
  ]
}
```

--------------------------------

### All Configs

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/README.md

List of all available configurations provided by eslint-plugin-oxlint.

```javascript
configs: {
    // recommended only contains the `correctness` category
    recommended: { plugins: [Array], rules: [Object] },
    'flat/recommended': { rules: [Object] },

    // all rules available
    all: { plugins: [Array], rules: [Object] },
    'flat/all': { rules: [Object] },

    // turn eslint rules off by plugin
    'flat/eslint': { rules: [Object] },
    'flat/import': { rules: [Object] },
    'flat/jest': { rules: [Object] },
    'flat/jsdoc': { rules: [Object] },
    'flat/jsx-a11y': { rules: [Object] },
    'flat/nextjs': { rules: [Object] },
    'flat/react': { rules: [Object] },
    'flat/react-perf': { rules: [Object] },
    'flat/tree-shaking': { rules: [Object] },
    'flat/typescript': { rules: [Object] },
    'flat/unicorn': { rules: [Object] },

    // turn eslint rules off by oxlint category
    'flat/pedantic': { rules: [Object] },
    'flat/style': { rules: [Object] },
    'flat/correctness': { rules: [Object] },
    'flat/restriction': { rules: [Object] },
    'flat/suspicious': { rules: [Object] }
  }
```

--------------------------------

### Generate Rules

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/CONTRIBUTING.md

Generates the rules from the installed oxlint version.

```shell
pnpm generate
pnpm format
```

--------------------------------

### Invalid - Not an object

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/function-reference.md

Example of an invalid JSON configuration that is not an object.

```json
["rules"]
```

--------------------------------

### splitDisabledRulesForVueAstroAndSvelteFiles Usage

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/api-reference.md

Example of using the splitDisabledRulesForVueAstroAndSvelteFiles helper function.

```typescript
import { splitDisabledRulesForVueAstroAndSvelteFiles } from 'eslint-plugin-oxlint';

const configs = splitDisabledRulesForVueAstroAndSvelteFiles({
  name: 'my-config',
  rules: { 'no-unused-vars': 'off' }
});

export default [...configs];
```

--------------------------------

### overrideDisabledRulesForVueAndSvelteFiles Usage

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/api-reference.md

Example of using the overrideDisabledRulesForVueAndSvelteFiles helper function.

```typescript
import { overrideDisabledRulesForVueAndSvelteFiles } from 'eslint-plugin-oxlint';

const config = overrideDisabledRulesForVueAndSvelteFiles({
  rules: { 'no-unused-vars': 'off' }
});
```

--------------------------------

### Specify All Plugins Upfront

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/usage-patterns.md

Best practice: Explicitly list all required plugins in custom configurations to ensure clarity and avoid potential dependency issues.

```javascript
oxlint.buildFromOxlintConfig({
  plugins: ['typescript', 'react', 'nextjs'],  // Clear deps
  categories: { correctness: 'error' }
})
```

--------------------------------

### Command Reference: Using with oxlint

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/REFERENCE.md

Command to run oxlint first, then ESLint.

```bash
# Run oxlint first, then ESLint
oxlint && eslint
```

--------------------------------

### Invalid - Incomplete JSON

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/function-reference.md

Example of an invalid JSON configuration that is incomplete.

```json
{"rules": "incomplete"
```

--------------------------------

### Valid JSONC

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/function-reference.md

Example of a valid JSONC (JSON with comments) configuration.

```jsonc
{
  // Configuration
  "rules": {
    "eqeqeq": "error",  // Enforce ===
  }
}
```

--------------------------------

### Nursery Rules Option

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/constants-and-mappings.md

Enabling the `withNursery: true` option includes experimental rules from the 'nursery' category, which are not guaranteed to be stable across versions.

```text
Option: withNursery: true in BuildFromOxlintConfigOptions

Effect: When enabled, includes rules in the nursery category

Stability: Nursery rules are not guaranteed stable across versions
```

--------------------------------

### Example of Default Categories

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/constants-and-mappings.md

When no categories are specified, the effective categories include the default 'correctness' category.

```json
{
  "plugins": ["typescript"]
  // No categories specified
}
```

```text
Effective categories: { correctness: 'warn' }
```

--------------------------------

### Error Handling: Invalid JSON

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/oxlint-config-schema.md

Example of handling an invalid JSON error when loading configuration.

```typescript
buildFromOxlintConfigFile('invalid.json')
// Returns: []
// Logs: "eslint-plugin-oxlint: could not parse oxlint config file: invalid.json"
```

--------------------------------

### Build and Development Scripts

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/package-overview.md

Common npm scripts for building, testing, and developing the ESLint plugin.

```bash
npm run prepare      # Prepare vite-plus config
npm run generate    # Generate rule maps (src/scripts/generate.ts)
npm run build       # Build distribution
npm run lint        # Lint codebase
npm run format      # Format code
npm run test        # Run tests
```

--------------------------------

### Processing Steps for buildFromOxlintConfigFile

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/function-reference.md

Illustrates the internal processing steps involved when buildFromOxlintConfigFile loads and converts an Oxlint configuration file.

```text
1. Read File
   └─ fs.readFileSync(oxlintConfigFile, 'utf8')
      └─ On error: log "could not find..." and return []

2. Parse JSONC
   └─ parseJSONC(content)  // from jsonc-parser
      └─ Supports JSON + comments + trailing commas
      └─ On error: log "could not parse..." and return []

3. Validate Content
   └─ isObject(configContent)
      └─ Must not be null or array
      └─ On error: log "could not parse..." and return []

4. Add Metadata
   └─ config[oxlintConfigMeta] = { filePath: path.resolve(oxlintConfigFile) }
      └─ Resolved to absolute path

5. Delegate to buildFromOxlintConfig()
   └─ Pass config and options
   └─ buildFromOxlintConfig handles extends path resolution
      └─ Uses stored filePath for relative path resolution
```

--------------------------------

### Processing Steps

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/function-reference.md

A detailed breakdown of the processing steps involved in the buildFromOxlintConfig function.

```text
1. Automatic Option Handling
   └─ If config.options.typeAware === true && options.typeAware === undefined
      └─ Set options.typeAware = true

2. Path Resolution
   └─ Call resolveRelativeExtendsPaths(config)
      └─ Makes relative paths in extends absolute

3. Extends Processing
   ├─ Call readExtendsConfigsFromConfig(config)
   │  └─ Recursively loads all extended configs
   └─ Call handleExtendsScope(extendConfigs, config)
      └─ Merges extends into main config

4. Plugin Collection
   ├─ readPluginsFromConfig(config)
   ├─ Defaults to ['unicorn', 'typescript']
   ├─ Always add 'eslint'
   └─ Add 'react-hooks' if 'react' is present

5. Category Processing
   ├─ readCategoriesFromConfig(config)
   ├─ Defaults to { correctness: 'warn' }
   └─ handleCategoriesScope(plugins, categories, rules, options)
      └─ Iterates categories and collects matching rules

6. Rule Processing
   ├─ readRulesFromConfig(config)
   └─ handleRulesScope(configRules, rules, options)
      └─ Applies explicit rule settings
      └─ Handles dual rules (eslint + typescript versions)

7. Base Config Creation
   └─ Create { name: 'oxlint/from-oxlint-config', rules }

8. Vue/Astro/Svelte Handling
   └─ splitDisabledRulesForVueAstroAndSvelteFiles(baseConfig)
      └─ May create second config for file exceptions

9. Overrides Processing
   ├─ readOverridesFromConfig(config)
   └─ handleOverridesScope(overrides, configs, categories, options)
      └─ Create config per override
      └─ Apply rules and categories within override

10. Ignore Patterns Handling
    ├─ readIgnorePatternsFromConfig(config)
    └─ handleIgnorePatternsScope(ignorePatterns, ignoreConfig)
       └─ Create config with ignores field

11. Return Final Array
```

--------------------------------

### Building Configurations with Specific Rules

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/rules-reference.md

Shows how to build ESLint configurations that reference specific rules and categories from the Oxlint plugin.

```typescript
import oxlint from 'eslint-plugin-oxlint';

const configs = oxlint.buildFromOxlintConfig({
  categories: {
    correctness: 'error',
    suspicious: 'warn'
  },
  rules: {
    'eqeqeq': 'error',
    '@typescript-eslint/no-unused-vars': 'warn'
  }
});
```

--------------------------------

### Command Reference: Development

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/REFERENCE.md

Development commands for the project.

```bash
npm run generate   # Generate rule maps from oxlint
npm run build      # Build distribution
npm run lint       # Lint codebase
npm run test       # Run tests
```

--------------------------------

### Error Handling: Invalid Config Structure

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/oxlint-config-schema.md

Example of handling an invalid config structure error when loading configuration.

```typescript
buildFromOxlintConfigFile('config.json')  // File contains: ["array", "not", "object"]
// Returns: []
// Logs: "eslint-plugin-oxlint: could not parse oxlint config file: config.json"
```

--------------------------------

### Default Plugins

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/constants-and-mappings.md

When no plugins are specified in configuration, these defaults are used: 'unicorn' and 'typescript'. 'eslint' is always added automatically. If 'react' is in plugins, 'react-hooks' is also added.

```typescript
export const defaultPlugins: OxlintConfigPlugins = [
  'unicorn',
  'typescript'
];
```

--------------------------------

### Synchronizing oxlintrc.json and ESLint Config

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/usage-patterns.md

Demonstrates the recommended way to reference `.oxlintrc.json` from ESLint configuration to maintain a single source of truth, and an anti-pattern of duplicating configuration.

```javascript
// ✓ Good - single source of truth
export default [
  ...oxlint.buildFromOxlintConfigFile('./.oxlintrc.json')
];

// ✗ Avoid - duplicate maintenance
export default [
  ...oxlint.buildFromOxlintConfig({ /* duplicate config */ })
];
```

--------------------------------

### Main Functions

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/REFERENCE.md

Build from config object and load/build from .oxlintrc.json file.

```typescript
// Build from config object
buildFromOxlintConfig(config, options?)

// Load and build from .oxlintrc.json file
buildFromOxlintConfigFile(filePath, options?)
```

--------------------------------

### Common Tasks: Load from file

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/REFERENCE.md

Loads an ESLint configuration from a specified oxlint config file.

```javascript
const configs = oxlint.buildFromOxlintConfigFile('./.oxlintrc.json');
export default [...configs];
```

--------------------------------

### Extending from Base Configuration

Source: https://github.com/oxc-project/eslint-plugin-oxlint/blob/main/_autodocs/usage-patterns.md

Demonstrates how to extend a base ESLint configuration (e.g., from a shared company config) and augment it with project-specific plugins and rules. This promotes consistency across multiple projects.

```json
{
  "plugins": ["typescript", "react"],
  "categories": {
    "correctness": "error",
    "suspicious": "warn"
  }
}
```

```json
{
  "extends": ["node_modules/@company/eslint-config/.oxlintrc.json"],
  "plugins": ["nextjs"],
  "rules": {
    "no-console": "warn"
  }
}
```

```javascript
import oxlint from 'eslint-plugin-oxlint';

export default [
  ...oxlint.buildFromOxlintConfigFile('./.oxlintrc.json')
];
```