open-index/open-npm huggingface dataset:
npm package: @kzmat/eslint-plugin-commentout
Description: Eslint plugin, disallow commentout except annotation comment
Author: kzmat
Latest version: 0.1.1

# eslint-plugin-commentout

[![npm version](https://badge.fury.io/js/%40kzmat%2Feslint-plugin-commentout.svg)](https://badge.fury.io/js/%40kzmat%2Feslint-plugin-commentout.svg)
[![test](https://github.com/kzmat/eslint-plugin-commentout/actions/workflows/test.yaml/badge.svg)](https://github.com/kzmat/eslint-plugin-commentout/actions/workflows/test.yaml)
[![codecov](https://codecov.io/gh/kzmat/eslint-plugin-commentout/branch/master/graph/badge.svg?token=FVZHVNM64S)](https://codecov.io/gh/kzmat/eslint-plugin-commentout)

Eslint plugin that check commentout except annotation comment.
This plugin supports following annotation.

- TODO:
- FIXME:
- HACK:
- NOTE:
- XXX:
- WARNING:
- @.\*

## Install

```
yarn add -D @kzmat/eslint-plugin-commentout
```

## Usage

`.eslintrc.js`

```js
module.exports = {
  "plugins": [
    ...,
    "@kzmat/commentout"
  ],
  "rules": [
    ...,
    "@kzmat/commentout/commentout": "error"
  ]
  ...,
}
```

## Example

```ts
🙆‍♂️ Good
const foo = 'bar'
// TODO: todo something
// FIXME: fix something

// @ts-ignore
const foo: any = 'bar'

🙅‍♂️ Bad
// const foo = 'bar'
```

## License

MIT