@productplan/eslint-plugin-custom-rules

Exposes a handful of rules that we prefer internally - both to help with generic best practices as well as some homebrew patterns for things like test linters.

Installation

You'll need to install both ESLint and @productplan/eslint-plugin-custom-rules.

Since these are already in the root package's package.json simply run:

$ yarn install

Usage

Add @productplan/eslint-plugin-custom-rules to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
    "plugins": [
       "@productplan/custom-rules"
    ]
}

Then configure the rules you want to use under the rules section. For example:

{
    "rules": {
        "@productplan/custom-rules/prefer-axios": 2
    }
}

Supported Rules

• mock-adapter-usage
• no-fa-string-classes
• no-href-hash
• no-undefined-classes
• prefer-axios
• prefer-component-over-element
• prefer-use-temp-masterplan
• prefer-use-temp-roadmap
• throw-or-log
• valid-request-configs