https://github.com/kazupon/eslint-plugin
ESLint plugin for @kazupon
https://github.com/kazupon/eslint-plugin
eslint plugin
Last synced: 7 months ago
JSON representation
ESLint plugin for @kazupon
- Host: GitHub
- URL: https://github.com/kazupon/eslint-plugin
- Owner: kazupon
- License: mit
- Created: 2025-04-07T15:31:33.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-04-21T14:28:39.000Z (9 months ago)
- Last Synced: 2025-04-21T15:34:49.456Z (9 months ago)
- Topics: eslint, plugin
- Language: TypeScript
- Homepage: https://eslint-plugin.kazupon.dev
- Size: 368 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# @kazupon/eslint-plugin
ESLint plugin for @kazupon
> [!WARNING]
> This eslint-plugin is a rule that I’ve made as I needed it to advance the open-source project.
> Therefore, updates are often made, and sometimes there are also destructive changes.
> This eslint-plugin is open-source, so you can use it for your own projects, but please keep in mind that this plugin is specialized for my own use.
> Of course, since it is open-source, you are free to fork it and use it yourself 😉.
## 💿 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
- **Configuration**: flat config style `eslint.config.[js|ts]`, not support legacy config style `.eslintrc`
- **Node.js**: v20 or later
## 🚀 Usage
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
)
```
## ✅ 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.
### @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-scope-on-tag-comment](https://eslint-plugin.kazupon.dev/rules/prefer-scope-on-tag-comment.html) | 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](/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)