Skip to content

team-aliens/eslint-plugin

Repository files navigation

eslint-plugin-aliens

aliens eslint style guide

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-aliens:

npm install eslint-plugin-aliens --save-dev

Next, install peerDependencies:

npm info eslint-plugin-aliens peerDependencies

Usage

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

{
    "plugins": [
        "aliens"
    ]
}

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

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

recommended

{
  "root": true,
  "plugins": ["aliens"],
  "extends": ["eslint:recommended", "plugin:alines/recommended"],
  "env": {
    "es6": true
  }
}

Supported Rules

  • Fill in provided rules here