notifyme-webpack-plugin

A webpack plugin to notify you TODO FIXME or any tag you want in your project

Usage no npm install needed!

<script type="module">
  import notifymeWebpackPlugin from 'https://cdn.skypack.dev/notifyme-webpack-plugin';
</script>

README

一个提醒你项目中的 TODO FIXME 的插件

效果

会在 terminal 提示你当前项目中的一些 TODO, FIXME 等等关键字的 TAG, 如下图

会在项目根目录生成一个 notify-me.md 的文件, 看起来像这样:

使用

npm i notifyme-webpack-plugin --save

import notifyMe from 'notifyme-webpack-plugin';

webpack.plugins.push(new notifyMe(options));

我们可以在注释中这样写:

// TODO (shiki) : this to be tested /issue[http://example.com/issue/1]
// TAG  对应负责人  TAG 的概述          TAG 的详细内容

配置

key type description default
exclude Array|String 不用匹配的一些文件夹 [ 'node_modules', 'bower_components' ]
tags Array|String 匹配的 tag 值 [ 'TODO', 'FIXME' ]