@creopark/eslint-config

eslint-config

A shared ESLint configuration for the Creopark team.

This configuration is a fork of Miles' awesome eslint configuration.

If you want something that is being maintained, use that repository instead.

Installation

Get started by running this command in the root of your project:

npm install --save-dev eslint eslint-plugin-import

Add in your package.json file under devDependencies

"@creopark/eslint-config": "^1.0.0"

and run npm i

Then add an .eslintrc file to the root of your project with the following content

{
  "extends": [
    "@creopark/eslint-config"
  ]
}

NOTE: eslint plugins are available for most modern text editors, like Atom, WebStorm, etc

React Projects

For projects using React, add the following to your .eslintrc file

{
  "extends": [
    "@creopark/eslint-config",
    "@creopark/eslint-config/rules/react"
  ]
}

Then install eslint-plugin-react and eslint-plugin-a11y:

npm install --save-dev eslint-plugin-react eslint-plugin-jsx-a11y

This gives your linting of React with jsx and some accessibility linting for jsx.

NOTE: You will have to instruct your IDE to lint jsx file extensions (e.g. with Atom, install the atom-react package) or use the eslint CLI:

  npm i -g eslint
  eslint . --ext=.js,.jsx

Override rules

It is possible to override rules on project level.

{
  "extends": [
    "@creopark/eslint-config",
    "@creopark/eslint-config/rules/react"
  ],
  "rules": {
      "max-len": ["error", 80],
    }
}