eslint-plugin-todo-ddl v1.1.1

eslint-plugin-todo-ddl

检查代码中的TODO注释是否到期或者将要到期

show

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-todo-ddl:

$ npm install eslint-plugin-todo-ddl --save-dev

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

Usage

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

package.json demo

"eslintConfig": {
    "plugins": [
      "todo-ddl"
    ],
    "rules": {
      "todo-ddl/diy":1
    }
}

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

Formats that can be detected

// TODO: DDL 2020-4-28 提示自己的内容
// fixme: DDL 2020/4/28 提示自己的内容
// TODO: deadline 20200428 提示自己的内容
// fixme: deadline 20-4-28 提示自己的内容

or

/**
* TODO
* DDL 2020-5-19
* 提示自己的内容
*/

support date formats

For example, June 1, 2020 --- 2020-06-01

customize

You can customize the detected keywords

default value

"rules": {
    "todo-ddl/diy":[1,{
      "flag": ["todo","fixme"],
      "ddl":  ["ddl","deadline"],
      "warnline": "7"
    }]
}