Skip to content
This repository has been archived by the owner on Aug 29, 2023. It is now read-only.

mycsHQ/eslint-config-mycs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

eslint-config-mycs

Build Status npm Code Style semantic-release

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