Skip to content

Latest commit

 

History

History
72 lines (48 loc) · 1.64 KB

README.md

File metadata and controls

72 lines (48 loc) · 1.64 KB

eslint-plugin-xogroup

eslinting plugin ruleset and configuration defaults for the XO Group JS environment

npm version Build Status

Known Vulnerabilities NSP Status

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-xogroup:

$ npm install eslint-plugin-xogroup --save-dev

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

Usage

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

{
    "plugins": [
        "xogroup"
    ]
}

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

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

Also extend existing configurations under the extends section.

{
    "extends": [
        "plugin:xogroup/recommended",
        "plugin:xogroup/hapijs",
        "plugin:xogroup/angular",
    ]
}

Supported Rules

No Custom Rules

Suported Configurations

  • hapijs
  • angular