@voxjar/eslint-config v0.1.0

@voxjar/eslint-config

ESLint shareable config for the voxjar style.

Installation

npm install --save-dev eslint @voxjar/eslint-config

Usage

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

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

Using the @voxjar config with eslint:recommended

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

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

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

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

License

Apache-2 © Google