eslint-plugin-clean-code
Clean code ESLint plugin
Installation
You'll first need to install ESLint:
$ npm install --save-dev eslint
Next, install eslint-plugin-clean-code
:
$ npm install --save-dev eslint-plugin-clean-code
Note: If you installed ESLint globally (using the -g
flag) then you must also install eslint-plugin-clean-code
globally.
Usage
Add clean-code
to the plugins section of your .eslintrc
configuration file. You can omit the eslint-plugin-
prefix:
{
"plugins": [
"clean-code"
]
}
Then configure the rules you want to use under the rules section.
{
"rules": {
"clean-code/feature-envy": 2
}
}
Supported Rules
| Rule name | Description |
--------------------------------------------------------------------------------------------------------
| feature-envy | Reports the "Feature Envy" code smell. Feature envy is defined as occurring when |
| | a method calls methods on another class three or more times. Feature envy is |
| | often an indication that functionality is located in the wrong class. |
Todo
Contributing
Feel free to contribute to any of above Todos or supply your own clean code rule not given in Todos.