如何从 gulp-esdoc 内部触发错误？

Question

我正在使用 gulp-esdoc 生成我的文档（它已经可以工作了）。

今天我添加了一个 git 预提交挂钩，它启动多个 gulp 任务并在其中一个任务 return 出错时阻止任何提交。

我的大部分任务都在工作，但是对于gulp-esdoc，我不知道如何return这样的错误来防止提交。

我这样配置我的 esdoc :

gulp.task('documentation', function() {
gulp.src("./client/")
    .pipe(esdoc({
        destination: "./docs",
        "title": "SOMETHING",
        index: "./README.md",
        "plugins": [{
            "name": "./README/docplugins/on-complete.js"
        }]
    }));
});

如您所见，我正在使用 esdoc 插件在生成文档后执行一些代码，这是插件的代码：

var colors = require('colors'),
gutil = require('gulp-util');

exports.onComplete = function(ev) {

    var output = require('../../docs/coverage.json');

    var expectedCoverage = 100; // todo : get from option instead
    var percentCovered = (output.actualCount / output.expectCount) * 100;

    if (percentCovered < expectedCoverage) {
        console.log('Code coverage is not sufficient (expected ' + expectedCoverage + '%, received only ' + percentCovered + '%) !!! Write some documentation or get out !'.red);
        // return false; // todo
    } else {
        console.log('Code coverage is complete, well done :)'.green);
        // return true;
    }

};

这里的主要目标是 return 如果我的代码文档没有被 100% 覆盖（代码逻辑正常工作，如果我的 JS 代码中缺少注释，我进入行"todo".

最后，这是我的（简化的）git-hook（在我的 gulp 文件中）：

gulp.task('pre-commit', function () {
    gulp.start('lint');
    gulp.start('documentation');
});

'lint' 部分有效，如果我的代码有错误，它会阻止提交。但是 'documentation' 代码，使用 gulp-esdoc，没有 return 任何错误，所以提交完成了 :( 我不知道如何处理 return错误并阻止 git 提交。

我需要这样做，因为我希望加入我的团队的初级开发人员被迫记录他们的代码：p

感谢您的帮助！

Answer 1

一个选项是抛出 PluginError:

throw new gutil.PluginError('esdoc', 'Something broke');

这将导致您的 gulp 进程以非零退出代码退出。然而，它会在 STDERR 上留下相当丑陋的堆栈跟踪（特别是因为 gulp-esdoc 从插件中重新抛出错误）。

另一种选择是使用特定的退出代码显式退出进程：

process.exit(1);

Node.js 中的 process 对象是一个全局对象，可以从任何地方访问而无需 require() 它。

如何从 gulp-esdoc 内部触发错误？

How can I trigger an error from inside gulp-esdoc?

javascript

git

documentation

gulp