@renault-digital/eslint-config

Renault Digital ESLint config

• Installation
• Usage
• Examples
• Contribute

Installation

Using npm :

npm install --save-dev @renault-digital/eslint-config

Or using yarn :

yarn add --dev @renault-digital/eslint-config

Usage

Please follow configure ESLint for configuration.

The follow rules are available (you can combine them) :

• @renault-digital : General JS rules
• @renault-digital/common : Same as above
• @renault-digital/node : Rules specific to NodeJS
• @renault-digital/mocha : Rules specific to Mocha
• @renault-digital/server : Group of rules for NodeJS application

A basic usage will be in a file .eslintrc.json:

{
  "extends": "@renault-digital/eslint-config"
}

And after :

yarn eslint .

Examples

Bellow are some recommended usage.

A common usage

.eslintrc.json:

{
  "extends": "@renault-digital/eslint-config"
}

A typical Server project with NodeJS and Mocha tests

.eslintrc.json:

{
  "extends": "@renault-digital/eslint-config/server"
}

Contribute

Proposing changes

Major changes should be discussed GitHub.

Semver policy

Same approach as in ESLint, see Semantic Versioning Policy.