eslint-plugin-routable

Internal ESLint plugin for Routable

Installation

You'll first need to install ESLint:

$ npm i -D eslint

Next, install eslint-plugin-routable:

$ npm i -D eslint-plugin-routable

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

Usage

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

{
    "plugins": [
        "routable"
    ]
}

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

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

Supported Rules

exports-newlines

Development

1. Clone the repo
2. Run npm link in the project repo
3. Navigate to the other project where you are using the plugin and run npm link eslint-plugin-routable
4. Update the eslint configuration to turn on the rule
5. Run eslint

Version updates

To release a new version of this plugin:

1. Open a PR targeting the master branch, updating the version number in both package.json and lockfile(s).
2. Tag and publish a new release on GitHub
   • example release tag: v1.3.12
   • example release title: v.1.3.12
   • succinctly summarize changes in the release notes
3. In the frontend repository's package.json, update the eslint-plugin-routable version URL hash, and sync this to lockfile(s).