一款检测代码中TODO的eslint插件

方案	优点	缺点	学习成本
cli工具	不限制语言/文件类型,通过正则就能进行轻易的匹配	需要为每个项目单独编写一个指令,通过hook或者人工触发	❤❤❤
vs code插件	只需要用户为编辑器安装一个插件,即可在打开的时候进行提示	魔法师们可能用sublime/webStorm ,需要重复开发插件	❤❤❤❤
eslint规则	只需要在项目的配置文件中加入一行规则代码,即可实时的提示	需要安装依赖,首次需要手动引入	❤❤

create(context) {
    // 取得AST
    const sourceCode = context.getSourceCode()
    // 获取所有的注释节点
    let comments = sourceCode.getAllComments()
}

1
2
3
4
5
6

// 注释
/** 
 * Block
 **/

1
2
3
4

// 过滤出包含关键词的注释节点
comments = comments.filter(comment => {
    let { value, type } = comment
    // 展平块状注释
    if (type === 'Block') {
        value = value.replace(/\*|\n/g, '')
    }
    value = value.toLowerCase().trim()
    // 保存格式化后的字符串
    comment.newValue = value
    for (const flag of dFlag) {
        // 检测是否一关键字开头
        if (value.startsWith(flag)) {
            // 保存上flag
            comment.flag = flag
            return true
        }
    }
    return false
})

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

// flag ddl:time  xxxxx

1

// 匹配日期的正则
const rDate = [{
    reg: /((\d{4})|(\d{2}))(-((0\d)|(\d{2})|(\d{1}))){2}/,
    flag: '-' // yyyy-mm-dd|yy-mm-dd
},
{
    reg: /((\d{4})|(\d{2}))(\/((0\d)|(\d{2})|(\d{1}))){2}/,
    flag: '/'// yyyy/mm/dd|yy/mm/dd
},
{
    reg: /(\d{8})|(\d{6})/,
    flag: 'number'// yyyymmdd|yymmdd
}]
/**
 * 获取TODO注释中的DDL,是则返回日期值及其todo内容
 * @param {String} value 待操作字符串
 * @param {String[]} ddlSymbol 截止时间标识符
 * @param {STring} todoSymbol
 * @return {Object} 
 */
function getDDLAndText(value, ddlSymbol, todoSymbol) {
    let text = value.slice(value.indexOf(ddlSymbol) + ddlSymbol.length),
        date = ''
    for (const rdate of rDate) {
        const { reg, flag } = rdate
        const res = text.match(reg)
        if (res) {
            const [dateStr] = res
            // 再次校验匹配的日期日期是否合法
            if (reg.test(dateStr)) {
                let year, month, day
                if (flag !== 'number') {
                    let ymd = dateStr.split(flag)
                    ymd = ymd.map(v => {
                        return v.length === 1 ? `0${v}` : v
                    })
                    year = ymd[0]
                    month = ymd[1]
                    day = ymd[2]
                } else {
                    const { length } = dateStr
                    day = dateStr.slice(length - 2)
                    month = dateStr.slice(length - 4, length - 2)
                    year = dateStr.slice(0, length - 4)
                }
                if (year.length === 2) {
                    year = new Date().getFullYear().toString().slice(0, 2) + year
                }
                text = text.slice(text.indexOf(dateStr) + dateStr.length)
                date = `${year}-${month}-${day}`
                // 日期不合格也pass掉
                if (month > 12 || day > 31) {
                    date = ''
                }
                break
            }
        }
    }
    return {
        text,
        date
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

// 未设置DDL或者DDL不合法情况
if (!date) {
    errMsg = '没有设置有效的Deadline,设置方法(https://github.com/ATQQ/eslint-plugin-todo-ddl)'
} else {
    const TODODate = new Date(date).getTime()
    const interval = TODODate - Date.now()
    // 如果已经到期
    if (interval < 0 || interval < oneDay) {
        errMsg = '已经过截止日期，请立即修改'
    } else {
        // 剩余天数(向下取整)
        const theRestDays = ~~(interval / oneDay)
        errMsg = theRestDays <= dWarnLine ? `还有${theRestDays}天截止，请尽快修改` : ''
    }
}
if (errMsg) {
    context.report({
        node: comment,
        message: `TODO WARN: ${errMsg} --> ${text}`
    })
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

format1	demo	format2	demo	format3	demo
yyyy-mm-dd	2020-06-01	yyyy/mm/dd	2020/06/01	yyyymmdd	20200601
	2020-06-1		2020/06/1		200601
	2020-6-01		2020/6/01
	20-06-01		20/06/01
	20-6-1		20/6/1
	20-6-01		20/6/01

粥里有勺糖

Choose mode

一款检测代码中TODO的eslint插件

一款检测代码中TODO的eslint插件

# 一款检测代码中TODO的eslint插件

# 前言

# 背景

# 事后复盘

# 个人思考

# 调研-可行方案

# cli工具

# vs code插件

# eslint规则

# 对比

# 最终选择

# 实现过程

# 总结思考

# 不足之处

# 收获

# 未来

# 其它