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.

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
    }
}

exports-newlines

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

To release a new version of this plugin:

Open a PR targeting the master branch, updating the version number in both package.json and lockfile(s).
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
In the frontend repository's package.json, update the eslint-plugin-routable version URL hash, and sync this to lockfile(s).