eslint-plugin-ftgp

Custom rules for FTGP

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
eslint-plugin-ftgp
183.0.0a year ago7 years agoMinified + gzip package size for eslint-plugin-ftgp in KB

Readme

eslint-plugin-ftgp
Build Status
Custom rules for FTGP

Installation

You'll first need to install ESLint:
$ npm i eslint --save-dev

Next, install eslint-plugin-ftgp:
$ npm install eslint-plugin-ftgp --save-dev

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

Usage

Add ftgp to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:
{
    "plugins": [
        "ftgp"
    ]
}

Then configure the rules you want to use under the rules section.
{
    "rules": {
        "ftgp/rule-name": 2
    }
}

Supported Rules

Contributing

Run all tests with:
npm test

Run only a specific test with:
mocha tests/lib/rules/only-literal-polyglots.js  --reporter progress

Add a new rule with Yeoman's generator-eslint.

Release a new version by:

  1. running the tests
  2. changing the version property in package.json
  3. running npm publish
  4. committing the new package.json
  5. creating the release on github