@nqminds/eslint-config

nquiringminds eslint config

This config provides a minimum set of linting rules that nqminds code should conform to.

Please see @nqminds/eslint-config-react for linting rules designed for react/webpack/babel.

Installation

npm i --save-dev @nqminds/eslint-config

Peer dependencies

If you do not already have the following as dev dependencies you will be prompted to install them when you run npm i:

npm i --save-dev eslint eslint-plugin-mocha eslint-plugin-promise eslint-plugin-jsdoc

Usage

In the root of your project add an .eslintrc.js with the following content:

module.exports = {
  extends: "@nqminds/eslint-config"
};

Alternatively, you can split up your config for Node.JS source code, and mocha test code:

module.exports = {
  extends: "@nqminds/eslint-config/mocha-config"
};

module.exports = {
  extends: "@nqminds/eslint-config/node-config"
};

Updating to v1.0.0

You will have to update your peerDependecies to:

npm i --save-dev eslint@^7.3.1 eslint-plugin-mocha@^7.0.1 eslint-plugin-promise@^4.2.1

The React/Babel/Webpack configs have been separated out into their own package, as the latest versions of the React/Babel eslint plugins expect to see React in your package.json and a working .babelrc.* file.

Therefore, if you are using React/Babel, you should:

• install the @nqminds/eslint-config-react plugin:

  npm i --save-dev @nqminds/eslint-config-react

• update all peerDependencies to your required versions

  • npm i --save-dev eslint-plugin-babel@^5.3.0 eslint-plugin-react@^7.20.0 eslint-plugin-jsdoc@^30.3.1

• add @nqminds/eslint-config-react to your .eslintrc.js #extends field:

  module.exports = {
    //...
    extends: [
      "@nqminds/eslint-config", // for Node.JS code
      "@nqminds/eslint-config-react" // for React/Webpack/Babel code
    ]
    //...
  };