eslint-config-c2-react

An ESLint Shareable Config for React/JSX support in JavaScript Standard Style

Pre Install

If your project already has an eslint ruleset that you're converting, remove all dependencies related to linting and git hooks from your package.json file. Example:

yarn remove husky babel-eslint eslint \
eslint-plugin-import eslint-plugin-node \
eslint-plugin-promise eslint-plugin-react \
eslint-plugin-standard

You may have references to other eslint-config-* and eslint-plugin-* packages. Remove those as well.

Remove your existing pre-commit hook if you have have one.

rm -rf .git/hooks/pre-commit

Install

# for yarn
yarn add -D @clearc2/eslint-config-c2-react

# for npm
npm install -D @clearc2/eslint-config-c2-react

Configure eslint

Create an .eslintrc.json file in the root of your project with the following contents:

{
    "extends": [
      "@clearc2/c2-react"
    ]
}

Create an .eslintignore file with files and folders that should not be linted. Example:

docs/
src/index.ejs
lib/
dist/

Configure the pre-commit hook

Use lint-staged's automatic setup to install.

npx mrm@2 lint-staged

Add a file pattern to your package.json.

"lint-staged": {
  "src/**/*.js": "eslint"
},

The above will lint all .js file anywhere within and below the src directory.

Tips

You can always lint your files before you attempt to commit. Example:

./node_modules/.bin/eslint src/module/Component.js

You can also have eslint attempt to fix your files according to the ruleset:

./node_modules/.bin/eslint --fix src/module/Component.js
# or a directory
./node_modules/.bin/eslint --fix src/module

This will catch and fix most of the issues. You will most likely still need to go into the file(s) to correct what eslint couldn't do automatically. It will show warnings of the problems that still exist after a fix command is run.