Skip to content

einride/eslint-plugin

Repository files navigation

@einride/eslint-plugin

license npm version total npm downloads

Einride's default ESLint config

Installation

Install @einride/eslint-plugin as a dev dependency:

yarn add @einride/eslint-plugin --dev

Make sure ESLint and Prettier are also installed in your project.

Usage

Enable all default rules

Add plugin:@einride/default to the extends array in your ESLint configuration file. In .eslintrc.js:

module.exports = {
  extends: ["plugin:@einride/default"],
}

Note that you can omit the /eslint-plugin part of the package name, since it will be automatically assumed by ESLint.

To override a rule, add it to the rules object:

module.exports = {
  extends: ["plugin:@einride/default"],
  rules: {
    "max-depth": "off",
  },
}

Contribute

See Contributing Guide.

License

MIT