什么是 gulp-todoist ?
gulp-todoist
是一个 gulp
插件,它可以将 TODO
和 FIXME
这种待办事项自动提取并生成清单,方便开发人员进行事项管理。
安装 gulp-todoist
使用 npm
进行 gulp-todoist
的安装:
--- ------- ------------ ----------
使用 gulp-todoist
1. gulpfile.js
在 gulpfile.js
文件中引入 gulp-todoist
:
----- ---- - ---------------- ----- ------- - ------------------------
2. 配置任务
添加一个名为 todo
的任务,并在其中调用 todoist
:
----------------- ---------- - ------ ------------------------ ---------------- ---------------------- ---
3. 运行任务
执行 gulp todo
命令,即可在终端中看到生成的待办事项清单。
配置项
filters
可以对待办事项使用自定义的过滤器,去除不需要的待办事项。如下所示:
----------------- ---------- - ------ ------------------------ --------------- -------- - ---------- ------- - --- ---------------------- ---
fileName
可以自定义生成的待办事项文件名。如下所示:
----------------- ---------- - ------ ------------------------ --------------- --------- --------- --- ---------------------- ---
transformComment
可以使用正则表达式自定义注释格式。如下所示:
----------------- ---------- - ------ ------------------------ --------------- ----------------- -------------------- --- ---------------------- ---
注意事项
gulp-todoist
只会对文件中带有 TODO
和 FIXME
关键词的注释进行提取,因此在编写代码时一定要有统一的注释格式,才能够生成完整的待办事项清单。
示例代码
----- ---- - ---------------- ----- ------- - ------------------------ ----------------- ---------- - ------ ------------------------ ---------------- ---------------------- ---
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/185304