@netcentric/eslint-config

This package provides Cognizant Netcentric's ESLint configuration as an extensible shared config.

If ESLint is new to you, you might want to check out what it does and how to configure it.

Install

npm i @netcentric/eslint-config

Setup

.eslintrc

Create or update your .eslintrc file:

{
  "extends": "@netcentric/eslint-config"
}

IDE integration

Most IDEs should have an integration for ESLint.

Build system integration

If you are using https://github.com/Netcentric/fe-build, ESLint is integrated by default.

For custom lint task, update package.json

  "scripts": {
    "lint:js": "eslint path/to/source-js-files"
  }

Make sure you do not accidently lint files you are not interested that are out of scope for your build; e.g. files within the node_modules folder.

Overwriting rules

Please stick to the Netcentric rules as they are battle tested and were created to form a company wide basis for JS code quality. If there's a very specific case you want to deactivate a rule for consider using Eslint inline comments instead.

If there's a rule you consider as outdated or simply wrong please contact the package's maintainer or file an issue in JIRA (bugs in package.json) or create a PR on the package's repository (repository in package.json).

If you have a very project specific case where adding or deactivating a rule makes perfectly sense, you can overwrite any rule using the rules property.

I don't understand why I violated rule X

You can find a description of all rules on the Eslint Homepage.