node.js - 从 jsDoc 输出中排除外部内容

Question

我们如何从 jsDoc 输出中正确排除 Externals 部分？

我的项目中有很多外部内容，我根本不想在导航面板上显示它们，因为它占用了所有空间，并且对我们来说毫无用处。

我已经能够通过更改文件 node_modules\jsdoc\lib\util\templateHelper.js 中的代码来手动破解它，但这对于我的开发团队来说不是可重用的方法。

黑客攻击是用空数组覆盖members.externals:

/*
    members.externals = members.externals.map(function(doclet) {
        doclet.name = doclet.name.replace(/(^"|"$)/g, '');
        return doclet;
    });
*/
    members.externals = [];

Answer 1

不幸的是，在使用jsDoc多年之后，我所能做的就是在每次更新依赖项后继续重新破解它，在文件node_modules\jsdoc\lib\util\templateHelper.js中。

幸运的是，即使使用当前版本 3.5.5，该 hack 的工作原理仍然相同:

// HACK: set Externals to an empty list:
members.externals = []; /*members.externals.map(function(doclet) {
    doclet.name = doclet.name.replace(/(^"|"$)/g, '');

    return doclet;
});*/