@eigenspace/eslint-config-codestyle

Includes eslint shareable configs.

Installation

1. Create .eslintrc.js in project root or choose already existing.

2. Add @eigenspace/codestyle as dev dependency.

3. Then add this below ⁽¹⁾:

   "@eigenspace/eslint-config-codestyle": "file:node_modules/@eigenspace/codestyle/packages/eslint"
   

4. yarn install

5. Extends configurations on .eslintrc file:

   extends: [
       '@eigenspace/codestyle/base',
       '@eigenspace/codestyle/react'
   ]
   

   Note: react is optional. Use it only if your project uses React.

6. In IDE settings turn on eslint and specify eslint path.

⁽¹⁾ We are forced to load it from codestyle project as subpackage because of satisfaction of requirement for naming shareable configs.

Project structure

base.js - Base configuration and rules for eslint
react.js - Configuration includes codestyle React rules
redux.js - Configuration includes codestyle Redux rules

Environmental requirements

• react: 16.x

Why do we have that dependencies?

• eslint-plugin-prettier - plugin for linting styles.
• eslint-plugin-react - React plugin for ESLint.
• eslint-plugin-react-redux - Redux plugin for ESLint.