README.md

eslint-config-mycs

This package provides mycs's eslint rules as an extensible shared config.

To install

1. Install shared config npm install --save-dev eslint-config-mycs.
2. Install peerDependencies

(
  export PKG=eslint-config-mycs;
  npm info "$PKG@latest" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm install --save-dev "$PKG@latest"
)

1. Create a .eslintrc.js file and make sure that it contains the following:

module.exports = {
  "extends": "mycs",
  "rules": {
    "require-jsdoc": "warn"
  }
}

This will allow you to use the mycs eslint configuration and extend it with your own eslint configuration parameters.

Whenever editing the rules

Should you update the linting rules, please run the following command:

npm version minor