@atlauncher/eslint-plugin-atlauncher

Custom ESLint rules for use with eslint-config-atlauncher

Stats

StarsIssuesVersionUpdatedCreatedSize
@atlauncher/eslint-plugin-atlauncher
070.3.04 years ago4 years agoMinified + gzip package size for @atlauncher/eslint-plugin-atlauncher in KB

Readme

@atlauncher/eslint-plugin-atlauncher

Custom ESLint rules for use with eslint-config-atlauncher

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install @atlauncher/eslint-plugin-atlauncher:

npm install @atlauncher/eslint-plugin-atlauncher --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install @atlauncher/eslint-plugin-atlauncher globally.

Usage

Add @atlauncher/atlauncher to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
  "plugins": [
    "@atlauncher/atlauncher"
  ]
}

Then configure the rules you want to use under the rules section.

{
  "rules": {
    "atlauncher/rule-name": 2
  }
}

Supported Rules

  • atlauncher/require-jsdoc - this is the same as the ESLint 'require-jsdoc' rule, but provides an extra 'ignore' option for function/method/class names to ignore

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.