可以结合fs模块的watch方法,在文件发生变更时自动执行某些编译操作,例如执行apidoc编译命令。把该命令编写到package.json的scripts里。
"scripts": {
"buildModel": "node ./helper/autoBuild/model.js",
"start": "supervisor app.js",
"apidoc": "apidoc -i router/ -o ./apidoc/",
"autoBuildApidoc": "node ./helper/autoBuild/apidoc.js"
}
然后编写apidoc.js命令模块
const fs = require('fs');
console.log('启动API自动生成命令成功...');
fs.watch('./router/', {
recursive: true
}, ((event, filename) => {
console.warn(new Date(),' 检测到文件变化,正在执行编译命令...');
const exec = require('child_process').exec;
const cmdStr = 'npm run apidoc';
exec(cmdStr, (err, stdout, stderr) => {
if (err){
console.log(err);
console.warn(new Date(),' API文档编译命令执行失败');
} else {
console.log(stdout);
console.warn(new Date(),' API文档编译命令执行成功');
}
});
}))
最后在命令行工具中执行npm run autoBuildApidoc就可以,让监测目录下的文件发生变化时,就可以自动生成apidoc文档。