eslint-plugin-story-prefix

eslint-plugin-story-prefix

A ESLint rule to check if it has _STORY suffix

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-story-prefix:

npm install eslint-plugin-story-prefix --save-dev

Usage

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

{
    "plugins": [
        "story-prefix"
    ]
}

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

{
    "rules": {
        "story-prefix/rule-name": 2
    }
}

Rules

TODO: Run eslint-doc-generator to generate the rules list.