npm package: @kazupon/eslint-plugin
Description: ESLint plugin for @kazupon
Latest version: 0.7.1

# @kazupon/eslint-plugin

ESLint plugin for @kazupon

## 💿 Installation

```sh
# 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`:

```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](https://oxc.rs/docs/guide/usage/linter/config.html) such as `.oxlintrc.json`:

<!-- eslint-skip -->

```jsonc
{
  // ...

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

  // ...
}
```

## ✅ Rules

The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) automatically fixes problems reported by rules which have a wrench 🔧 below.
The rules with the following star ⭐ are included in the configs.

<!--RULES_TABLE_START-->

### @kazupon/eslint-plugin Rules

| Rule ID                                                                                                                      | Description                                                   | Category | Fixable | RECOMMENDED |
| :--------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------ | :------- | :-----: | :---------: |
| [@kazupon/enforce-header-comment](https://eslint-plugin.kazupon.dev/rules/enforce-header-comment.html)                       | Enforce heading the comment in source code file               | Comment  |         |     ⭐      |
| [@kazupon/no-tag-comments](https://eslint-plugin.kazupon.dev/rules/no-tag-comments.html)                                     | disallow tag comments                                         | Comment  |         |     ⭐      |
| [@kazupon/prefer-inline-code-words-comments](https://eslint-plugin.kazupon.dev/rules/prefer-inline-code-words-comments.html) | enforce the use of inline code for specific words on comments | Comment  |   🔧    |     ⭐      |
| [@kazupon/prefer-scope-on-tag-comment](https://eslint-plugin.kazupon.dev/rules/prefer-scope-on-tag-comment.html)             | enforce adding a scope to tag comments                        | Comment  |         |     ⭐      |

<!--RULES_TABLE_END-->

## 🙌 Contributing guidelines

If you are interested in contributing to `gunshi`, I highly recommend checking out [the contributing guidelines](/CONTRIBUTING.md) here. You'll find all the relevant information such as [how to make a PR](/CONTRIBUTING.md#pull-request-guidelines), [how to setup development](/CONTRIBUTING.md#development-setup)) etc., there.

## 💖 Credits

This project is inspired by:

- `README.md` and `docs/**/*.md`, inspired by [ota-meshi](https://github.com/ota-meshi)

Thank you!

## ©️ License

[MIT](http://opensource.org/licenses/MIT)