@emergent/eslint-config NPM

ESLint & Prettier config for React

@emergent/eslint-config

Shareable config for ESLint and Prettier in React projects.

Overview

This configuration uses the airbnb ESLint config as starting point and overrides a few rules to create a less restrictive development environment. Prettier recommended code formatting rules are enforced via the ESLint plugin.

Setup

To install the package, run:

$ npm install @emergent/eslint-config --save-dev

This will install the config along with its peer dependencies:

eslint
eslint-config-airbnb
eslint-config-prettier
eslint-plugin-import
eslint-plugin-jsx-a11y
eslint-plugin-react
eslint-plugin-react-hooks
eslint-plugin-prettier
prettier

NOTE: if you are on an older version of npm (<7.0.0), you will need to install these manually:

$ npx install-peerdeps @emergent/eslint-config --save-dev

Usage

Add @emergent/eslint-config to your .eslintrc configfile:

// .eslintrc
{
  "extends": ["@emergent/eslint-config"]
}

Prettier

Prettier's default rules are enforced out of the box. Rules that conflict with ESLint are disabled via eslint-plugin-prettier.

You can override the default Prettier options by specifying them under prettier/prettier ESLint config file. EX:

// .eslintrc
{
  "extends": ["@emergent/eslint-config"],
  "rules": {
    "prettier/prettier": [
      "error",
      {
        "printWidth": 110
      }
    ]
  }
}

Ensure these rules match the options specified in your .prettierrc file.

Adding Scripts

Add the following scripts to your package.json file. Run these commnads to see your error, or fix them automatically.

"scripts": {
  // ..
  "lint": "eslint --ignore-path .gitignore .",
  "lint:fix": "eslint --ignore-path .gitignore --fix ."
  // ..
}

Extensions

For the best development experience use this config with the ESLint & Prettier extensions for your code editor. The ESLint extension highlites errors, and the prettier plugin will auto-format on save.

For Visual Studio Code use the following: