eslint-plugin-comment-prompt

eslint-plugin-comment-prompt

commit code for prompt comment

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-comment-prompt:

npm install eslint-plugin-comment-prompt --save-dev

Usage

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

import commentPrompt from "eslint-plugin-comment-prompt";

export default [
    {
        plugins: {
             'comment-prompt': commentPrompt
        },
        rules: {
            // 默认 每 20行 代码 需要加一行注释 (有效代码注释比 20)
            "comment-prompt/rule-name": ["error", 20]
        }
    }
];