eslint-config-endormi

ESLint Config

Inspired by Wes Bos' awesome eslint-config. Updated to my own liking.

Installation & Usage

Either install locally or globally.

Locally

Create a package.json file (npm init).

Then install config by running:

npx install-peerdeps --dev eslint-config-endormi

After the installation.

Create a .eslintrc file in the same directory as your package.json file and add this code:

{
  "extends": [
    "endormi"
  ]
}

Add these scripts to your package.json file

"scripts": {
  "linter": "eslint .",
  "linter:fix": "eslint . --fix"
},

Now you can lint your code by running npm run linter and fix all fixable issues with npm run linter:fix.

Globally

Install everything

npx install-peerdeps --global eslint-config-endormi

Then make a global .eslintrc file:

ESLint will look for one in your home directory

C:\Users\username\.eslintrc for windows

~/.eslintrc for mac

Add this to your .eslintrc file:

{
  "extends": [
    "endormi"
  ]
}

To use from the CLI, you can now run eslint .

Settings

If you want to overwrite eslint or prettier settings, you can add the rules in your .eslintrc file. ESLint rules go under "rules" while prettier rules goes under "prettier/prettier".

Example:

{
  "extends": [
    "endormi"
  ],
  "rules": {
    "no-debugger": 0,
    "no-alert": 0,
    "prettier/prettier": [
      "error",
      {
        "trailingComma": "es5",
        "tabWidth": 4,
        "singleQuote": true,
        "printWidth": 70,
      }
    ]
  }
}

If it's not working

This way you can start fresh

Remove all:

npm remove --global eslint-config-endormi babel-eslint eslint eslint-config-prettier eslint-config-airbnb eslint-plugin-html eslint-plugin-prettier eslint-plugin-import eslint-plugin-react prettier

To do the above for local, omit the --global flag.

If you are using a local install, remove your package-lock.json file and delete the node_modules/ directory.

Then follow the instructions again.