@twostoryrobot/eslint-config

2SR eslint

The Two Story Robot sharable eslint configuration so you can lint like us.

Usage

Install the package

npm install --save-dev @twostoryrobot/eslint-config

Make sure to install the peer dependencies

npm install --save-dev eslint eslint-config-prettier eslint-plugin-jest eslint-plugin-react

If you are using NPM >5 you can also do this:

npx install-peerdeps --dev @twostoryrobot/eslint-config

Add @twostoryrobot/eslint-config (or just @twostoryrobot) or @twostoryrobot/eslint-config/react (no shortcut for the react config, sorry) to the extends of your .eslintrc.

Example: .eslintrc.js:

module.exports = {
  extends: ['@twostoryrobot/eslint-config/react']
}

Scripts

Now you can add a script to your project's package.json that calls eslint and it will reference the config file in the root of your project directory.

"scripts": {
  "eslint": "eslint '**/*.js'"
}

Hooks

If you install husky you can invoke eslint as a hook for various actions (precommit, prepush, etc)

"scripts": {
  "precommit": "eslint '**/*.js'"
}