eslint-plugin-custom-plugin

plugin for production project

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-custom-plugin:

npm install eslint-plugin-custom-plugin --save-dev

Usage

In your configuration file, import the plugin eslint-plugin-custom-plugin and add custom-plugin to the plugins key:

import custom-plugin from "eslint-plugin-custom-plugin";

export default [
    {
        plugins: {
            custom-plugin
        }
    }
];

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

import custom-plugin from "eslint-plugin-custom-plugin";

export default [
    {
        plugins: {
            custom-plugin
        },
        rules: {
            "custom-plugin/rule-name": "warn"
        }
    }
];

Configurations

TODO: Run eslint-doc-generator to generate the configs list (or delete this section if no configs are offered).

Rules

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