@kazupon/eslint-plugin

ESLint plugin for @kazupon

💿 Installation

# npm
npm install --save-dev @kazupon/eslint-plugin

## yarn
yarn add -D @kazupon/eslint-plugin

## pnpm
pnpm add -D @kazupon/eslint-plugin

## bum
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:

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:

{
  // ...

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

  // ...
}

✅ Rules

The --fix option on the command line automatically fixes problems reported by rules which have a wrench 🔧 below. The rules with the following star ⭐ are included in the configs.

@kazupon/eslint-plugin Rules

| Rule ID | Description | Category | Fixable | RECOMMENDED | | :--------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------ | :------- | :-----: | :---------: | | @kazupon/enforce-header-comment | Enforce heading the comment in source code file | Comment | | ⭐ | | @kazupon/no-tag-comments | disallow tag comments | Comment | | ⭐ | | @kazupon/prefer-inline-code-words-comments | enforce the use of inline code for specific words on comments | Comment | 🔧 | ⭐ | | @kazupon/prefer-scope-on-tag-comment | enforce adding a scope to tag comments | Comment | | ⭐ |

🙌 Contributing guidelines

If you are interested in contributing to gunshi, I highly recommend checking out the contributing guidelines here. You'll find all the relevant information such as how to make a PR, how to setup development) etc., there.

💖 Credits

This project is inspired by:

• README.md and docs/**/*.md, inspired by ota-meshi

Thank you!

©️ License

MIT