+string | 锚点的名称，填写之后可以支持 `href=\`#${id}\``锚点定位 |
+| [id] | string | 锚点的名称，填写之后可以支持 `href="#${id}"`锚点定位 |
| [title] | string | 内容的标题 |
| [desc] | string | 内容的描述 |
| [content] | string | 内容的正文 |
diff --git a/src/index.js b/src/index.js
index 7645771..712bd88 100644
--- a/src/index.js
+++ b/src/index.js
@@ -252,7 +252,7 @@ function execPromise(command) {
* 后缀内容类型
*
* @typedef {Object} Postfix
- * @property {string} [id] 锚点的名称，填写之后可以支持 `href=\`#${id}\``锚点定位
+ * @property {string} [id] 锚点的名称，填写之后可以支持 `href="#${id}"`锚点定位
* @property {string} [title] 内容的标题
* @property {string} [desc] 内容的描述
* @property {string} [content] 内容的正文
--
Gitee
From 072fe9a4d21a26655ebc2d8422be60f643b9ac39 Mon Sep 17 00:00:00 2001
From: jinyang <961284688@qq.com>
Date: Tue, 6 Jul 2021 01:14:57 +0800
Subject: [PATCH 2/4] =?UTF-8?q?feat:=20=E5=B0=9D=E8=AF=95=E6=8F=90?=
=?UTF-8?q?=E4=BA=A4coverage?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.gitignore | 1 -
README.md | 39 +-
agds.doc.config.js | 2 +
coverage/clover.xml | 85 +
coverage/coverage-final.json | 1462 +++++++++++++++++
coverage/lcov-report/base.css | 224 +++
coverage/lcov-report/block-navigation.js | 79 +
coverage/lcov-report/favicon.png | Bin 0 -> 540 bytes
coverage/lcov-report/index.html | 126 ++
coverage/lcov-report/prettify.css | 1 +
coverage/lcov-report/prettify.js | 2 +
coverage/lcov-report/sort-arrow-sprite.png | Bin 0 -> 209 bytes
coverage/lcov-report/sorter.js | 170 ++
.../src/dmdRewrite/helpers/index.html | 111 ++
.../src/dmdRewrite/helpers/index.js.html | 221 +++
coverage/lcov-report/src/index.html | 111 ++
coverage/lcov-report/src/index.js.html | 857 ++++++++++
coverage/lcov-report/src/utils/config.js.html | 152 ++
.../src/utils/getFilesPath.js.html | 197 +++
coverage/lcov-report/src/utils/index.html | 156 ++
.../lcov-report/src/utils/jsdocRender.js.html | 152 ++
.../lcov-report/src/utils/renderCode.js.html | 188 +++
coverage/lcov.info | 149 ++
package.json | 1 +
src/index.js | 1 +
src/template/template.ejs | 5 +-
26 files changed, 4489 insertions(+), 3 deletions(-)
create mode 100644 coverage/clover.xml
create mode 100644 coverage/coverage-final.json
create mode 100644 coverage/lcov-report/base.css
create mode 100644 coverage/lcov-report/block-navigation.js
create mode 100644 coverage/lcov-report/favicon.png
create mode 100644 coverage/lcov-report/index.html
create mode 100644 coverage/lcov-report/prettify.css
create mode 100644 coverage/lcov-report/prettify.js
create mode 100644 coverage/lcov-report/sort-arrow-sprite.png
create mode 100644 coverage/lcov-report/sorter.js
create mode 100644 coverage/lcov-report/src/dmdRewrite/helpers/index.html
create mode 100644 coverage/lcov-report/src/dmdRewrite/helpers/index.js.html
create mode 100644 coverage/lcov-report/src/index.html
create mode 100644 coverage/lcov-report/src/index.js.html
create mode 100644 coverage/lcov-report/src/utils/config.js.html
create mode 100644 coverage/lcov-report/src/utils/getFilesPath.js.html
create mode 100644 coverage/lcov-report/src/utils/index.html
create mode 100644 coverage/lcov-report/src/utils/jsdocRender.js.html
create mode 100644 coverage/lcov-report/src/utils/renderCode.js.html
create mode 100644 coverage/lcov.info
diff --git a/.gitignore b/.gitignore
index 617d58d..401ce41 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,4 +2,3 @@ lib/
node_modules/
.temp/
exa/
-coverage/
\ No newline at end of file
diff --git a/README.md b/README.md
index b6e81fa..e5b52f1 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,6 @@
+
+
+
string | 文档备注信息，md字符串 |
| [renderCode] | [renderCode](#GenDoc.renderCode) | 将`GenDoc.getFileCodes`的返回值渲染成对应的代码段 |
| [postfixes] | [Array.<Postfix>](#Postfix) | 后缀内容数组 |
+| [logo] | string | logo |
@@ -344,7 +348,10 @@ jsdocToMarkdown配置参数，具体可[👉参考文档](https://github.com/jsd
```ejs
<%
const {docs, codes, helpers, pkg} = locals
-%># <%- pkg.name %>
+%><% if(helpers.logo) { %>
+
+
+
+
+
+
+
+
+
+
+## 加入钉钉群讨论或加入开发
+
+
+
+
diff --git a/agds.doc.config.js b/agds.doc.config.js
index 4c9244e..1e7ebaa 100644
--- a/agds.doc.config.js
+++ b/agds.doc.config.js
@@ -5,6 +5,7 @@
const GenDoc = require('./lib/index');
const pkg = require('./package.json');
+const preset = require('@agds/agds-doc-preset');
module.exports = (
/**
* 配置参数
@@ -22,6 +23,7 @@ module.exports = (
files: ['./src/**/*.js'],
codesDir: './test/*',
codesFiles: ['*.js'],
+ presets: [preset],
helpers: {
devInstall: true,
postfixes: [
diff --git a/coverage/clover.xml b/coverage/clover.xml
new file mode 100644
index 0000000..6ed7e23
--- /dev/null
+++ b/coverage/clover.xml
@@ -0,0 +1,85 @@
+
++ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
++ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
+| File | ++ | Statements | ++ | Branches | ++ | Functions | ++ | Lines | ++ |
|---|---|---|---|---|---|---|---|---|---|
| index.js | +
+
+ |
+ 57.69% | +15/26 | +46.34% | +19/41 | +100% | +2/2 | +57.69% | +15/26 | +
+ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
+| 1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 | + + + + + + + + + + +1x +70x +30x +40x + +40x + +40x + +40x + +40x +35x +5x +5x + + + + + + + + + +1x +70x + +40x + +30x + + + + + + + | /*
+ * @Author: 锦阳
+ * @Create: 2021年05月09日
+ */
+/**
+ * returns a more appropriate 'kind', depending on context
+ *
+ * @param {object} options 参数
+ * @returns {string}
+ * @ignore
+ */
+exports.kindInThisContext = function kindInThisContext(options) {
+ if (this.kind === 'function' && this.memberof) {
+ return '方法';
+ } else Iif (this.kind === 'member' && !this.isEnum && this.memberof) {
+ return '属性';
+ } else Iif (this.kind === 'member' && this.isEnum && this.memberof) {
+ return '枚举属性';
+ } else Iif (this.kind === 'member' && this.isEnum && !this.memberof) {
+ return '枚举';
+ } else Iif (this.kind === 'member' && this.scope === 'global') {
+ return '变量';
+ } else if (this.kind === 'typedef') {
+ return '类型声明';
+ } else Eif (this.kind === 'class' && this.scope === 'global') {
+ return '类';
+ } else if (this.kind === 'function' && this.scope === 'global') {
+ return '函数';
+ } else if (this.kind === 'constant' && this.scope === 'global') {
+ return '常量';
+ } else {
+ return this.kind;
+ }
+};
+
+exports.scopeInThisContext = function () {
+ switch (this.scope) {
+ case 'global':
+ return '';
+ case 'static':
+ return '静态';
+ case 'inner':
+ return '内部';
+ default:
+ return this.scope;
+ }
+};
+ |
+ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
+| File | ++ | Statements | ++ | Branches | ++ | Functions | ++ | Lines | ++ |
|---|---|---|---|---|---|---|---|---|---|
| index.js | +
+
+ |
+ 100% | +41/41 | +100% | +16/16 | +100% | +9/9 | +100% | +39/39 | +
+ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
+| 1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240 +241 +242 +243 +244 +245 +246 +247 +248 +249 +250 +251 +252 +253 +254 +255 +256 +257 +258 +259 +260 | 1x +1x +1x +1x +1x +1x +1x +1x +1x + + + + + + + + + + + + + + + + + +5x +5x +4x +4x +1x + +3x + + + + + + + + + + + + + + +7x +1x + +7x +7x + +7x +5x + + +7x +5x + + +7x + + + + +7x +6x + + + + + + + + + + +17x +16x +17x +17x +26x +26x +26x +26x + +17x + + + +1x + + + + + + + + +6x + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +1x + + + +1x + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + | const ejs = require('ejs');
+const jsdocRender = require('./utils/jsdocRender');
+const getFilesPath = require('./utils/getFilesPath');
+const defaultConfig = require('./utils/config');
+const path = require('path');
+const fs = require('fs-extra');
+const { FastFs, FastPath, PresetUtils } = require('@agds/node-utils');
+const { exec } = require('child_process');
+const renderCode = require('./utils/renderCode');
+/**
+ * GenDoc 基于注释和可运行的示例代码自动生成文档的强大工具类
+ *
+ * #### 引入
+ * ```js
+ * const GenDoc = require('@agds/cli-plugin-doc');
+ * ```
+ *
+ */
+class GenDoc {
+ /**
+ * 基于ejs，用模板渲染文档
+ *
+ * @param {RenderOptions} options 获取用来渲染模板的数据
+ * @returns {Promise<string>} 异步返回基于ejs模板渲染的文档文本
+ */
+ static async render(options) {
+ const config = await _mergeToDefaultConfig(options);
+ const renderData = await this.getRenderData(config, false);
+ const res = await ejs.renderFile(config.template, renderData);
+ if (config.output) {
+ await FastFs.writeFile(FastPath.getCwdPath(config.output), res);
+ } else {
+ return res;
+ }
+ }
+
+ /**
+ * 获取用来渲染模板的数据（jsdoc生成的文档和示例代码的内容）
+ *
+ * @param {RenderOptions} options 配置参数
+ * @param {boolean} [needMergeConfig=true] 是否需要调用`_mergeToDefaultConfig`，
+ * options已经是merge处理过的就不需要调用,否则不推荐传入`false`
+ * 会导致别名不支持
+ * @returns {Promise<GetRenderDataResult>}
+ */
+ static async getRenderData(options, needMergeConfig = true) {
+ // node API调用时需要merge以附上默认配置
+ if (needMergeConfig) {
+ options = await _mergeToDefaultConfig(options);
+ }
+ const { jsdoc2mdOptions, codesOptions, helpers } = options;
+ const promises = [];
+ let docs;
+ if (jsdoc2mdOptions && jsdoc2mdOptions.files && jsdoc2mdOptions.files.length) {
+ promises.push(jsdocRender(jsdoc2mdOptions).then(res => { docs = res; }));
+ }
+ let codes;
+ if (codesOptions && JSON.stringify(codesOptions) !== '{}') {
+ promises.push(this.getFilesCode(codesOptions).then(res => { codes = res; }));
+ }
+ let pkg;
+ const pkgPath = FastPath.getCwdPath('package.json');
+ /* istanbul ignore next */
+ if (FastFs.getPathStatSync(pkgPath)) {
+ promises.push(FastFs.readJson(pkgPath).then(res => { pkg = res; }));
+ }
+ await Promise.all(promises);
+ return { docs, codes, helpers, pkg };
+ }
+
+ /**
+ * 基于glob的文件遍历函数，返回文件对应内容的数组，
+ * 以文件夹为单位返回文件内容对象，key是文件的extname
+ *
+ * @param {import('./utils/getFilesPath').GetFilesCodeOptions} options 获取源代码的文件路径配置参数
+ * @returns {Promise<Array<GetFilesCodeResult>>}
+ */
+ static async getFilesCode(options) {
+ const filesList = getFilesPath(options);
+ return filesList.map(files => {
+ const codes = {};
+ files.forEach(file => {
+ const ext = path.extname(file).replace(/^\./, '');
+ const code = fs.readFileSync(file, { encoding: 'utf8' });
+ codes[ext] = codes[ext] || [];
+ codes[ext].push(code);
+ });
+ return codes;
+ });
+ }
+
+ static renderCode = renderCode;
+ /**
+ * 获取命令行使用帮助文档
+ * 建议提前确保全局使用了最新的脚本
+ * 函数为异步函数，注意不能作为ejs帮助函数传入，可以获取返回值后，将返回值作为helpers的变量传入
+ *
+ * @returns {Promise<string[]>}
+ */
+ static async getCliUsages() {
+ const pkgPath = FastPath.getCwdPath('package.json');
+ /* istanbul ignore next */
+ if (FastFs.getPathStatSync(pkgPath)) {
+ const pkg = require(pkgPath);
+ const bin = pkg.bin;
+ try {
+ return await Promise.all(
+ Object.keys(bin)
+ .map(key => execPromise(`${key} -h`)),
+ ).then(res => res.filter(Boolean));
+ } catch (error) {
+ /* istanbul ignore next */
+ await Promise.all([
+ execPromise('chmod -R 750 lib'),
+ execPromise('npm link'),
+ ]);
+ /* istanbul ignore next */
+ return this.getCliUsages();
+ }
+ } else {
+ /* istanbul ignore next */
+ throw new Error('未检测到根目录下存在【package.json】文件');
+ }
+ }
+
+ /**
+ * 读取文件内容
+ *
+ * @param {string} filename 相对于运行目录的文件路径
+ * @returns {string}
+ */
+ static getFileContent(filename) {
+ return fs.readFileSync(FastPath.getCwdPath(filename), { encoding: 'utf-8' });
+ }
+};
+
+module.exports = GenDoc;
+
+/* istanbul ignore next */
+/**
+ * 将当前配置和默认配置合并
+ *
+ * @param {RenderOptions} options 获取用来渲染模板的数据
+ * @returns {RenderOptions} 异步返回基于ejs模板渲染的文档文本
+ * @ignore
+ */
+async function _mergeToDefaultConfig(options = {}) {
+ // 获取用户本地配置文件
+ const cwdConfPath = FastPath.getCwdPath(options.config || 'agds.doc.config.js');
+ options.presets = options.presets || [];
+ if (FastFs.getPathStatSync(cwdConfPath)) {
+ const userConfig = require(cwdConfPath);
+ options.presets.unshift(userConfig);
+ }
+ options.presets.push({ jsdoc2mdOptions: {}, codesOptions: {}, jsdocEngineOptions: {} });
+ let config = await PresetUtils.getDeepPresetMerge(options);
+ // 支持配置是否使用默认配置
+ if (config.default !== false) {
+ config.presets = config.presets || [];
+ config.presets.push(defaultConfig);
+ }
+ config = await PresetUtils.getDeepPresetMergeAndModify(config);
+ // files别名支持
+ if (config.files) {
+ config.jsdoc2mdOptions.files = config.files;
+ }
+ // codesDir&codesFiles别名支持
+ if (config.codesDir && config.codesFiles) {
+ config.codesOptions.dir = config.codesDir;
+ config.codesOptions.files = config.codesFiles;
+ }
+ // jsdocEngineOptions配置支持
+ if (config.jsdocEngineOptions && JSON.stringify(config.jsdocEngineOptions) !== '{}') {
+ const jsdocEngineConfigPath = path.join(__dirname, '../.temp/jsdoc.conf.json');
+ await FastFs.writeJsonFormat(jsdocEngineConfigPath, config.jsdocEngineOptions);
+ config.jsdoc2mdOptions.configure = jsdocEngineConfigPath;
+ }
+ return config;
+}
+/* istanbul ignore next */
+/**
+ * execPromise
+ *
+ * @param {string} command shell命令
+ * @returns {Promise<string>}
+ * @ignore
+ */
+function execPromise(command) {
+ return new Promise((resolve, reject) => {
+ exec(command, (error, stdout, stderr) => {
+ if (error) {
+ return reject(error);
+ }
+ return resolve(stdout);
+ });
+ });
+}
+
+/**
+ * 函数[GenDoc.getRenderData](#GenDoc.getRenderData)的返回值
+ *
+ * @typedef {object} GetRenderDataResult
+ * @property {string} docs 源码使用jsdoc渲染后的markdown文本
+ * @property {Array<GetFilesCodeResult>} codes 获取到的代码内容
+ */
+
+/**
+ * 渲染函数的配置参数
+ *
+ * @typedef {object} RenderOptions
+ * @property {string[]} files `jsdoc2mdOptions.files`的别名
+ * @property {fs.PathLike} output doc文档渲染导出的文件名称路径，相对于cwd目录
+ * @property {string} template ejs渲染的模板相对于cwd的路径或者绝对路径
+ * @property {string} [codesDir] `codesOptions.dir`的别名
+ * @property {string[]} [codesFiles] `codesOptions.codesFiles`的别名
+ * @property {fs.PathLike} [conifg=agds.doc.config.js] 配置文件路径，默认为运行目录下的`agds.doc.config.js`,仅支持`js`文件类型
+ * @property {boolean} [default] 是否合并默认配置，一般我们认为您是需要默认配置的，当默认配置和你的需求冲突时可以设置为`false`
+ * @property {import('./utils/jsdocRender').Jsdoc2mdOptions} [jsdoc2mdOptions] jsdocToMarkdown配置参数
+ * @property {import('./utils/getFilesPath').GetFilesCodeOptions} [codesOptions] 获取源代码的文件路径配置参数
+ * @property {object} [jsdocEngineOptions] jsdoc解析引擎的配置，实际上是`jsdoc.conf.js`的整合，
+ * 也可以使用 `RenderOptions.jsdoc2mdOptions.configure`字段来指定本地的jsdoc配置
+ * 配置选项[👉参考文档](https://jsdoc.app/about-configuring-jsdoc.html)
+ * @property {DefaultHelpers} [helpers] 注入ejs模板的`helpers`对象，提供模板使用的帮助函数和变量，配合模板使用
+ * @property {RenderOptions[]} [presets] 基于preset机制实现配置支持预设的功能，
+ * 具体[👉参考文档](https://gitee.com/agile-development-system/node-utils#presetutilsgetdeeppresetmergeconfig--config)`PresetUtils.getDeepPresetMerge`
+ * @property {boolean} [noDefault] 取消合并默认配置
+ * @property {import('@agds/node-utils').ConfigModify} [modify] 将默认配置和preset合并后生成的config再次处理的钩子
+ * 具体[👉参考文档](https://gitee.com/agile-development-system/node-utils#presetutilsgetdeeppresetmergeconfig--config)
+ */
+
+/**
+ * 获取文件的内容的返回值类型，key是文件的extname
+ *
+ * @typedef {Object.<string,string>} GetFilesCodeResult
+ */
+
+/**
+ * 默认模板所支持的`helpers`属性
+ *
+ * @typedef {Object} DefaultHelpers
+ * @property {string} [installCode] 安装脚本，bash脚本，默认为`npm i ${pkg.name}`，如不符合要求，可以通过此字段自行修改
+ * @property {boolean} [devInstall] 是否是作为开发依赖下载，`true`时，默认下载代码自动拼接npm `-D` 参数
+ * @property {string} [importCode] 引入代码示例，js字符串
+ * @property {string} [exportCode] 导出代码，js字符串
+ * @property {string[]} [cliUsages] cli命令行使用帮助文档，格式类似`agds-doc -h`的输出内容
+ * @property {string} [remark] 文档备注信息，md字符串
+ * @property {GenDoc.renderCode} [renderCode] 将`GenDoc.getFileCodes`的返回值渲染成对应的代码段
+ * @property {Postfix[]} [postfixes] 后缀内容数组
+ */
+
+/**
+ * 后缀内容类型
+ *
+ * @typedef {Object} Postfix
+ * @property {string} [id] 锚点的名称，填写之后可以支持 `href=\`#${id}\``锚点定位
+ * @property {string} [title] 内容的标题
+ * @property {string} [desc] 内容的描述
+ * @property {string} [content] 内容的正文
+ */
+ |
+ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
+| 1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 | 1x +1x +1x +1x + + + + + + + + + + + + + + + + + + + +1x + | 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,
+ },
+ // 默认`jsdocEngineOptions`配置一般只能增加无法删除，
+ // 但是可以在配置noDefault来去除默认配置
+ jsdocEngineOptions: {
+ plugins: [
+ require.resolve('jsdoc-tsimport-plugin'),
+ ],
+ },
+ helpers: {
+ renderCode,
+ },
+};
+
+module.exports = defaultConfig;
+ |
+ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
+| 1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 | + + + + +1x +1x +1x + + + + + + + + +17x +17x +1x + +16x +17x + + + +17x + + + + +1x + + + + + + + + + | /*
+ * @Author: 锦阳
+ * @Create: 2021年04月25日
+ */
+
+const FileSet = require('file-set');
+const { FastPath } = require('@agds/node-utils');
+const path = require('path');
+/**
+ * 基于glob的文件遍历函数，返回基于目录分类的二维数组
+ *
+ * @param {GetFilesCodeOptions} options 配置参数
+ * @returns {string[][]}
+ * @ignore
+ */
+function getFilesPath({ dir, files }) {
+ const _dirs = new FileSet(FastPath.getCwdPath(dir)).dirs;
+ if (!(_dirs && _dirs.length > 0)) {
+ throw new Error('未匹配到任何目录，请确认输入路径');
+ }
+ return _dirs.map(dir =>
+ (
+ new FileSet(
+ files
+ .map(file =>
+ path.resolve(dir, file)))
+ )
+ .files);
+}
+
+module.exports = getFilesPath;
+
+/**
+ * 获取源代码的文件路径配置参数
+ *
+ * @typedef {object} GetFilesCodeOptions
+ * @property {string} dir glob路径
+ * @property {string[]} files glob文件名称数组
+ */
+ |
+ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
+| File | ++ | Statements | ++ | Branches | ++ | Functions | ++ | Lines | ++ |
|---|---|---|---|---|---|---|---|---|---|
| config.js | +
+
+ |
+ 100% | +5/5 | +100% | +0/0 | +100% | +0/0 | +100% | +5/5 | +
| getFilesPath.js | +
+
+ |
+ 100% | +10/10 | +100% | +4/4 | +100% | +3/3 | +100% | +10/10 | +
| jsdocRender.js | +
+
+ |
+ 100% | +3/3 | +100% | +0/0 | +100% | +1/1 | +100% | +3/3 | +
| renderCode.js | +
+
+ |
+ 100% | +1/1 | +100% | +0/0 | +100% | +0/0 | +100% | +1/1 | +
+ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
+| 1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 | + + + + +1x + + + + + + + + +5x + + +1x + + + + + + + | /*
+ * @Author: 锦阳
+ * @Create: 2021年04月22日
+ */
+
+const doc = require('jsdoc-to-markdown');
+/**
+ * 渲染jsdoc文档
+ *
+ * @param {Jsdoc2mdOptions} options jsdocToMarkdown配置参数
+ * @returns {Promise<string>} 异步返回jsdoc文档文本
+ * @ignore
+ */
+function jsdocRender(options) {
+ return doc.render(options);
+}
+
+module.exports = jsdocRender;
+
+/**
+ * jsdocToMarkdown配置参数，具体可[👉参考文档](https://github.com/jsdoc2md/jsdoc-to-markdown/blob/master/docs/API.md)
+ *
+ * @typedef {object} Jsdoc2mdOptions
+ */
+ |
+ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
+| 1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +1x + | /*
+ * @Author: 锦阳
+ * @Create: 2021年05月31日
+ */
+/* istanbul ignore next */
+/**
+ * 将codes渲染成md代码片段
+ *
+ * @param {Array<import('../index.js').GetFilesCodeResult>} codes `GenDoc.getFilesCode`函数获取到的codes数组
+ * @param {string[]} [extSort= ['md', 'vue', 'jsx', 'js']] 优先并且按照`extSort`数组顺序获取遍历codes
+ * @param {Object<string,string>} [extTrans={vue:'html'}] ext转换的映射map
+ * 简单示例`{vue:'html'}`
+ * @returns {string}
+ * @alias GenDoc.renderCode
+ */
+function renderCode(codes, extSort = ['md', 'vue', 'jsx', 'js'], extTrans = { vue: 'html' }) {
+ let result = '';
+ codes && codes.forEach((item) => {
+ extSort.concat(Object.keys(item).filter(ext => !extSort.includes(ext))).forEach((ext) => {
+ const code = item[ext];
+ if (code) {
+ code.forEach(c => {
+ if (ext === 'md') {
+ result += c + '\n';
+ } else {
+ const _ext = extTrans[ext] || ext;
+ result += `\`\`\`${_ext}\n` + c + '\n```\n';
+ }
+ });
+ }
+ });
+ });
+ return result;
+}
+
+module.exports = renderCode;
+ |
+
+
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
-- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
-| File | -- | Statements | -- | Branches | -- | Functions | -- | Lines | -- |
|---|---|---|---|---|---|---|---|---|---|
| index.js | -
-
- |
- 57.69% | -15/26 | -46.34% | -19/41 | -100% | -2/2 | -57.69% | -15/26 | -
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
-| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 | - - - - - - - - - - -1x -70x -30x -40x - -40x - -40x - -40x - -40x -35x -5x -5x - - - - - - - - - -1x -70x - -40x - -30x - - - - - - - | /*
- * @Author: 锦阳
- * @Create: 2021年05月09日
- */
-/**
- * returns a more appropriate 'kind', depending on context
- *
- * @param {object} options 参数
- * @returns {string}
- * @ignore
- */
-exports.kindInThisContext = function kindInThisContext(options) {
- if (this.kind === 'function' && this.memberof) {
- return '方法';
- } else Iif (this.kind === 'member' && !this.isEnum && this.memberof) {
- return '属性';
- } else Iif (this.kind === 'member' && this.isEnum && this.memberof) {
- return '枚举属性';
- } else Iif (this.kind === 'member' && this.isEnum && !this.memberof) {
- return '枚举';
- } else Iif (this.kind === 'member' && this.scope === 'global') {
- return '变量';
- } else if (this.kind === 'typedef') {
- return '类型声明';
- } else Eif (this.kind === 'class' && this.scope === 'global') {
- return '类';
- } else if (this.kind === 'function' && this.scope === 'global') {
- return '函数';
- } else if (this.kind === 'constant' && this.scope === 'global') {
- return '常量';
- } else {
- return this.kind;
- }
-};
-
-exports.scopeInThisContext = function () {
- switch (this.scope) {
- case 'global':
- return '';
- case 'static':
- return '静态';
- case 'inner':
- return '内部';
- default:
- return this.scope;
- }
-};
- |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
-| File | -- | Statements | -- | Branches | -- | Functions | -- | Lines | -- |
|---|---|---|---|---|---|---|---|---|---|
| index.js | -
-
- |
- 100% | -41/41 | -100% | -16/16 | -100% | -9/9 | -100% | -39/39 | -
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
-| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 -79 -80 -81 -82 -83 -84 -85 -86 -87 -88 -89 -90 -91 -92 -93 -94 -95 -96 -97 -98 -99 -100 -101 -102 -103 -104 -105 -106 -107 -108 -109 -110 -111 -112 -113 -114 -115 -116 -117 -118 -119 -120 -121 -122 -123 -124 -125 -126 -127 -128 -129 -130 -131 -132 -133 -134 -135 -136 -137 -138 -139 -140 -141 -142 -143 -144 -145 -146 -147 -148 -149 -150 -151 -152 -153 -154 -155 -156 -157 -158 -159 -160 -161 -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179 -180 -181 -182 -183 -184 -185 -186 -187 -188 -189 -190 -191 -192 -193 -194 -195 -196 -197 -198 -199 -200 -201 -202 -203 -204 -205 -206 -207 -208 -209 -210 -211 -212 -213 -214 -215 -216 -217 -218 -219 -220 -221 -222 -223 -224 -225 -226 -227 -228 -229 -230 -231 -232 -233 -234 -235 -236 -237 -238 -239 -240 -241 -242 -243 -244 -245 -246 -247 -248 -249 -250 -251 -252 -253 -254 -255 -256 -257 -258 -259 -260 | 1x -1x -1x -1x -1x -1x -1x -1x -1x - - - - - - - - - - - - - - - - - -5x -5x -4x -4x -1x - -3x - - - - - - - - - - - - - - -7x -1x - -7x -7x - -7x -5x - - -7x -5x - - -7x - - - - -7x -6x - - - - - - - - - - -17x -16x -17x -17x -26x -26x -26x -26x - -17x - - - -1x - - - - - - - - -6x - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -1x - - - -1x - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | const ejs = require('ejs');
-const jsdocRender = require('./utils/jsdocRender');
-const getFilesPath = require('./utils/getFilesPath');
-const defaultConfig = require('./utils/config');
-const path = require('path');
-const fs = require('fs-extra');
-const { FastFs, FastPath, PresetUtils } = require('@agds/node-utils');
-const { exec } = require('child_process');
-const renderCode = require('./utils/renderCode');
-/**
- * GenDoc 基于注释和可运行的示例代码自动生成文档的强大工具类
- *
- * #### 引入
- * ```js
- * const GenDoc = require('@agds/cli-plugin-doc');
- * ```
- *
- */
-class GenDoc {
- /**
- * 基于ejs，用模板渲染文档
- *
- * @param {RenderOptions} options 获取用来渲染模板的数据
- * @returns {Promise<string>} 异步返回基于ejs模板渲染的文档文本
- */
- static async render(options) {
- const config = await _mergeToDefaultConfig(options);
- const renderData = await this.getRenderData(config, false);
- const res = await ejs.renderFile(config.template, renderData);
- if (config.output) {
- await FastFs.writeFile(FastPath.getCwdPath(config.output), res);
- } else {
- return res;
- }
- }
-
- /**
- * 获取用来渲染模板的数据（jsdoc生成的文档和示例代码的内容）
- *
- * @param {RenderOptions} options 配置参数
- * @param {boolean} [needMergeConfig=true] 是否需要调用`_mergeToDefaultConfig`，
- * options已经是merge处理过的就不需要调用,否则不推荐传入`false`
- * 会导致别名不支持
- * @returns {Promise<GetRenderDataResult>}
- */
- static async getRenderData(options, needMergeConfig = true) {
- // node API调用时需要merge以附上默认配置
- if (needMergeConfig) {
- options = await _mergeToDefaultConfig(options);
- }
- const { jsdoc2mdOptions, codesOptions, helpers } = options;
- const promises = [];
- let docs;
- if (jsdoc2mdOptions && jsdoc2mdOptions.files && jsdoc2mdOptions.files.length) {
- promises.push(jsdocRender(jsdoc2mdOptions).then(res => { docs = res; }));
- }
- let codes;
- if (codesOptions && JSON.stringify(codesOptions) !== '{}') {
- promises.push(this.getFilesCode(codesOptions).then(res => { codes = res; }));
- }
- let pkg;
- const pkgPath = FastPath.getCwdPath('package.json');
- /* istanbul ignore next */
- if (FastFs.getPathStatSync(pkgPath)) {
- promises.push(FastFs.readJson(pkgPath).then(res => { pkg = res; }));
- }
- await Promise.all(promises);
- return { docs, codes, helpers, pkg };
- }
-
- /**
- * 基于glob的文件遍历函数，返回文件对应内容的数组，
- * 以文件夹为单位返回文件内容对象，key是文件的extname
- *
- * @param {import('./utils/getFilesPath').GetFilesCodeOptions} options 获取源代码的文件路径配置参数
- * @returns {Promise<Array<GetFilesCodeResult>>}
- */
- static async getFilesCode(options) {
- const filesList = getFilesPath(options);
- return filesList.map(files => {
- const codes = {};
- files.forEach(file => {
- const ext = path.extname(file).replace(/^\./, '');
- const code = fs.readFileSync(file, { encoding: 'utf8' });
- codes[ext] = codes[ext] || [];
- codes[ext].push(code);
- });
- return codes;
- });
- }
-
- static renderCode = renderCode;
- /**
- * 获取命令行使用帮助文档
- * 建议提前确保全局使用了最新的脚本
- * 函数为异步函数，注意不能作为ejs帮助函数传入，可以获取返回值后，将返回值作为helpers的变量传入
- *
- * @returns {Promise<string[]>}
- */
- static async getCliUsages() {
- const pkgPath = FastPath.getCwdPath('package.json');
- /* istanbul ignore next */
- if (FastFs.getPathStatSync(pkgPath)) {
- const pkg = require(pkgPath);
- const bin = pkg.bin;
- try {
- return await Promise.all(
- Object.keys(bin)
- .map(key => execPromise(`${key} -h`)),
- ).then(res => res.filter(Boolean));
- } catch (error) {
- /* istanbul ignore next */
- await Promise.all([
- execPromise('chmod -R 750 lib'),
- execPromise('npm link'),
- ]);
- /* istanbul ignore next */
- return this.getCliUsages();
- }
- } else {
- /* istanbul ignore next */
- throw new Error('未检测到根目录下存在【package.json】文件');
- }
- }
-
- /**
- * 读取文件内容
- *
- * @param {string} filename 相对于运行目录的文件路径
- * @returns {string}
- */
- static getFileContent(filename) {
- return fs.readFileSync(FastPath.getCwdPath(filename), { encoding: 'utf-8' });
- }
-};
-
-module.exports = GenDoc;
-
-/* istanbul ignore next */
-/**
- * 将当前配置和默认配置合并
- *
- * @param {RenderOptions} options 获取用来渲染模板的数据
- * @returns {RenderOptions} 异步返回基于ejs模板渲染的文档文本
- * @ignore
- */
-async function _mergeToDefaultConfig(options = {}) {
- // 获取用户本地配置文件
- const cwdConfPath = FastPath.getCwdPath(options.config || 'agds.doc.config.js');
- options.presets = options.presets || [];
- if (FastFs.getPathStatSync(cwdConfPath)) {
- const userConfig = require(cwdConfPath);
- options.presets.unshift(userConfig);
- }
- options.presets.push({ jsdoc2mdOptions: {}, codesOptions: {}, jsdocEngineOptions: {} });
- let config = await PresetUtils.getDeepPresetMerge(options);
- // 支持配置是否使用默认配置
- if (config.default !== false) {
- config.presets = config.presets || [];
- config.presets.push(defaultConfig);
- }
- config = await PresetUtils.getDeepPresetMergeAndModify(config);
- // files别名支持
- if (config.files) {
- config.jsdoc2mdOptions.files = config.files;
- }
- // codesDir&codesFiles别名支持
- if (config.codesDir && config.codesFiles) {
- config.codesOptions.dir = config.codesDir;
- config.codesOptions.files = config.codesFiles;
- }
- // jsdocEngineOptions配置支持
- if (config.jsdocEngineOptions && JSON.stringify(config.jsdocEngineOptions) !== '{}') {
- const jsdocEngineConfigPath = path.join(__dirname, '../.temp/jsdoc.conf.json');
- await FastFs.writeJsonFormat(jsdocEngineConfigPath, config.jsdocEngineOptions);
- config.jsdoc2mdOptions.configure = jsdocEngineConfigPath;
- }
- return config;
-}
-/* istanbul ignore next */
-/**
- * execPromise
- *
- * @param {string} command shell命令
- * @returns {Promise<string>}
- * @ignore
- */
-function execPromise(command) {
- return new Promise((resolve, reject) => {
- exec(command, (error, stdout, stderr) => {
- if (error) {
- return reject(error);
- }
- return resolve(stdout);
- });
- });
-}
-
-/**
- * 函数[GenDoc.getRenderData](#GenDoc.getRenderData)的返回值
- *
- * @typedef {object} GetRenderDataResult
- * @property {string} docs 源码使用jsdoc渲染后的markdown文本
- * @property {Array<GetFilesCodeResult>} codes 获取到的代码内容
- */
-
-/**
- * 渲染函数的配置参数
- *
- * @typedef {object} RenderOptions
- * @property {string[]} files `jsdoc2mdOptions.files`的别名
- * @property {fs.PathLike} output doc文档渲染导出的文件名称路径，相对于cwd目录
- * @property {string} template ejs渲染的模板相对于cwd的路径或者绝对路径
- * @property {string} [codesDir] `codesOptions.dir`的别名
- * @property {string[]} [codesFiles] `codesOptions.codesFiles`的别名
- * @property {fs.PathLike} [conifg=agds.doc.config.js] 配置文件路径，默认为运行目录下的`agds.doc.config.js`,仅支持`js`文件类型
- * @property {boolean} [default] 是否合并默认配置，一般我们认为您是需要默认配置的，当默认配置和你的需求冲突时可以设置为`false`
- * @property {import('./utils/jsdocRender').Jsdoc2mdOptions} [jsdoc2mdOptions] jsdocToMarkdown配置参数
- * @property {import('./utils/getFilesPath').GetFilesCodeOptions} [codesOptions] 获取源代码的文件路径配置参数
- * @property {object} [jsdocEngineOptions] jsdoc解析引擎的配置，实际上是`jsdoc.conf.js`的整合，
- * 也可以使用 `RenderOptions.jsdoc2mdOptions.configure`字段来指定本地的jsdoc配置
- * 配置选项[👉参考文档](https://jsdoc.app/about-configuring-jsdoc.html)
- * @property {DefaultHelpers} [helpers] 注入ejs模板的`helpers`对象，提供模板使用的帮助函数和变量，配合模板使用
- * @property {RenderOptions[]} [presets] 基于preset机制实现配置支持预设的功能，
- * 具体[👉参考文档](https://gitee.com/agile-development-system/node-utils#presetutilsgetdeeppresetmergeconfig--config)`PresetUtils.getDeepPresetMerge`
- * @property {boolean} [noDefault] 取消合并默认配置
- * @property {import('@agds/node-utils').ConfigModify} [modify] 将默认配置和preset合并后生成的config再次处理的钩子
- * 具体[👉参考文档](https://gitee.com/agile-development-system/node-utils#presetutilsgetdeeppresetmergeconfig--config)
- */
-
-/**
- * 获取文件的内容的返回值类型，key是文件的extname
- *
- * @typedef {Object.<string,string>} GetFilesCodeResult
- */
-
-/**
- * 默认模板所支持的`helpers`属性
- *
- * @typedef {Object} DefaultHelpers
- * @property {string} [installCode] 安装脚本，bash脚本，默认为`npm i ${pkg.name}`，如不符合要求，可以通过此字段自行修改
- * @property {boolean} [devInstall] 是否是作为开发依赖下载，`true`时，默认下载代码自动拼接npm `-D` 参数
- * @property {string} [importCode] 引入代码示例，js字符串
- * @property {string} [exportCode] 导出代码，js字符串
- * @property {string[]} [cliUsages] cli命令行使用帮助文档，格式类似`agds-doc -h`的输出内容
- * @property {string} [remark] 文档备注信息，md字符串
- * @property {GenDoc.renderCode} [renderCode] 将`GenDoc.getFileCodes`的返回值渲染成对应的代码段
- * @property {Postfix[]} [postfixes] 后缀内容数组
- */
-
-/**
- * 后缀内容类型
- *
- * @typedef {Object} Postfix
- * @property {string} [id] 锚点的名称，填写之后可以支持 `href=\`#${id}\``锚点定位
- * @property {string} [title] 内容的标题
- * @property {string} [desc] 内容的描述
- * @property {string} [content] 内容的正文
- */
- |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
-| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 | 1x -1x -1x -1x - - - - - - - - - - - - - - - - - - - -1x - | 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,
- },
- // 默认`jsdocEngineOptions`配置一般只能增加无法删除，
- // 但是可以在配置noDefault来去除默认配置
- jsdocEngineOptions: {
- plugins: [
- require.resolve('jsdoc-tsimport-plugin'),
- ],
- },
- helpers: {
- renderCode,
- },
-};
-
-module.exports = defaultConfig;
- |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
-| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 | - - - - -1x -1x -1x - - - - - - - - -17x -17x -1x - -16x -17x - - - -17x - - - - -1x - - - - - - - - - | /*
- * @Author: 锦阳
- * @Create: 2021年04月25日
- */
-
-const FileSet = require('file-set');
-const { FastPath } = require('@agds/node-utils');
-const path = require('path');
-/**
- * 基于glob的文件遍历函数，返回基于目录分类的二维数组
- *
- * @param {GetFilesCodeOptions} options 配置参数
- * @returns {string[][]}
- * @ignore
- */
-function getFilesPath({ dir, files }) {
- const _dirs = new FileSet(FastPath.getCwdPath(dir)).dirs;
- if (!(_dirs && _dirs.length > 0)) {
- throw new Error('未匹配到任何目录，请确认输入路径');
- }
- return _dirs.map(dir =>
- (
- new FileSet(
- files
- .map(file =>
- path.resolve(dir, file)))
- )
- .files);
-}
-
-module.exports = getFilesPath;
-
-/**
- * 获取源代码的文件路径配置参数
- *
- * @typedef {object} GetFilesCodeOptions
- * @property {string} dir glob路径
- * @property {string[]} files glob文件名称数组
- */
- |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
-| File | -- | Statements | -- | Branches | -- | Functions | -- | Lines | -- |
|---|---|---|---|---|---|---|---|---|---|
| config.js | -
-
- |
- 100% | -5/5 | -100% | -0/0 | -100% | -0/0 | -100% | -5/5 | -
| getFilesPath.js | -
-
- |
- 100% | -10/10 | -100% | -4/4 | -100% | -3/3 | -100% | -10/10 | -
| jsdocRender.js | -
-
- |
- 100% | -3/3 | -100% | -0/0 | -100% | -1/1 | -100% | -3/3 | -
| renderCode.js | -
-
- |
- 100% | -1/1 | -100% | -0/0 | -100% | -0/0 | -100% | -1/1 | -
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
-| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 | - - - - -1x - - - - - - - - -5x - - -1x - - - - - - - | /*
- * @Author: 锦阳
- * @Create: 2021年04月22日
- */
-
-const doc = require('jsdoc-to-markdown');
-/**
- * 渲染jsdoc文档
- *
- * @param {Jsdoc2mdOptions} options jsdocToMarkdown配置参数
- * @returns {Promise<string>} 异步返回jsdoc文档文本
- * @ignore
- */
-function jsdocRender(options) {
- return doc.render(options);
-}
-
-module.exports = jsdocRender;
-
-/**
- * jsdocToMarkdown配置参数，具体可[👉参考文档](https://github.com/jsdoc2md/jsdoc-to-markdown/blob/master/docs/API.md)
- *
- * @typedef {object} Jsdoc2mdOptions
- */
- |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
-| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -1x - | /*
- * @Author: 锦阳
- * @Create: 2021年05月31日
- */
-/* istanbul ignore next */
-/**
- * 将codes渲染成md代码片段
- *
- * @param {Array<import('../index.js').GetFilesCodeResult>} codes `GenDoc.getFilesCode`函数获取到的codes数组
- * @param {string[]} [extSort= ['md', 'vue', 'jsx', 'js']] 优先并且按照`extSort`数组顺序获取遍历codes
- * @param {Object<string,string>} [extTrans={vue:'html'}] ext转换的映射map
- * 简单示例`{vue:'html'}`
- * @returns {string}
- * @alias GenDoc.renderCode
- */
-function renderCode(codes, extSort = ['md', 'vue', 'jsx', 'js'], extTrans = { vue: 'html' }) {
- let result = '';
- codes && codes.forEach((item) => {
- extSort.concat(Object.keys(item).filter(ext => !extSort.includes(ext))).forEach((ext) => {
- const code = item[ext];
- if (code) {
- code.forEach(c => {
- if (ext === 'md') {
- result += c + '\n';
- } else {
- const _ext = extTrans[ext] || ext;
- result += `\`\`\`${_ext}\n` + c + '\n```\n';
- }
- });
- }
- });
- });
- return result;
-}
-
-module.exports = renderCode;
- |