eslint-plugin-actool

[d:contributing]: https://github.com/actool/eslint-plugin-actool/blob/master/CONTRIBUTING.md
[d:howit]: https://github.com/actool/eslint-plugin-actool/blob/master/docs/how-it-work.md
[d:faq]: https://github.com/actool/eslint-plugin-actool/blob/master/docs/faq.md
[d:plans]: https://github.com/actool/eslint-plugin-actool/blob/master/docs/plans.md
[d:overview]: https://github.com/actool/eslint-plugin-actool/blob/master/docs/overview.md
[d:overview#todos]: https://github.com/actool/eslint-plugin-actool/blob/master/docs/overview.md#todos-chaos
[d:overview#comments]: https://github.com/actool/eslint-plugin-actool/blob/master/docs/overview.md#comments-relevancy
[d:overview#rubbish]: https://github.com/actool/eslint-plugin-actool/blob/master/docs/overview.md#rubbish-code
[rules]: https://github.com/actool/eslint-plugin-actool/tree/master/docs/rules
[r:max-tags]: https://github.com/actool/eslint-plugin-actool/tree/master/docs/rules/max-tags.md
[r:relevant-comments]: https://github.com/actool/eslint-plugin-actool/tree/master/docs/rules/relevant-comments.md
[r:no-commented-code]: https://github.com/actool/eslint-plugin-actool/tree/master/docs/rules/no-commented-code.md
[issues]: https://github.com/actool/eslint-plugin-actool/issues

!Version
!npm
!npm bundle size
!GitHub Workflow Status
!GitHub commit activity










Actool rules for ESLint to validate code / comments actuality and relevance.

- 💥 Control [TODOs chaos][d:overview#todos]
- ⏲️ Control [comments actuality][d:overview#comments]
- ☢️ Control [rubbish code][d:overview#rubbish]



> DISCLAIMER: Work in process, and accordingly:
> - For a while - here is approximate description
> - There are a lot of bugs =)
> - First stable version will be signed as 0.1.0

Usage

> Requirement: Make sure your repository has git history

* 💫 Refer to our [overiew doc][d:overview] for quick explanation of features and conception
* If you don't have ESLint yet configured for your project, follow these instructions.
* Install eslint-plugin-actool using npm (or yarn) for you project or globally:

``sh
$ npm install eslint-plugin-actool -D # install for your project as devDep
$ npm install eslint-plugin-actool -g # or install globally
`

* Add eslint-plugin-actool to the plugins option of your .eslintrc:

`js
{
"plugins": ["actool"]
}
`

* Add plugin:actool/recommended to the extends option to enable all recommended rules:

`js
{
"extends": ["plugin:actool/recommended"]
}
`

* or enable only some rules manually:

`js
{
"rules": {
"actool/max-tags": 2,
"actool/relevant-comments": 2,
// etc.
}
}
`

Rules

- [max-tags][r:max-tags] - limit TODO/FIXME tags
> scope: file, project
- [relevant-comments][r:relevant-comments] - validate relevanting of comment doclet with corresponding code statement
> scope: line, block, module
- (WIP) [no-commented-code`][r:no-commented-code] - limit commented code usage and storing

> [More details][d:howit]

Also

- You want to participate in the development of the project? Have a look at our [contributing][d:contributing] guide!
> Commit like nobody sees, Push like nobody hears
- Found the bug / potential improvement ? [Let us know =)][issues]
- [Overview][d:overview]
- [How it work][d:howit]
- [FAQ][d:faq]
- [Project plans][d:plans]