eslint-plugin-helios

An ESLint plugin for the Helios design system

Contributing

Install Yeoman and the ESLint generator

$ npm install -g yo generator-eslint

Clone repo and install

$ npm install

Add a rule

$ yo

Follow the prompts:

Do you want to generate a rule or plugin? Rule
What is your name? <Name>
Where will this rule be published? ESLint Plugin
What is this rule ID? <sensible-rule-id>
Type a short description of this rule: <short description>
Type a short example of the code that will fail: <short code example>

Update docs/rules/<rule-name>.md, lib/rules/<rule-name>.js, and tests/lib/rules/<rule-name>.js

Run tests with npm run test

For Users of the Plugin

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-helios:

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

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

Usage

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

{
  "plugins": ["helios"]
}

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

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

Supported Rules

Fill in provided rules here

npm