Skip to content

Getting Started

Installation

sh
npm install --save-dev @kazupon/eslint-plugin
sh
pnpm add -D @kazupon/eslint-plugin
sh
yarn add -D @kazupon/eslint-plugin
sh
bun add -D @kazupon/eslint-plugin

Requirements

  • ESLint: v9 or later
  • oxlint: v1.35 or later
  • Configuration:
    • ESLint: flat config style eslint.config.[js|ts], not support legacy config style .eslintrc
    • oxlint: json or jsonc style like .oxlintrc.json or .oxlintrc.jsonc
  • Node.js: v20 or later

Usage

ESLint

Example eslint.config.js:

js
import { defineConfig } from 'eslint/config'
import kazupon from '@kazupon/eslint-plugin'

export default defineConfig(
  ...kazupon.configs.recommended,
  {
    // ...
  }

  // ... something other configurations
)

oxlint

Example oxlint configuration file such as .oxlintrc.json:

jsonc
{
  // ...

  "extends": ["./node_modules/@kazupon/eslint-plugin/oxlint/recommended.json"]

  // ...
}