$ npm install --save-dev eslint eslint-config-keymetrics
Once the eslint-config-keymetrics
package is installed, you can use it by specifying keymetrics
in the extends
section of your ESLint configuration.
{
"extends": "keymetrics",
"rules": {
// Additional, per-project rules...
}
}
There are several rules in the eslint:recommended
ruleset that Keymetrics style is not opinionated about that you might want to enforce in your project.
To use Keymetrics style in conjunction with ESLint's recommended rule set, extend them both, making sure to list keymetrics
last:
{
"extends": ["eslint:recommended", "keymetrics"],
"rules": {
// Additional, per-project rules...
}
}
To see how the keymetrics
config compares with eslint:recommended
, refer to the source code of index.js
, which lists every ESLint rule along with whether (and how) it is enforced by the keymetrics
config.
Apache-2 © Keymetrics