Wondering what’s next for npm?Check out our public roadmap! »

    eslint-plugin-comments-key

    1.0.1 • Public • Published

    eslint-plugin-comments-key

    检查注释中是否包含指定关键词的插件

    Installation

    You'll first need to install ESLint:

    $ npm i eslint --save-dev
    

    Next, install eslint-plugin-comments-key:

    $ npm install eslint-plugin-comments-key --save-dev
    

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

    Usage

    Add comments-key to the plugins section of your .eslintrc configuration file or package.json. You can omit the eslint-plugin- prefix:

    package.json demo

    "eslintConfig"{
        "plugins": [
          "comments-key"
        ],
        "rules": {
          "comments-key/diy":[1,{
              "wordKeys":["fixme","xxx"]
          }]
        }
    }

    After the configuration is complete, you can see the prompts when coding and building

    Install

    npm i eslint-plugin-comments-key

    DownloadsWeekly Downloads

    0

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    6.8 kB

    Total Files

    6

    Last publish

    Collaborators

    • avatar