Skip to content

Latest commit

 

History

History
120 lines (95 loc) · 5.08 KB

README.md

File metadata and controls

120 lines (95 loc) · 5.08 KB
Raw

eslint-plugin-actool

WIP: For a while - not production ready

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

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

Usage

Requirement: Make sure your repository has git history

  • 💫 Refer to our overiew doc 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:
$ 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:
{
  "plugins": ["actool"]
}
  • Add plugin:actool/recommended to the extends option to enable all recommended rules:
{
  "extends": ["plugin:actool/recommended"]
}
  • or enable only some rules manually:
{
  "rules": {
    "actool/max-tags": 2,
    "actool/relevant-comments": 2,
    // etc.
  }
}

Rules

  • max-tags - limit TODO/FIXME tags

    scope: file, project

  • relevant-comments - validate relevanting of comment doclet with corresponding code statement

    scope: line, block, module

  • (WIP) no-commented-code - limit commented code usage and storing

More details

Also