eslint-config-ndv

eslint-config

ESLint rules for all of my personal projects. Feel free to use these conventions :-)

Usage

Install the conventions by running:

npm install --save-dev eslint eslint-config

Then add the extends to your .eslintrc:

{
  "extends": "eslint-config",
  "rules": {
    // your overrides
  }
}

Other configs

This config also exposes a few other configs that I use often and pull in as needed.

You can use them standalone:

{
  "extends": "eslint-config/<config-name>"
}

Or in combination with the base config (recommended)

{
  "extends": ["eslint-config", "eslint-config/<config-name>"]
}

Note: I'm not certain why, but sometimes you need to have the associated plugins installed to make things work. I recommend adding them as dependencies to your project if you're going to use the config for it.

• babel-module: babel-plugin-module-resolver for the import plugin to work with the module-resolver babel plugin (eslint-plugin-import and eslint-import-resolver-babel-module)
• babel-react-require: babel-plugin-react-require for when you're using the react-require babel plugin (should be used with "eslint-config/react" as well) (eslint-plugin-react)
• jest: jest testing framework
• jsx-a11y: eslint-plugin-jsx-a11y for rules regarding accessibility with JSX (eslint-plugin-jsx-a11y)
• react: React JS library (eslint-plugin-react)
• webpack: Webpack for the import plugin to work with webpack overloaded imports/requires (eslint-plugin-import and eslint-import-resolver-webpack)

Things to know

• The default config uses babel-eslint to support stage features that ESLint doesn't support and it opts to use the eslint-plugin-babel rules over the ESLint rules to support rules for these features as well.
• All plugins needed for rules used by these configs are dependencies of this module so you don't have to install anything on your own.
• The default config actually is composed of several configurations and you can use those individually. These are the configs it's using: possible-errors.js, best-practices.js, stylistic.js, es6/index.js, and import/index.js. You can use each of these configs yourself if you want to leave my own personal style out of it. Also, the es6 and import configs each have a possible-errors.js, best-practices.js, and stylistic.js which they are composed of as well.

Example of highly customized config

{
  "extends": [
    "eslint-config/possible-errors", "eslint-config/best-practices",
    "eslint-config/es6/possible-errors", "eslint-config/import",
    "eslint-config/jest"
  ],
  "rules": { /* custom rules */ }
}

LICENSE

MIT