eslint-config-artycurate v1.8.0

eslint-config-artycurate

This config is three things:

1. Extends the strict eslint-config-airbnb.
2. Turns off the rules that have to do with formatting, leaving it to Prettier to handle.
3. Exposes optional React (artycurate/react) and Gatsby (artycurate/gatsby) configs.

Install

npx install-peerdeps --dev eslint-config-artycurate

Usage

Create config file (required)

Create a .eslintrc.js file at the root of your project and paste the following:

module.exports = {
  extends: [
    'artycurate',
    'artycurate/gatsby', // optional config for Gatsby development, extends artycurate/react by default
    'artycurate/react', // optional config for React development, not needed if you are already extending artycurate/gatsby
  ],
  rules: {
    // your custom rules here
  },
}

Ignore files and directories (optional)

Next, still at the root of your project, create a .eslintignore file listing the files and directories that you want ignored by ESLint.

node_modules
public
.cache
your_additional_folder

Run ESLint and Prettier with script (optional)

In your package.json, add the following scripts:

{
  "format": "prettier --write \"*.js\" \"src/**/*.js\"",
  "lint": "eslint ./ --ext .js --ext .jsx"
}

Run ESLint and Prettier in your code editor

In VSCode, install the ESLint (by Dirk Baeumer) and Prettier (by Esben Petersen) extensions.