diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000000000000000000000000000000000000..587ec21bb0fd822de5de5cdec2b9f64104f9b6b1 Binary files /dev/null and b/.DS_Store differ diff --git a/.czrc b/.czrc new file mode 100644 index 0000000000000000000000000000000000000000..20230f8ea30e9e828ef5b8207cc1075abb26c8f1 --- /dev/null +++ b/.czrc @@ -0,0 +1,3 @@ +{ + "path": "cz-conventional-changelog-zh" +} \ No newline at end of file diff --git a/.eslintrc.js b/.eslintrc.js index 3885f63656989546463e90361149a44dd7e111b6..0a8459ff7cf4b4c4d0af2a9d2280ce656ebedc7c 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -1,26 +1,5 @@ module.exports = { - env: { - commonjs: true, - es2021: true, - node: true, - }, extends: [ - 'standard', + '@agds/js', ], - parser: '@babel/eslint-parser', - parserOptions: { - ecmaVersion: 12, - babelOptions: { - configFile: './babel.config.js', - }, - }, - rules: { - indent: ['error', 4, { SwitchCase: 1 }], - semi: ['error', 'always'], - 'comma-dangle': ['error', 'always-multiline'], - 'space-before-function-paren': [ - 'error', - { anonymous: 'always', named: 'never', asyncArrow: 'always' }, - ], - }, }; diff --git a/.gitignore b/.gitignore index 46f10721dedd489081e6fc7128532cf285a94302..617d58dcdbb6b8f5d968947d7469b52faadbb2ef 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,5 @@ lib/ -node_modules/ \ No newline at end of file +node_modules/ +.temp/ +exa/ +coverage/ \ No newline at end of file diff --git a/.npmrc b/.npmrc new file mode 100644 index 0000000000000000000000000000000000000000..77155769ccb5a029fc5bc38eb7d9664eaa8d8188 --- /dev/null +++ b/.npmrc @@ -0,0 +1 @@ +package-lock = false \ No newline at end of file diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 0000000000000000000000000000000000000000..b9e765d771806c409cfbff853a87d2f7899bc9d7 --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,17 @@ +{ + // 使用 IntelliSense 了解相关属性。 + // 悬停以查看现有属性的描述。 + // 欲了解更多信息,请访问: https://go.microsoft.com/fwlink/?linkid=830387 + "version": "0.2.0", + "configurations": [ + { + "type": "node", + "request": "launch", + "name": "启动程序", + "skipFiles": [ + "/**" + ], + "program": "${workspaceFolder}/src" + } + ] +} \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000000000000000000000000000000000000..5986d10ef4154b234173a7d749b86358e00e949f --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,53 @@ +## [1.0.9](https://gitee.com/agile-development-system/cli-plugin-doc/compare/v1.0.8...v1.0.9) (2021-06-16) + + +### Bug Fixes + +* 修复构建错误问题 ([0ec45cb](https://gitee.com/agile-development-system/cli-plugin-doc/commits/0ec45cb921d15dbe17367e07ab724ebfffa8e5d8)) + + + +## [1.0.8](https://gitee.com/agile-development-system/cli-plugin-doc/compare/v1.0.7...v1.0.8) (2021-06-09) + + +### Bug Fixes + +* 修复defaultConifg字段错误 ([98f3982](https://gitee.com/agile-development-system/cli-plugin-doc/commits/98f3982d01279b84ad10a7e00e7e3a4e7a066c46)) + + + +## [1.0.7](https://gitee.com/agile-development-system/cli-plugin-doc/compare/v1.0.6...v1.0.7) (2021-06-09) + + +### Features + +* getFileContent ([989337a](https://gitee.com/agile-development-system/cli-plugin-doc/commits/989337aea04b985a5e5e9ad6cf8f1332ccc23bfd)) + + + +## [1.0.6](https://gitee.com/agile-development-system/cli-plugin-doc/compare/v1.0.5...v1.0.6) (2021-05-31) + + + +## [1.0.5](https://gitee.com/agile-development-system/cli-plugin-doc/compare/v1.0.4...v1.0.5) (2021-05-31) + + + +## [1.0.4](https://gitee.com/agile-development-system/cli-plugin-doc/compare/d6d8c301d0b6722d71e2f4f9a2eb99c855928467...v1.0.4) (2021-05-31) + + +### Bug Fixes + +* 功能完善 ([6fdce4f](https://gitee.com/agile-development-system/cli-plugin-doc/commits/6fdce4f7b6748743b522242f0d96a24ba87bc8fb)) + + +### Features + +* command完成 ([e2c8a06](https://gitee.com/agile-development-system/cli-plugin-doc/commits/e2c8a06218b5ed5fefbe34b6882ef99a220ac6a1)) +* jest ([b5435e7](https://gitee.com/agile-development-system/cli-plugin-doc/commits/b5435e7a9a69c6dbd52bdbce8eb9450927ddcaab)) +* 初步完成node api ([d6d8c30](https://gitee.com/agile-development-system/cli-plugin-doc/commits/d6d8c301d0b6722d71e2f4f9a2eb99c855928467)) +* 配置实现完善 ([73366aa](https://gitee.com/agile-development-system/cli-plugin-doc/commits/73366aae5f4c256ae5720addf25b2d2d798f8051)) +* 默认配置修改 ([172f948](https://gitee.com/agile-development-system/cli-plugin-doc/commits/172f9481ff91da2f72f5a829eef8d6ef4b08a9bf)) + + + diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..af4abae152b13538313c99ad63aa02d1ec0f5de5 --- /dev/null +++ b/README.md @@ -0,0 +1,455 @@ +# @agds/cli-plugin-doc + +**版本** :1.0.9 + +通用注释转markdown文档生成器,目标是支持所有类型的文件 + +## 快速开始 + +### 安装 + +```bash +npm i -D @agds/cli-plugin-doc +``` + +### 命令行使用文档 + + +``` +Usage: agds-doc [options] + +agds系统doc文档生成器 + +Options: + jsdoc入口文件glob格式路径描述(需要用引号包裹避免解析失败),相对于cwd目录 + -o,--output doc文档渲染导出的文件名称路径,相对于cwd目录 + -c,--config 配置文件路径,相对于cwd目录,仅支持js文件类型 (default: + "agds.doc.config.js") + -t,--template