@agds/cli-plugin-doc/lib/utils/config.js

agds系统doc文档生成器

"use strict";

const path = require('path');

const defaultTemplate = path.resolve(__dirname, '../template/template.ejs');

const renderCode = require('./renderCode');

const defaultConfig = {
  template: defaultTemplate,
  jsdoc2mdOptions: {
    // 'no-cache': true,
    partial: [path.resolve(__dirname, '../dmdRewrite/partials/*.hbs')],
    helper: [path.resolve(__dirname, '../dmdRewrite/helpers/*.js')],
    'heading-depth': 3,
    // 使用`@alias`标签时优化id的显示，以确保id的唯一性
    dataModify: doclets => doclets.map(doclet => {
      if (doclet.alias) {
        doclet.id = doclet.memberof + '_alias_' + doclet.alias;
      }

      return doclet;
    })
  },
  // 默认`jsdocEngineOptions`配置一般只能增加无法删除，
  // 但是可以在配置noDefault来去除默认配置
  jsdocEngineOptions: {
    plugins: [require.resolve('jsdoc-tsimport-plugin'), require.resolve('./jsdoc-plugin-arrowfn'), require.resolve('jsdoc-typeof-plugin')]
  },
  helpers: {
    renderCode
  }
};
module.exports = defaultConfig;