# eslint-plugin-actool > Toolkit for code / comments actuality and relevance checking Latest version **0.1.0** (published 2020-12-08) · ISC license · 0 weekly downloads ## Install ```sh npm install eslint-plugin-actool pnpm add eslint-plugin-actool yarn add eslint-plugin-actool bun add eslint-plugin-actool ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.1.0 | | Published | 2020-12-08 | | First published | 2020-11-17 | | Weekly downloads | 0 | | License | ISC | | TypeScript types | none | | Module format | CommonJS | | Node | >=0.10.0 | | Dependencies | 2 | | Unpacked size | 33.3 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 2 | | Author | Ilya Azin | | Maintainers | martis | | Keywords | eslint, eslintplugin, eslint-plugin, actual-code, actuality, relevance, comments | ## Links - npm: https://www.npmjs.com/package/eslint-plugin-actool - Repository: https://github.com/actool/eslint-plugin-actool - Homepage: https://github.com/actool/eslint-plugin-actool#readme - Issues: https://github.com/actool/eslint-plugin-actool/issues - npm.io page: https://npm.io/package/eslint-plugin-actool ## Dependencies (2) - [requireindex](https://npm.io/package/requireindex.md) ~1.1.0 - [json-schema-defaults](https://npm.io/package/json-schema-defaults.md) ^0.4.0 ## Alternatives - [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads - [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads - [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads - [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads - [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads ## Recent versions - 0.1.0 (latest) — 2020-12-08 - 0.1.0-0 — 2020-12-08 - 0.0.14 — 2020-12-08 - 0.0.14-0 — 2020-12-07 - 0.0.13 — 2020-12-06 - 0.0.13-0 — 2020-12-06 - 0.0.12 — 2020-12-05 - 0.0.12-0 — 2020-12-05 - 0.0.11 — 2020-12-05 - 0.0.10 — 2020-12-05 - 0.0.10-0 — 2020-12-05 - 0.0.9 — 2020-12-01 - 0.0.9-0 — 2020-12-01 - 0.0.8-0 — 2020-12-01 - 0.0.7 — 2020-12-01 - … 8 more at https://npm.io/package/eslint-plugin-actool/versions ## README # [eslint-plugin-actool](https://www.npmjs.com/package/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](https://img.shields.io/github/package-json/v/actool/eslint-plugin-actool) ![npm](https://img.shields.io/npm/dw/eslint-plugin-actool) ![npm bundle size](https://img.shields.io/bundlephobia/min/eslint-plugin-actool) [![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Factool%2Feslint-plugin-actool&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)](https://hits.seeyoufarm.com) ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/actool/eslint-plugin-actool/Test%20current%20bulid?label=tests) ![GitHub commit activity](https://img.shields.io/github/commit-activity/w/actool/eslint-plugin-actool) 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](https://github.com/eslint/eslint#installation-and-usage). * 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] --- _Source: https://npm.io/package/eslint-plugin-actool · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._