eslint-plugin-actool

eslint-plugin-actool

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

• Control TODOs chaos
• Control comments actuality
• Control rubbish code

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 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

• You want to participate in the development of the project? Have a look at our contributing guide!

  Commit like nobody sees, Push like nobody hears

• Found the bug / potential improvement ? Let us know =)
• Overview
• How it work
• FAQ
• Project plans