eslint-config-smartprocure

eslint-config-smartprocure

ESLint shareable config for the SmartProcure JavaScript style guide

Installation

$ npm install --save-dev eslint eslint-config-smartprocure

Usage

Once the eslint-config-smartprocure package is installed, you can use it by specifying smartprocure in the extends section of your ESLint configuration.

{
  "extends": "smartprocure",
  "rules": {
    // Additional, per-project rules...
  }
}

Using the smartprocure config with eslint:recommended

There are several rules in the eslint:recommended ruleset that SmartProcure style is not opinionated about that you might want to enforce in your project.

To use SmartProcure style in conjunction with ESLint's recommended rule set, extend them both, making sure to list smartprocure last:

{
  "extends": ["eslint:recommended", "smartprocure"],
  "rules": {
    // Additional, per-project rules...
  }
}

To see how the smartprocure 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 smartprocure config.

License

MIT