Install

To install simply add this config (along with it's peer dependencies) to your project's dev-dependencies:

npm install --save-dev eslint-config-vazco
npx install-peerdeps --dev eslint-config-vazco

Usage

Extend your project's ESLint rules with our config. This can be done in few ways (for TypeScript projects replace vazco with vazco/typescript):

.eslintrc / .eslintrc.json

{
    "extends": "vazco",
    "rules": {
        // custom project rules
    }
}

.eslintrc.yaml

extends:
  - vazco

rules:
  // custom project rules

package.json

{
    "eslintConfig": {
        "extends": "vazco"
    }
}

Prettier workflow

Introducing prettier to project can be problematic. To avoid merge conflicts, all active branches should reformat code at the same time.

Later on code could be --fixed on every commit, with tools like lint-staged and pre-commit or husky

Changelog

All changes introduces in the config are tracked inside changelog file.

How to change the rules

All information regarding making changes in the config and versioning details can be found in contributing file.

Please read them before opening a Pull Request or suggesting a change.

License

Like every package maintained by Vazco, eslint-config-vazco is MIT licensed.