eslint-config-casumo v2.2.0
Installation
npm install --save-dev eslint-config-casumo
Usage
Once the eslint-config-casumo
package is installed, you can use it by specifying casumo
in the extends
section of your ESLint configuration.
{
"extends": "casumo",
"rules": {
// Additional, per-project rules...
}
}
Note: We omitted the eslint-config-
prefix since it is automatically assumed by ESLint.
You can override settings from the shareable config by adding them directly into your .eslintrc
file.
Configuration structure
casumo/rules/...
- grouping for rules by category (f.exeslint
,mocha
, etc.)- Each group ideally would have
on/off.js
configurations files which will be used for composing presets
- Each group ideally would have
causmo/configuration/...
- composition of rules into 'presets'
Why on.js
and off.js
?
The idea is to always ship a complete list of ESLint rules and explicitly turn off rule groups which are not needed. This is mostly useful for when eslint-find-rules
runs. In case any new rule is added the plugin will call out the missing rule.
For example if we want to completely ignore ecma-script-6
rules we just extend the configuration preset with /rules/eslint/ecma-script-6/off.js
.
Full configurations
This package includes the following complete and ready to use configurations:
casumo
- ES5 configcasumo/configurations/es5
- ES5 configcasumo/configurations/es5-browser
- ES5 + browsercasumo/configurations/es5-node
- ES5 + nodecasumo/configurations/es5-test
- ES5 + testcasumo/configurations/es6
- ES6 configcasumo/configurations/es6-browser
- ES6 + browsercasumo/configurations/es6-node
- ES6 + nodecasumo/configurations/es6-test
- ES6 + testcasumo/configurations/off
- All rules disabled
NPM scripts
commit
- use this if you do not havecommitizen
installed globallylint
- lints the current projectfind-new-eslint-rules
- checks for new (missing) rulestest
- runs a couple of tests
Contributing
To contribute to the project, please follow these steps:
- File an issue with the idea you wish to put forward
- Fork the repo
- Make a branch for your change
- Run
npm
oryarn install
- Make your changes
- Run
npm
oryarn test
- Run
git add -A
to add your changes - Run
npm
oryarn run commit
(do not use git commit - unless you havecommitizen
installed globally) - Push your changes
- Create the Pull Request
- Get merged and 🎉!
Thanks to
- eslint-config-walmart - for inspiration