{"_id":"@agds/cli-plugin-doc","_rev":"11-6415262a9241f5c44768aa1b6a25cbef","name":"@agds/cli-plugin-doc","dist-tags":{"latest":"1.0.16","beta":"1.0.17"},"versions":{"1.0.0":{"name":"@agds/cli-plugin-doc","version":"1.0.0","description":"通用注释转markdown文档生成器,目标是支持所有类型的文件","bin":{"agds-doc":"lib/bin/doc.js"},"main":"lib","types":"lib/types","scripts":{"build":"gulp","test":"jest","docs":"node lib/bin/doc.js","postbuild":"npm run docs && git add . && git commit -m \"docs(readme): 更新文档\"","prebuild":"npm run test","lint":"eslint --ext .js,.vue,.json,.md src","lint:fix":"eslint --ext .js,.vue,.json,.md src --fix","commit":"git add . && git commit --no-edit","postversion":"npm run changelog","changelog":"conventional-changelog -p angular -i CHANGELOG.md -s -r 0","postchangelog":"git add . && git commit -m \"docs(changelog): 更新CHANGELOG\" || true"},"agds":{"config":"lib/agds.cli.config.js"},"gitHooks":{"pre-commit":"lint-staged","commit-msg":"commitlint -e $GIT_PARAMS","prepare-commit-msg":"agds-gc-has-msg && exec < /dev/tty && git cz --hook || true"},"lint-staged":{"**/*.{js,json,md}":["eslint  --fix"]},"repository":{"type":"git","url":"https://gitee.com/agile-development-system/cli-plugin-doc.git"},"keywords":["jsdoc","vuedoc","reactdoc","markdown","md"],"author":{"name":"junyang"},"license":"MIT","devDependencies":{"@agds/babel-preset-base":"^1.0.0","@agds/cli-plugin-doc":"^1.0.0","@agds/eslint-config-js":"^1.0.0","@agds/gulp-config-preset":"^1.0.0","@agds/jest-config-node":"^1.0.0","@agds/ts-config-js":"^1.0.0","@commitlint/cli":"^12.1.1","@commitlint/config-conventional":"^12.1.1","@types/ejs":"^3.0.6","@types/fs-extra":"^9.0.11","@types/jsdoc-to-markdown":"^7.0.0","@types/node":"^14.14.41","commitizen":"^4.2.3","conventional-changelog":"^3.1.24","conventional-changelog-cli":"^2.1.1","cz-conventional-changelog-zh":"^0.0.2","lint-staged":"^10.5.4","yorkie":"^2.0.0"},"dependencies":{"@agds/node-utils":"^1.0.0","commander":"^7.2.0","ejs":"^3.1.6","file-set":"^4.0.2","fs-extra":"^9.1.0","jsdoc-to-markdown":"^7.0.1","jsdoc-tsimport-plugin":"^1.0.5","lodash.merge":"^4.6.2","ora":"^5.4.0"},"gitHead":"351855c05b43e242fc206d3fde02a3d11750a04c","_id":"@agds/cli-plugin-doc@1.0.0","_nodeVersion":"12.16.2","_npmVersion":"7.11.1","dist":{"integrity":"sha512-QluWGYigQ7uSO2pVhPZPlBLeVo0ILuXgf66iEDR2bknVdejW1yO7GDOd8XqRDYbm9wOIXkYtmgfgp1XZrfs0hQ==","shasum":"d6a4d5db5401e1cd0825eb6637c3ea0b120affde","tarball":"https://registry.npmjs.org/@agds/cli-plugin-doc/-/cli-plugin-doc-1.0.0.tgz","fileCount":45,"unpackedSize":98614,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgyK2iCRA9TVsSAnZWagAA6QgP+QEQ9lxsX6RLm11nmRbG\nlUPLfauq2EQC/MTwGK5Esxqvl82G3/v00JPnBdtZJ6cHuShUmwiNMwizs4IM\nkt2Ti7e1nX3E5/Xkbi6aZtNhPyOuw2ghtHNtE3hBheyOac0PgYR2euIO1ZEB\nk120e3rXLPtlN7E7DdvA3X/sgSiokzevDes/bFwcj3k17+819Aepj3IykiL0\nq6Ml0mgip7rbl1wPpPvlC7sOrAyoVlnEzg+9bgfmDSTeB72lxiOLwZoSMrrI\niOvRl0Rlc8stSvhEF1QGqeoQqy0UO2+PpYa7HrgNBKhNSv7JbfTdZmC/jh+X\nZh52FYUcOtkrtwqGuHZqhP3YI8bALL7Ic76iwCAvk9GVBV1cFHhvQyqxkjsn\nfzsyusa/Yw4ZOsyI2r9Kxlhu+aBi5DELGO+s103WSoZE19wR5Z/VVTlXjAb3\neJ5mbyzuj2tlBozqe4qgSzqyoy1IRBNAFyFY6GmWnuns4qkZlRe3GMLKrDce\nlMluWkB0FV6/sKP9C7a4h4YSTlv1Ul/rTcNyFvM9cslbc0+zI5OzupXdQJO5\nFQehmohDuwDfMSwVEkV7a4deK6KSI4eQTQgZwKGtlJxwbYQ4xC+HaqL7wIux\n+Ig0+PA1N6oOmmiylILYDgjqAoMbwUxJmrUJeKxrvy0gbxJcA/KPOgqNhjis\nnAVQ\r\n=EB25\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCh8KJzikI69nqj1NN2aMKonmf5UC5G/LEtSLS8B3+rHwIhAIH9F+xwzfC5dTragUBEQsOpuPokl3Baas7u+NQu7ito"}]},"_npmUser":{"name":"chujunyang","email":"961284688@qq.com"},"directories":{},"maintainers":[{"name":"chujunyang","email":"961284688@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cli-plugin-doc_1.0.0_1623764386726_0.13083343312731066"},"_hasShrinkwrap":false},"1.0.1":{"name":"@agds/cli-plugin-doc","version":"1.0.1","description":"通用注释转markdown文档生成器,目标是支持所有类型的文件","bin":{"agds-doc":"lib/bin/doc.js"},"main":"lib","types":"lib/types","scripts":{"build":"gulp","test":"jest","docs":"node lib/bin/doc.js","postbuild":"npm run docs && git add . && git commit -m \"docs(readme): 更新文档\"","prebuild":"npm run test","lint":"eslint --ext .js,.vue,.json,.md src","lint:fix":"eslint --ext .js,.vue,.json,.md src --fix","commit":"git add . && git commit --no-edit","postversion":"npm run changelog","changelog":"conventional-changelog -p angular -i CHANGELOG.md -s -r 0","postchangelog":"git add . && git commit -m \"docs(changelog): 更新CHANGELOG\" || true"},"agds":{"config":"lib/agds.cli.config.js"},"gitHooks":{"pre-commit":"lint-staged","commit-msg":"commitlint -e $GIT_PARAMS","prepare-commit-msg":"agds-gc-has-msg && exec < /dev/tty && git cz --hook || true"},"lint-staged":{"**/*.{js,json,md}":["eslint  --fix"]},"repository":{"type":"git","url":"https://gitee.com/agile-development-system/cli-plugin-doc.git"},"keywords":["jsdoc","vuedoc","reactdoc","markdown","md"],"author":{"name":"junyang"},"license":"MIT","devDependencies":{"@agds/babel-preset-base":"^1.0.0","@agds/cli-plugin-doc":"^1.0.0","@agds/eslint-config-js":"^1.0.0","@agds/gulp-config-preset":"^1.0.0","@agds/jest-config-node":"^1.0.0","@agds/ts-config-js":"^1.0.0","@commitlint/cli":"^12.1.1","@commitlint/config-conventional":"^12.1.1","@types/ejs":"^3.0.6","@types/fs-extra":"^9.0.11","@types/jsdoc-to-markdown":"^7.0.0","@types/node":"^14.14.41","commitizen":"^4.2.3","conventional-changelog":"^3.1.24","conventional-changelog-cli":"^2.1.1","cz-conventional-changelog-zh":"^0.0.2","lint-staged":"^10.5.4","yorkie":"^2.0.0"},"dependencies":{"@agds/node-utils":"^1.0.1","commander":"^7.2.0","ejs":"^3.1.6","file-set":"^4.0.2","fs-extra":"^9.1.0","jsdoc-to-markdown":"^7.0.1","jsdoc-tsimport-plugin":"^1.0.5","lodash.merge":"^4.6.2","ora":"^5.4.0"},"gitHead":"351855c05b43e242fc206d3fde02a3d11750a04c","_id":"@agds/cli-plugin-doc@1.0.1","_nodeVersion":"12.16.2","_npmVersion":"7.11.1","dist":{"integrity":"sha512-qlCCDWDcl9osTv+sjTfIZOwkj2ryKaIQIKYsRGf3alkkAp5ICnL5LKf/dW5mcnY6Ns5GVhvvm5U9KTAFHudT0w==","shasum":"d1eb218ad08819086cd5be2056a5cc43e4439815","tarball":"https://registry.npmjs.org/@agds/cli-plugin-doc/-/cli-plugin-doc-1.0.1.tgz","fileCount":37,"unpackedSize":95542,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgyLY+CRA9TVsSAnZWagAAAdEP/3GnwJQ4g9rEpuJPyrkN\nMOZ5CvNn0rfBbid0yCibIM3wICL6+sskvLTenxkFcBeKcnCBuUFouAPoqnn2\nqVgmfvh8B+hDG7e2meE2JOlU24R6yWnBRuc9stx4+nsKxhFhjxx4pLryM1bz\nZafY9YBq0TLquJqTkrQBYB+Uq8lDJqVwXRHJ8w/xLq3rcmMLIEIWAiuwlXgm\n3ZVWdQde+2Emx3ZG/nT1Sa5Jok2CRdL9pGN2f58+VoCq+7mdXtKsjjvIlrhJ\nibIFjjfOb7+DDgg+6c4zPxdZ1BLwxh9fJ3KD6hMQQ6ToHnwZq91Xe0txkn+8\nRjgMSaYOrl1ED81pVcghnR3HDjdKIZAwAIZOT/uWgS7jDSN7ZyKkxAOOQL0X\nj0mNecQCg0D+O87WMYUTwvMaMzMmR2ivcu+uGcndT2CNhSOjiQn+hHZbzqGc\nMh9dFo/VDqUty/Monw4Ha1w7JgjDY6/WiHXH8zhqI3XB6ulobDRAypHkClIS\n6etQ2nLnrm475F+zJSkIoesWVcyviu8x7Ac/oSlt3VOYHQLzQ/h2eYj8ZqLI\nSBYaItc8rh830QwjNNsxkVlUVtbIWPMLZ0qofKgz9PR9GTPPPlRAhh/UgobH\nGXDPDZlH74JmfrhW5YNu3lf9QAagyoHaRsC93AOy4HLSsi8v/l7uaVBQb/tX\n9dir\r\n=JPg4\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDouwTnccTJvakpJuR8E/DVzTWSiaHkyxnI8xdyIK4BvwIhAKltN7k83OtVnXq4E0rJRtP+Uv4TYeDrueOtAR+i80uT"}]},"_npmUser":{"name":"chujunyang","email":"961284688@qq.com"},"directories":{},"maintainers":[{"name":"chujunyang","email":"961284688@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cli-plugin-doc_1.0.1_1623766590521_0.5272367436038194"},"_hasShrinkwrap":false},"1.0.2":{"name":"@agds/cli-plugin-doc","version":"1.0.2","description":"通用注释转markdown文档生成器,目标是支持所有类型的文件","bin":{"agds-doc":"lib/bin/doc.js"},"main":"lib","types":"lib/types","scripts":{"build":"gulp","test":"jest","docs":"node lib/bin/doc.js","postbuild":"npm run docs && git add . && git commit -m \"docs(readme): 更新文档\"","lint":"eslint --ext .js,.vue,.json,.md src","lint:fix":"eslint --ext .js,.vue,.json,.md src --fix","commit":"git add . && git commit --no-edit","postversion":"npm run changelog","changelog":"conventional-changelog -p angular -i CHANGELOG.md -s -r 0","postchangelog":"git add . && git commit -m \"docs(changelog): 更新CHANGELOG\" || true"},"agds":{"config":"lib/agds.cli.config.js"},"gitHooks":{"pre-commit":"lint-staged","commit-msg":"commitlint -e $GIT_PARAMS","prepare-commit-msg":"agds-gc-has-msg && exec < /dev/tty && git cz --hook || true"},"lint-staged":{"**/*.{js,json,md}":["eslint  --fix"]},"repository":{"type":"git","url":"https://gitee.com/agile-development-system/cli-plugin-doc.git"},"keywords":["jsdoc","vuedoc","reactdoc","markdown","md"],"author":{"name":"junyang"},"license":"MIT","devDependencies":{"@agds/babel-preset-base":"^1.0.0","@agds/cli-plugin-doc":"^1.0.0","@agds/eslint-config-js":"^1.0.0","@agds/gulp-config-preset":"^1.0.0","@agds/jest-config-node":"^1.0.0","@agds/ts-config-js":"^1.0.0","@commitlint/cli":"^12.1.1","@commitlint/config-conventional":"^12.1.1","@types/ejs":"^3.0.6","@types/fs-extra":"^9.0.11","@types/jsdoc-to-markdown":"^7.0.0","@types/node":"^14.14.41","commitizen":"^4.2.3","conventional-changelog":"^3.1.24","conventional-changelog-cli":"^2.1.1","cz-conventional-changelog-zh":"^0.0.2","lint-staged":"^10.5.4","yorkie":"^2.0.0"},"dependencies":{"@agds/node-utils":"^1.0.1","commander":"^7.2.0","ejs":"^3.1.6","file-set":"^4.0.2","fs-extra":"^9.1.0","jsdoc-to-markdown":"^7.0.1","jsdoc-tsimport-plugin":"^1.0.5","lodash.merge":"^4.6.2","ora":"^5.4.0"},"gitHead":"351855c05b43e242fc206d3fde02a3d11750a04c","_id":"@agds/cli-plugin-doc@1.0.2","_nodeVersion":"12.16.2","_npmVersion":"7.11.1","dist":{"integrity":"sha512-MtN1RVIG7xHZJY0VDyvrzZ+fO5CPB5cuCyfb3CCIUbwmUWJDDB+kYJV0B9Ei2YJ/K0xJRUwxISuOWv46I7i6ag==","shasum":"2f2d1e1b934b5e56cbdce4a43b60b951830d32ed","tarball":"https://registry.npmjs.org/@agds/cli-plugin-doc/-/cli-plugin-doc-1.0.2.tgz","fileCount":38,"unpackedSize":96809,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgyMJMCRA9TVsSAnZWagAAvh4P/ivrck/BVrQeRgLKsUI1\nC3NZefgCdXU3zkq4Z9WOuha2XcD/yADq5sIgMs7iltWxePJrIUGTB5LRBtUr\noEkCCDrcrqko1UrR3FGyMDTMtbnOzfb8CKqwRE/YsAD2+uGlH2kS/mnBWDLU\nB4doN66kU9Nnaz2ahWlo20TIunHfeb26at1L2j6hFkp8b8Z+e+ydTG1rPg7s\nP9ZKjA6u8y/iC4A50RsbQUrwuW/WQ2BU7ou/S7e9Ua8cN1j4rEPCYkXw3kcU\n/22PsdYUS2lBj57ULiIkHBfXT4w5ZswwS7W+eizTtu+HE3z1wB0QCi/bWZAO\nj57pwR9dynoYTrUguGdYFiW647cxwd0QIti2JPosLAtB2ES6u+21svE3sK+V\nHfynS1CZ5DkdZtsjHIXFKTjL9d3AiKJS5KG72+VCJnGh7qyUhPI4PBDybcH6\nKfgdj7bfcjc0YiRIbDh1VPWEPrpKVBmBOh/BbnkKkdYB4gULvNNTnEeCFw2W\ne67r3j20w9ki0wEQlwNIEktTRgXBZlam2iGG0jEr+Y0mungpxt7dlJnnJu0Z\n2FkV5eEYEoKQOfOobSBI0rAUHgQ0KfuHCDTU8G4MZyQWhxwKPJ0eJOpJ0r4y\nmMokkisJlKWRmPkFVX9bo69l5TBUOCm3U7jUM5YxdDPzrx2zMdUFNXXahk+h\ncK6R\r\n=8Kca\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDdt8MsEiZzwrbazg4Nd0Yilct6ds4V00FM7fhMtYUm4AiBIlH5WBQact8dxaOyXZkf5THyr8dUgHQCuLKpx6DaKyw=="}]},"_npmUser":{"name":"chujunyang","email":"961284688@qq.com"},"directories":{},"maintainers":[{"name":"chujunyang","email":"961284688@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cli-plugin-doc_1.0.2_1623769675806_0.6086689099817211"},"_hasShrinkwrap":false},"1.0.9":{"name":"@agds/cli-plugin-doc","version":"1.0.9","description":"通用注释转markdown文档生成器,目标是支持所有类型的文件","bin":{"agds-doc":"lib/bin/doc.js"},"main":"lib","types":"lib/types","scripts":{"build":"gulp","test":"jest","docs":"node lib/bin/doc.js","docs:postbuild":"npm run docs && (git add . && git commit -m \"docs(readme): 更新文档\" || true)","lint":"eslint --ext .js,.json,.md src","lint:fix":"eslint --ext .js,.json,.md src --fix","commit":"git add . && git commit --no-edit","postversion":"npm run changelog","prepublishOnly":"npm run test && npm run build && npm run docs:postbuild","changelog":"conventional-changelog -p angular -i CHANGELOG.md -s -r 0","postchangelog":"git add . && git commit -m \"docs(changelog): 更新CHANGELOG\" || true"},"agds":{"config":"lib/agds.cli.config.js"},"gitHooks":{"pre-commit":"lint-staged","commit-msg":"commitlint -e $GIT_PARAMS","prepare-commit-msg":"agds-gc-has-msg && exec < /dev/tty && git cz --hook || true"},"lint-staged":{"**/*.{js,json,md}":["eslint  --fix"]},"repository":{"type":"git","url":"https://gitee.com/agile-development-system/cli-plugin-doc.git"},"keywords":["jsdoc","vuedoc","reactdoc","markdown","md"],"author":{"name":"junyang"},"license":"MIT","devDependencies":{"@agds/babel-preset-base":"^1.0.0","@agds/cli-plugin-doc":"^1.0.0","@agds/eslint-config-js":"^1.0.0","@agds/gulp-config-preset":"^1.0.0","@agds/jest-config-node":"^1.0.0","@agds/ts-config-js":"^1.0.0","@commitlint/cli":"^12.1.1","@commitlint/config-conventional":"^12.1.1","@types/ejs":"^3.0.6","@types/fs-extra":"^9.0.11","@types/jsdoc-to-markdown":"^7.0.0","@types/node":"^14.14.41","commitizen":"^4.2.3","conventional-changelog":"^3.1.24","conventional-changelog-cli":"^2.1.1","cz-conventional-changelog-zh":"^0.0.2","lint-staged":"^10.5.4","yorkie":"^2.0.0"},"dependencies":{"@agds/node-utils":"^1.0.1","commander":"^7.2.0","ejs":"^3.1.6","file-set":"^4.0.2","fs-extra":"^9.1.0","jsdoc-to-markdown":"^7.0.1","jsdoc-tsimport-plugin":"^1.0.5","lodash.merge":"^4.6.2","ora":"^5.4.0"},"gitHead":"eb55fd977d2bfceb75d0c452699ee007375665ff","_id":"@agds/cli-plugin-doc@1.0.9","_nodeVersion":"12.16.2","_npmVersion":"7.11.1","dist":{"integrity":"sha512-24p3xgsmp7tM+XHcZ7QUdc/bQM/eEhnOYcimuWe4nUJ5ypApaG+lzMDOecpXQjLbr4TBNMPQAqLuJERwSXbztA==","shasum":"b8fbecc6a465f8a26f1bb45f25b73177b3c47a09","tarball":"https://registry.npmjs.org/@agds/cli-plugin-doc/-/cli-plugin-doc-1.0.9.tgz","fileCount":46,"unpackedSize":100944,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgyg+dCRA9TVsSAnZWagAAtRMP/3aKk5u6ddwKdBeFNTmK\n3FjG0pHTFo7lXs5wlisAWOxAv2nkVU5hxwiWQwVQKRHnIW31klptyttUYmjA\nA+Zk5ul2OR/NdAA9uBv8wABE2o04N4abFm+bprqmzCGHRqzq5sCno8BibEXZ\n4OIu3tqY989p5Ta7dDWqWV81jlf+C5He9CXv0g15m/SnAspKH1nEbdfLYo8u\ncPgrzXD1o/7xkz8BU0qRimtOEdP6y+HwbWDklDKsUc9KzkEofDqzW3I7sxdZ\nbds0/xJSDg5kcOZ2blnJC+yMb6tBgA6Gjo8WZIZhcJElnzAWkI107n9crejA\nKfBo572nBlVKs58QSxsvYeIVJ6W6YZJzT/YKWU3WdlT2hjZjglGjwiF3ctXS\npS8LcY+JzUQIXHm26d8tkzAigIfAmTE+lz9ox46UBpYJydPyfRQKhBrYxtbd\nqaCF6ll9WqZWmQDVspEyyjLD3RomqPQrF+5B2L11g2QGIUj3APkOkXR0nrh3\n2PKsqh65gIqhpEqwogvgUnpnQ7liWicgJOVeX1f+iftqVGfyVdeQ92zExLp/\n8sJVehDXEGp1Kk488aEzr1d56vrwRp76eA8Isvm53vezeMwOi+rfWp4WGorI\nArJvmU2Yq0HghsXPoaLUvcHqMkYt8Ui1GsNMwslf4Ib6zSv/YqiimSaXQLSR\nqH3X\r\n=j2Qh\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAe4mcE1OvT2BIHgKSIHEr6l/YPNaEgNlQilpfOKEHEHAiEAycskylscV9EJTARI3zyigA7Xbv30pIXa005hZJIDN4o="}]},"_npmUser":{"name":"chujunyang","email":"961284688@qq.com"},"directories":{},"maintainers":[{"name":"chujunyang","email":"961284688@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cli-plugin-doc_1.0.9_1623855004725_0.9406472101696386"},"_hasShrinkwrap":false},"1.0.10":{"name":"@agds/cli-plugin-doc","version":"1.0.10","description":"通用注释转markdown文档生成器,目标是支持所有类型的文件","bin":{"agds-doc":"lib/bin/doc.js"},"main":"lib","types":"lib/types","scripts":{"build":"gulp","test":"jest","docs":"node lib/bin/doc.js","docs:postbuild":"npm run docs && (git add . && git commit -m \"docs(readme): 更新文档\" || true)","lint":"eslint --ext .js,.json,.md src","lint:fix":"eslint --ext .js,.json,.md src --fix","commit":"git add . && git commit --no-edit","postversion":"npm run changelog","prepublishOnly":"npm run test && npm run build && npm run docs:postbuild","changelog":"conventional-changelog -p angular -i CHANGELOG.md -s -r 0","postchangelog":"git add . && git commit -m \"docs(changelog): 更新CHANGELOG\" || true"},"agds":{"config":"lib/agds.cli.config.js"},"gitHooks":{"pre-commit":"lint-staged","commit-msg":"commitlint -e $GIT_PARAMS","prepare-commit-msg":"agds-gc-has-msg && exec < /dev/tty && git cz --hook || true"},"lint-staged":{"**/*.{js,json,md}":["eslint  --fix"]},"repository":{"type":"git","url":"https://gitee.com/agile-development-system/cli-plugin-doc.git"},"keywords":["jsdoc","vuedoc","reactdoc","markdown","md"],"author":{"name":"junyang"},"license":"MIT","devDependencies":{"@agds/agds-doc-preset":"^1.0.5","@agds/babel-preset-base":"^1.0.0","@agds/cli-plugin-doc":"^1.0.0","@agds/eslint-config-js":"^1.0.0","@agds/gulp-config-preset":"^1.0.0","@agds/jest-config-node":"^1.0.0","@agds/ts-config-js":"^1.0.0","@commitlint/cli":"^12.1.1","@commitlint/config-conventional":"^12.1.1","@types/ejs":"^3.0.6","@types/fs-extra":"^9.0.11","@types/jsdoc-to-markdown":"^7.0.0","@types/node":"^14.14.41","commitizen":"^4.2.3","conventional-changelog":"^3.1.24","conventional-changelog-cli":"^2.1.1","cz-conventional-changelog-zh":"^0.0.2","lint-staged":"^10.5.4","yorkie":"^2.0.0"},"dependencies":{"@agds/node-utils":"^1.0.1","commander":"^7.2.0","ejs":"^3.1.6","file-set":"^4.0.2","fs-extra":"^9.1.0","jsdoc-to-markdown":"^7.0.1","jsdoc-tsimport-plugin":"^1.0.5","lodash.merge":"^4.6.2","ora":"^5.4.0"},"gitHead":"da0b94885752f8891e8d3abeb1a8dbffe993af84","_id":"@agds/cli-plugin-doc@1.0.10","_nodeVersion":"12.16.2","_npmVersion":"7.11.1","dist":{"integrity":"sha512-IKTiqmNBYgPuUjh/D9+/sK9LN0itbMpXCveJi61sEfZTMgyQT23GeNZqtcilYfmHjMIUPlQCuXSSOtnXk9G8sw==","shasum":"50a9587cf0f5ce9b2c6aba0369c7b1a2a4642159","tarball":"https://registry.npmjs.org/@agds/cli-plugin-doc/-/cli-plugin-doc-1.0.10.tgz","fileCount":47,"unpackedSize":105887,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg5chpCRA9TVsSAnZWagAAkH4P/iljRvFHlOsNKlG4ekzR\nvzwYjBRVo5CFq40+eUJSQ9JAtwf2fqkT4nJhyfz3SQNXjgT+Ht5ZiNt+fAPk\nEXx/dzijzyErNg3xWTAqOjOU9c1G/fc3efg+PkK9cjSGHyMEbIi3Pgc1TENB\nParYKX1qazxts5U7k9fV0/iNEgrLTERJCBSnkhT4uncZVk72PLVJVS/PU+5R\n5rcssBLdFRH1xdXI5TZCN0DyogQQ3hcQ9FcRO0zBQH73sAynXP5326QTdgcb\nRqAnHJaOI7TFDkRM4gd2vTKDYxVYlU0Pxb7WOsv+mifUjNEGDCE0WRf96MfH\na1jW4PbIA8xCceLpyE2TYNPAIZa2niPXmiotkYpLKxnX7cc3PrxZVfhEV806\nN9jMm4Tijl8I8qFxycdQzEDL68Vr6b7Iz1acJptn+Iysyl33Wi+SmjqGT4LM\nfrlZrNXIjSdDQKWObvKP/U8QH1Px10EIiNh9u7Y8+v5wf1psYS13cXVc2RLh\nw8KqAdc4HALnRtrRtpzGVHJQdv7WwpMUWhydmcf47ebj25682ZsPL4ZKut9k\nE/RW6zrQ65KJELOkvporBfnZ7XETgIUd7TipRR5GkxKVZYaxdTlvx80LUCkS\nA0M1md98Ku1Lf9n+C9xdCu53ZxCtIdTwS3Tc5c6JKNuqWXJsp4Poz0BTRpAb\nkcl+\r\n=7yoX\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDeYQ1WR8E4W8DGk2E6KLMKFcPLtDlrVQ5QCBKHN40KWQIgE23sC2btfUvoaqi9Gm3vu2kWM0odt5FdEMNfTtLDUi4="}]},"_npmUser":{"name":"chujunyang","email":"961284688@qq.com"},"directories":{},"maintainers":[{"name":"chujunyang","email":"961284688@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cli-plugin-doc_1.0.10_1625671784955_0.8167094851288206"},"_hasShrinkwrap":false},"1.0.12":{"name":"@agds/cli-plugin-doc","version":"1.0.12","description":"通用注释转markdown文档生成器,目标是支持所有类型的文件","bin":{"agds-doc":"lib/bin/doc.js"},"main":"lib","types":"lib/types","scripts":{"build":"gulp","test":"jest","docs":"node lib/bin/doc.js","docs:postbuild":"npm run docs && (git add . && git commit -m \"docs(readme): 更新文档\" || true)","lint":"eslint --ext .js,.json,.md src","lint:fix":"eslint --ext .js,.json,.md src --fix","commit":"git add . && git commit --no-edit","postversion":"npm run changelog","prepublishOnly":"npm run test && npm run build && npm run docs:postbuild","changelog":"conventional-changelog -p angular -i CHANGELOG.md -s -r 0","postchangelog":"git add . && git commit -m \"docs(changelog): 更新CHANGELOG\" || true"},"agds":{"config":"lib/agds.cli.config.js"},"gitHooks":{"pre-commit":"lint-staged","commit-msg":"commitlint -e $GIT_PARAMS","prepare-commit-msg":"agds-gc-has-msg && exec < /dev/tty && git cz --hook || true"},"lint-staged":{"**/*.{js,json,md}":["eslint  --fix"]},"repository":{"type":"git","url":"https://gitee.com/agile-development-system/cli-plugin-doc.git"},"keywords":["jsdoc","vuedoc","reactdoc","markdown","md"],"author":{"name":"junyang"},"license":"MIT","devDependencies":{"@agds/agds-doc-preset":"^1.0.6","@agds/babel-preset-base":"^1.0.0","@agds/cli-plugin-doc":"^1.0.10","@agds/eslint-config-js":"^1.0.0","@agds/gulp-config-preset":"^1.0.0","@agds/jest-config-node":"^1.0.0","@agds/ts-config-js":"^1.0.0","@commitlint/cli":"^12.1.1","@commitlint/config-conventional":"^12.1.1","@types/ejs":"^3.0.6","@types/fs-extra":"^9.0.11","@types/jsdoc-to-markdown":"^7.0.0","@types/node":"^14.14.41","commitizen":"^4.2.3","conventional-changelog":"^3.1.24","conventional-changelog-cli":"^2.1.1","cz-conventional-changelog-zh":"^0.0.2","lint-staged":"^10.5.4","yorkie":"^2.0.0"},"dependencies":{"@agds/node-utils":"^1.0.1","commander":"^7.2.0","ejs":"^3.1.6","file-set":"^4.0.2","fs-extra":"^9.1.0","jsdoc-advanced-types-plugin":"*","jsdoc-to-markdown":"^7.0.1","jsdoc-tsimport-plugin":"^1.0.5","jsdoc-typeof-plugin":"^1.0.0","lodash.merge":"^4.6.2","ora":"^5.4.0"},"publishConfig":{"access":"public"},"gitHead":"1464e6dbdbb34e8a4327c88c07b893901978e7ad","_id":"@agds/cli-plugin-doc@1.0.12","_nodeVersion":"12.16.2","_npmVersion":"7.11.1","dist":{"integrity":"sha512-Vd/TkdsPEkM/xxIFLF8xEnujkBLX1JKpSwIEBWFh9Y12Z0J8xEW8/gpnRH04RCUjuBh7fOSG/+YMti2DmzYg1g==","shasum":"f8602499e9d0b9599e77bd2a27db4d2679399487","tarball":"https://registry.npmjs.org/@agds/cli-plugin-doc/-/cli-plugin-doc-1.0.12.tgz","fileCount":49,"unpackedSize":107488,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg9X5+CRA9TVsSAnZWagAAygYP/2vZ9N8r27n5pCKoIyf3\nLMAsTBY2P8u0gRFUF/78rD2t3I0eLymx/e63yds1ZOXuNkAPOzab+8dI3KRs\nsIletn0sLGJcuLXzE3wUwrL4VmzC2a1GtUeW+TsvTLFVsNDvNLMxfyr4y0+G\nNbkPbN8WzTVmH0N8k1EimZrrtk0JfARUrHB/xAyoWnplqDKJE2OG/QZFgw0c\nCnKKmraFRshoouk0Gkx80As2FoRDWfwBiaxt1vIA0bAJ+PC89GkkmTQ/SAaB\n1G/BboeAjCMEjfixAfc4dDXAW9E2ZObCrJMy6Ugi8BaEnlz33omibA/x+3Kh\n7YyWzY95u2wR9miigCXjA6Mk/d8yXRQTXv73rkclQIgscAqZGF/wH8pqT1Fo\nI6OjO29v7w9MdgH+oE2+iJ3CilpD3uAeV7bEU/DBxWCnC+S121/oRyUsynMn\nyWF9enGK36171jJGm9u+x672bfpuS/hviJGZ8aYd+IPYpjUv466akszLquii\nbUGxy4W3GJkhHoEFt73swWeXRZrR7kXyLmMFzOnLpk0249BDDJBuTxtokiiV\nY8OU099JB7pA6h3SyeMgNTUX0BlwBS0irfw/Ax8oyj+O5PkYe88CyaZxSQH+\nSP51vrKDP1r3EhtFGMiR1GOv+Z1coLv5PKPnzzKOgrc9vlyC86Fuzyn31ns0\ngIaZ\r\n=30WY\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHiicrGcfMjzxsoPZkJHY172nepD19KAxyIo+QeVWgU6AiEApjeuGC5ApwEvFynm4GOPKXIYTGI8/DCgsTtZwqsPA+E="}]},"_npmUser":{"name":"chujunyang","email":"961284688@qq.com"},"directories":{},"maintainers":[{"name":"chujunyang","email":"961284688@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cli-plugin-doc_1.0.12_1626701438071_0.4952615991973097"},"_hasShrinkwrap":false},"1.0.13":{"name":"@agds/cli-plugin-doc","version":"1.0.13","description":"通用注释转markdown文档生成器,目标是支持所有类型的文件","bin":{"agds-doc":"lib/bin/doc.js"},"main":"lib","types":"lib/types","scripts":{"build":"gulp","test":"jest","docs":"node lib/bin/doc.js","docs:postbuild":"npm run docs && (git add . && git commit -m \"docs(readme): 更新文档\" || true)","lint":"eslint --ext .js,.json,.md src","lint:fix":"eslint --ext .js,.json,.md src --fix","commit":"git add . && git commit --no-edit","postversion":"npm run changelog","prepublishOnly":"npm run test && npm run build && npm run docs:postbuild","changelog":"conventional-changelog -p angular -i CHANGELOG.md -s -r 0","postchangelog":"git add . && git commit -m \"docs(changelog): 更新CHANGELOG\" || true"},"agds":{"config":"lib/agds.cli.config.js"},"gitHooks":{"pre-commit":"lint-staged","commit-msg":"commitlint -e $GIT_PARAMS","prepare-commit-msg":"agds-gc-has-msg && exec < /dev/tty && git cz --hook || true"},"lint-staged":{"**/*.{js,json,md}":["eslint  --fix"]},"repository":{"type":"git","url":"https://gitee.com/agile-development-system/cli-plugin-doc.git"},"keywords":["jsdoc","vuedoc","reactdoc","markdown","md"],"author":{"name":"junyang"},"license":"MIT","devDependencies":{"@agds/agds-doc-preset":"^1.0.6","@agds/babel-preset-base":"^1.0.0","@agds/cli-plugin-doc":"^1.0.10","@agds/eslint-config-js":"^1.0.0","@agds/gulp-config-preset":"^1.0.0","@agds/jest-config-node":"^1.0.0","@agds/ts-config-js":"^1.0.0","@commitlint/cli":"^12.1.1","@commitlint/config-conventional":"^12.1.1","@types/ejs":"^3.0.6","@types/fs-extra":"^9.0.11","@types/jsdoc-to-markdown":"^7.0.0","@types/node":"^14.14.41","commitizen":"^4.2.3","conventional-changelog":"^3.1.24","conventional-changelog-cli":"^2.1.1","cz-conventional-changelog-zh":"^0.0.2","lint-staged":"^10.5.4","yorkie":"^2.0.0"},"dependencies":{"@agds/node-utils":"^1.0.1","commander":"^7.2.0","ejs":"^3.1.6","file-set":"^4.0.2","fs-extra":"^9.1.0","jsdoc-to-markdown":"^7.0.1","jsdoc-tsimport-plugin":"^1.0.5","jsdoc-typeof-plugin":"^1.0.0","ora":"^5.4.0"},"publishConfig":{"access":"public"},"gitHead":"4c40b37a74ace0871f0aa9e642d691cf597378a9","_id":"@agds/cli-plugin-doc@1.0.13","_nodeVersion":"12.16.2","_npmVersion":"7.11.1","dist":{"integrity":"sha512-A8QbzPrLN/jXu5Wv955yOt1U/9V3az0bXu2WSxOs30auQU1laaIUcJLOHVQL7cRaYaOqGzDsEbWEykOkaJk25Q==","shasum":"e23314f495c874307874614c520eb2590809080d","tarball":"https://registry.npmjs.org/@agds/cli-plugin-doc/-/cli-plugin-doc-1.0.13.tgz","fileCount":54,"unpackedSize":119174,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg+CxLCRA9TVsSAnZWagAAw/MQAJwHmpSvSBMH3up0CiMg\nvSfAqRCszj6aSRnQ6ANex9R7veInMkFXpA80qPCvDfym5JO7OGi7avfPdXp/\n+GDjsrO3arLoC7TiPBj7WXPF1EET+rKsnBZKZlGMvM61FYk5QmHDtsgRKSTQ\nx19OeIq/RREo0fRNx/gLHFc6hRUnxMiTg5qmqiF+H1si1R6q/YZoz5qPMg44\nffZAbgjofSbubcDs5SVrgWmxAR7jskSKJ4rTUlKQyG4kZ/wczY2KIGQz8q7c\n7CjTsLfbpOGfJxv7tYvT0ymu4yfCE2DlLTOvd8ytqbvboQdBE5/CONpC0FdR\nKkuM90KBUhMnVPSVEGeL4x+o/vrCpbIvvdAM0N0GK1SLi9Bf7KgGLkV7s3Ll\nqR+TLk8gV0Moypdjkfj+UDDKLwZabctzrYgG5/TPN1+Af5WAREVRxlTZnk6g\nIKtDZztF+znWFsYskowlnuxa1Ut6nQ/eCtLLVCFiVSjLmEWXRMlfl14fSn8A\nMN2d6cE/TiXePnMaaVrC/8bf+dLk2/QuwaZNYD58Yd1lOOsXbuAB/3/abftV\nrB6MWemvRBIOT17JVMY/9reFBwk1Z7yuQvVyEPAOCgxrNjxmiz/JLRc24mnC\ndIMglWw69c6MZ/zU5cpY2CmN1xpr8qQK6dbzTcnz2/ELSgWNp+dnFa1zmykA\nJ5p0\r\n=5cXd\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDXVZYhluRZetQlNuvS1VsE2MVtCyKrmS7j82Pq4XKZvQIhAPpFAIV4GKnNdS+bJP2tE/unHtCne1M46++waGPHyfSE"}]},"_npmUser":{"name":"chujunyang","email":"961284688@qq.com"},"directories":{},"maintainers":[{"name":"chujunyang","email":"961284688@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cli-plugin-doc_1.0.13_1626877002902_0.9473524527835537"},"_hasShrinkwrap":false},"1.0.14":{"name":"@agds/cli-plugin-doc","version":"1.0.14","description":"通用注释转markdown文档生成器,目标是支持所有类型的文件","bin":{"agds-doc":"lib/bin/doc.js"},"main":"lib","types":"lib/types","scripts":{"build":"gulp","test":"jest","docs":"node lib/bin/doc.js","docs:postbuild":"npm run docs && (git add . && git commit -m \"docs(readme): 更新文档\" || true)","lint":"eslint --ext .js,.json,.md src","lint:fix":"eslint --ext .js,.json,.md src --fix","commit":"git add . && git commit --no-edit","postversion":"npm run changelog","prepublishOnly":"npm run test && npm run build && npm run docs:postbuild","changelog":"conventional-changelog -p angular -i CHANGELOG.md -s -r 0","postchangelog":"git add . && git commit -m \"docs(changelog): 更新CHANGELOG\" || true"},"agds":{"config":"lib/agds.cli.config.js"},"gitHooks":{"pre-commit":"lint-staged","commit-msg":"commitlint -e $GIT_PARAMS","prepare-commit-msg":"agds-gc-has-msg && exec < /dev/tty && git cz --hook || true"},"lint-staged":{"**/*.{js,json,md}":["eslint  --fix"]},"repository":{"type":"git","url":"https://gitee.com/agile-development-system/cli-plugin-doc.git"},"keywords":["jsdoc","vuedoc","reactdoc","markdown","md"],"author":{"name":"junyang"},"license":"MIT","devDependencies":{"@agds/agds-doc-preset":"^1.0.6","@agds/babel-preset-base":"^1.0.0","@agds/cli-plugin-doc":"^1.0.10","@agds/eslint-config-js":"^1.0.0","@agds/gulp-config-preset":"^1.0.0","@agds/jest-config-node":"^1.0.0","@agds/ts-config-js":"^1.0.0","@commitlint/cli":"^12.1.1","@commitlint/config-conventional":"^12.1.1","@types/ejs":"^3.0.6","@types/fs-extra":"^9.0.11","@types/jsdoc-to-markdown":"^7.0.0","@types/node":"^14.14.41","commitizen":"^4.2.3","conventional-changelog":"^3.1.24","conventional-changelog-cli":"^2.1.1","cz-conventional-changelog-zh":"^0.0.2","lint-staged":"^10.5.4","yorkie":"^2.0.0"},"dependencies":{"@agds/node-utils":"^1.0.1","commander":"^7.2.0","ejs":"^3.1.6","file-set":"^4.0.2","fs-extra":"^9.1.0","jsdoc-to-markdown":"^7.0.1","jsdoc-tsimport-plugin":"^1.0.5","jsdoc-typeof-plugin":"^1.0.0","ora":"^5.4.0"},"publishConfig":{"access":"public"},"gitHead":"5f019e7b61899bd1e4977a0deca302d76213a18d","_id":"@agds/cli-plugin-doc@1.0.14","_nodeVersion":"12.16.2","_npmVersion":"7.11.1","dist":{"integrity":"sha512-L8lY/mJtp8F+xXneNJ8RBbW3rlOQsj/hI2WMcyf2dzyCfgd1nx5rXfSl0kjwY/G8mdw6tu/uHlL/xJjlbXQSJw==","shasum":"b24d8a22435b67097865c770a53f56300ca919b6","tarball":"https://registry.npmjs.org/@agds/cli-plugin-doc/-/cli-plugin-doc-1.0.14.tgz","fileCount":54,"unpackedSize":108886,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIH+gEo5AZnAUlGSm+Im5zDIe+YpSL3m9zPW/T0ii5hxhAiAqB22wEAbsLFJtKj3FyXwaYLCasnlEWVyebywTr/N67A=="}]},"_npmUser":{"name":"chujunyang","email":"961284688@qq.com"},"directories":{},"maintainers":[{"name":"chujunyang","email":"961284688@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cli-plugin-doc_1.0.14_1634046398465_0.9561357436775959"},"_hasShrinkwrap":false},"1.0.15":{"name":"@agds/cli-plugin-doc","version":"1.0.15","description":"通用注释转markdown文档生成器,目标是支持所有类型的文件","bin":{"agds-doc":"lib/bin/doc.js"},"main":"lib","types":"lib/types","scripts":{"build":"gulp","test":"jest","docs":"node lib/bin/doc.js","docs:postbuild":"npm run docs && (git add . && git commit -m \"docs(readme): 更新文档\" || true)","lint":"eslint --ext .js,.json,.md src","lint:fix":"eslint --ext .js,.json,.md src --fix","commit":"git add . && git commit --no-edit","postversion":"npm run changelog","prepublishOnly":"npm run test && npm run build && npm run docs:postbuild","changelog":"conventional-changelog -p angular -i CHANGELOG.md -s -r 0","postchangelog":"git add . && git commit -m \"docs(changelog): 更新CHANGELOG\" || true"},"agds":{"config":"lib/agds.cli.config.js"},"gitHooks":{"pre-commit":"lint-staged","commit-msg":"commitlint -e $GIT_PARAMS","prepare-commit-msg":"agds-gc-has-msg && exec < /dev/tty && git cz --hook || true"},"lint-staged":{"**/*.{js,json,md}":["eslint  --fix"]},"repository":{"type":"git","url":"https://gitee.com/agile-development-system/cli-plugin-doc.git"},"keywords":["jsdoc","vuedoc","reactdoc","markdown","md"],"author":{"name":"junyang"},"license":"MIT","devDependencies":{"@agds/agds-doc-preset":"^1.0.6","@agds/babel-preset-base":"^1.0.0","@agds/cli-plugin-doc":"^1.0.10","@agds/eslint-config-js":"^1.0.0","@agds/gulp-config-preset":"^1.0.0","@agds/jest-config-node":"^1.0.0","@agds/ts-config-js":"^1.0.0","@commitlint/cli":"^12.1.1","@commitlint/config-conventional":"^12.1.1","@types/ejs":"^3.0.6","@types/fs-extra":"^9.0.11","@types/jsdoc-to-markdown":"^7.0.0","@types/node":"^14.14.41","commitizen":"^4.2.3","conventional-changelog":"^3.1.24","conventional-changelog-cli":"^2.1.1","cz-conventional-changelog-zh":"^0.0.2","lint-staged":"^10.5.4","yorkie":"^2.0.0"},"dependencies":{"@agds/node-utils":"^1.0.1","commander":"^7.2.0","ejs":"^3.1.6","file-set":"^4.0.2","fs-extra":"^9.1.0","jsdoc-to-markdown":"^7.0.1","jsdoc-tsimport-plugin":"^1.0.5","jsdoc-typeof-plugin":"^1.0.0","ora":"^5.4.0"},"publishConfig":{"access":"public"},"gitHead":"4fb6aa3f1ba0cfad8a272d56e581504803046491","_id":"@agds/cli-plugin-doc@1.0.15","_nodeVersion":"12.16.2","_npmVersion":"7.11.1","dist":{"integrity":"sha512-6xD/h6CKx8BlEiHMs9p5Buim0S4rw5Pw/+e2P00OwqQmEawjIyL0g+sVrhUootN1UmqDUz6quVPXivl3In6MjQ==","shasum":"242e015dcf368350904660e10d0dff822bc2ebaf","tarball":"https://registry.npmjs.org/@agds/cli-plugin-doc/-/cli-plugin-doc-1.0.15.tgz","fileCount":54,"unpackedSize":115682,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHlh4GiJKihDcOA90lKiPwZIvhQGHe6+46XWjedkT0pqAiBkl9PpSYWiOP2OZDtXV+3M/6GXjSqNY801YXmYr0kTKA=="}]},"_npmUser":{"name":"chujunyang","email":"961284688@qq.com"},"directories":{},"maintainers":[{"name":"chujunyang","email":"961284688@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cli-plugin-doc_1.0.15_1636558990225_0.018790501319862818"},"_hasShrinkwrap":false},"1.0.16":{"name":"@agds/cli-plugin-doc","version":"1.0.16","description":"agds系统doc文档生成器","bin":{"agds-doc":"lib/bin/doc.js"},"main":"lib","types":"lib/types","scripts":{"build":"gulp","test":"jest","docs":"node lib/bin/doc.js","docs:postbuild":"npm run docs && (git add . && git commit -m \"docs(readme): 更新文档\" || true)","lint":"eslint --ext .js,.json,.md src","lint:fix":"eslint --ext .js,.json,.md src --fix","commit":"git add . && git commit --no-edit","postversion":"npm run changelog","prepublishOnly":"npm run test && npm run build && npm run docs:postbuild","changelog":"conventional-changelog -p angular -i CHANGELOG.md -s -r 0","postchangelog":"git add . && git commit -m \"docs(changelog): 更新CHANGELOG\" || true"},"agds":{"config":"lib/agds.cli.config.js"},"gitHooks":{"pre-commit":"lint-staged","commit-msg":"commitlint -e $GIT_PARAMS","prepare-commit-msg":"agds-gc-has-msg && exec < /dev/tty && git cz --hook || true"},"lint-staged":{"**/*.{js,json,md}":["eslint  --fix"]},"repository":{"type":"git","url":"https://gitee.com/agile-development-system/cli-plugin-doc.git"},"keywords":["jsdoc","vuedoc","reactdoc","markdown","md"],"author":{"name":"junyang"},"license":"MIT","devDependencies":{"@agds/agds-doc-preset":"^1.0.6","@agds/babel-preset-base":"^1.0.0","@agds/cli-plugin-doc":"^1.0.10","@agds/eslint-config-js":"^1.0.0","@agds/gulp-config-preset":"^1.0.0","@agds/jest-config-node":"^1.0.0","@agds/ts-config-js":"^1.0.0","@commitlint/cli":"^12.1.1","@commitlint/config-conventional":"^12.1.1","@types/ejs":"^3.0.6","@types/fs-extra":"^9.0.11","@types/jsdoc-to-markdown":"^7.0.0","@types/node":"^14.14.41","commitizen":"^4.2.3","conventional-changelog":"^3.1.24","conventional-changelog-cli":"^2.1.1","cz-conventional-changelog-zh":"^0.0.2","lint-staged":"^10.5.4","yorkie":"^2.0.0"},"dependencies":{"@agds/node-utils":"^1.0.1","commander":"^7.2.0","ejs":"^3.1.6","file-set":"^4.0.2","fs-extra":"^9.1.0","jsdoc-to-markdown":"^7.0.1","jsdoc-tsimport-plugin":"^1.0.5","jsdoc-typeof-plugin":"^1.0.0","ora":"^5.4.0"},"publishConfig":{"access":"public"},"gitHead":"e353b765b77a2720aa4aa2e9d2ac0af299fbae8f","_id":"@agds/cli-plugin-doc@1.0.16","_nodeVersion":"12.16.2","_npmVersion":"7.11.1","dist":{"integrity":"sha512-Y20PGlgzo1xzkW5+EDGxFY1OY3UR/ur/Pf6yduIV6ZdicoXGZdBO4W9bnIzSBN1PFgEsex/1pQ60n6zLEED6fQ==","shasum":"2e35aa0f546bc4ee09dc70fd2fe441113a5cd5d3","tarball":"https://registry.npmjs.org/@agds/cli-plugin-doc/-/cli-plugin-doc-1.0.16.tgz","fileCount":57,"unpackedSize":133358,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhskInCRA9TVsSAnZWagAAxfsP/RE92YrHBh5MAHm6Cuws\nN2D7ieo78n55QcrGN7vtSl1hZsO4RFV47C9GrUdOTS6iuXXRfXsozzpO0RCx\n7+Ni9nDaXRIqHQEs1sUVR6hKR+m6p1EpUC7NV/90GBqR5h2BuO8haSqubNAL\nqKX423d5toKjng8jADaaLIqd7EwC8o8E/1RBc0yWhNejWCTKkL3r//oDoEZ9\nDB6nwgIxdDkn1jhSJixPWXIDP9S9IE4RUNJmrxZwVBbegPHI4ioD9xk+7ET4\nKC+QaG5baC2nMRppZAPBFQoaezQKf1W9IzGYXx7KXhiC9p99LYa3Yf49FPZh\nThBjOXwhc0dHluIPkQKwHFK13XrvLg0g+z92njJQzfd4XT3iIkWCjMf4QoGn\nsqiacqfGnTPvWfY8zXImNLeC8NVUx2wYM1Z8IYUpLozTwI0jNe6M0+/djScK\nvCg/qgpeS5r6+tIXYUxQ/Ir8wH+AVnvPGss3FexB4zu/RVTvfDc2PWb8F8+j\nNCL+cV8pNg0/byAa1gM5XfmBKWlGuSXIqWl+LHS+aciBQziAIVY81/iiiMpI\n88rFcRYtxgJFY0FE4z4EmEk9J2QFva4o68YWpmFDiKj6zlWxuDvtMM/MSbV0\nmk8eVXUpLGsidVyW0ViIjpvHJQc1Hp9tuoaD7mgKZSqk+nxG0m3RIqSiTkF3\nU3TI\r\n=QR3M\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCID3hHcKosgk+WS52cNGKdIZ9pCXVFjEBS8tAKv5g5Fr5AiEAvJDccur1ZQqNicYVvYH8I+O05+JdfbKJt3KFVOV74Gk="}]},"_npmUser":{"name":"chujunyang","email":"961284688@qq.com"},"directories":{},"maintainers":[{"name":"chujunyang","email":"961284688@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cli-plugin-doc_1.0.16_1639072295756_0.045633957159366245"},"_hasShrinkwrap":false},"1.0.17":{"name":"@agds/cli-plugin-doc","version":"1.0.17","description":"agds系统doc文档生成器","bin":{"agds-doc":"lib/bin/doc.js"},"main":"lib","types":"lib/types","scripts":{"build":"gulp","test":"jest","docs":"node lib/bin/doc.js","docs:postbuild":"npm run docs && (git add . && git commit -m \"docs(readme): 更新文档\" || true)","lint":"eslint --ext .js,.json,.md src","lint:fix":"eslint --ext .js,.json,.md src --fix","commit":"git add . && git commit --no-edit","postversion":"npm run changelog","prepublishOnly":"npm run build && npm run docs:postbuild","changelog":"conventional-changelog -p angular -i CHANGELOG.md -s -r 0","postchangelog":"git add . && git commit -m \"docs(changelog): 更新CHANGELOG\" || true"},"agds":{"config":"lib/agds.cli.config.js"},"gitHooks":{"pre-commit":"lint-staged&&npm run test","commit-msg":"commitlint -e $GIT_PARAMS","prepare-commit-msg":"agds-gc-has-msg && exec < /dev/tty && git cz --hook || true"},"lint-staged":{"**/*.{js,json,md}":["eslint  --fix"]},"repository":{"type":"git","url":"https://gitee.com/agile-development-system/cli-plugin-doc.git"},"keywords":["jsdoc","vuedoc","reactdoc","markdown","md"],"author":{"name":"junyang"},"license":"MIT","devDependencies":{"@agds/agds-doc-preset":"^1.0.6","@agds/babel-preset-base":"^1.0.0","@agds/cli-plugin-doc":"^1.0.10","@agds/eslint-config-js":"^1.0.0","@agds/gulp-config-preset":"^1.0.0","@agds/jest-config-node":"^1.0.0","@agds/ts-config-js":"^1.0.0","@commitlint/cli":"^12.1.1","@commitlint/config-conventional":"^12.1.1","commitizen":"^4.2.3","conventional-changelog":"^3.1.24","conventional-changelog-cli":"^2.1.1","cz-conventional-changelog-zh":"^0.0.2","lint-staged":"^10.5.4","yorkie":"^2.0.0"},"dependencies":{"@agds/node-utils":"^1.0.1","@types/ejs":"^3.0.6","@types/fs-extra":"^9.0.11","@types/jsdoc-to-markdown":"^7.0.0","@types/node":"^14.14.41","commander":"^7.2.0","ejs":"^3.1.6","file-set":"^4.0.2","fs-extra":"^9.1.0","jsdoc-to-markdown":"^7.0.1","jsdoc-tsimport-plugin":"^1.0.5","jsdoc-typeof-plugin":"^1.0.0","ora":"^5.4.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org"},"readme":"<p align=\"center\">\n    <img src=\"https://gitee.com/agile-development-system/agds-doc-preset/raw/master/lib/docs/logos/light/1.png\" alt=\"logo\">\n</p>\n\n# @agds/cli-plugin-doc\n\n**版本** ：1.0.17\n\nagds系统doc文档生成器\n\n## 快速开始\n\n### 安装\n\n```bash\nnpm i -D @agds/cli-plugin-doc\n```\n\n### 命令行使用文档\n\n```\nUsage: agds-doc [options] [files...]\n\nagds系统doc文档生成器\n\nArguments:\n  files                               jsdoc入口文件glob格式路径描述(需要用引号包裹避免解析失败)，相对于cwd目录\n\nOptions:\n  -o,--output <output>                doc文档渲染导出的文件名称路径，相对于cwd目录\n  -c,--config <config>                配置文件路径，相对于cwd目录，仅支持js文件类型 (default:\n                                      \"agds.doc.config.js\")\n  -t,--template <template>            ejs渲染的模板相对于cwd的路径或者绝对路径\n  --cd,--codes-dir <codesDir>         glob格式路径，代码演示示例的对应文件夹路径，路径需要到某个具体示例的对应文件夹\n  --cf,--codes-files <codesFiles...>  glob格式路径，相对于codesDir的代码演示文件夹的文件路径描述\n  --no-default                        禁止使用默认配置，默认配置相对比较通用，大部分情况不需要禁止，当默认配置和你的配置冲突时可以使用此选项\n  -v,--version                        查看版本号\n  -h, --help                          查看帮助信息\n\n注意：每个包含通配符的路径都需要用引号包裹，否则会被系统提前解析导致意料之外的错误\n\n文档查看：https://gitee.com/agile-development-system/cli-plugin-doc\n@agds/cli-plugin-doc@1.0.16 /Users/jinyang/code/ads/cli-plugin-doc/node_modules/@agds/cli-plugin-doc\n\n```\n\n### 配置文件\n\n默认为当前目录下的`agds.doc.config.js`，自动合并[默认配置](#defaultConfig)\n\n可以通过命令行参数`-c --config <config>`或者node api的`options.config` 来指定配置文件名称\n\n可以通过命令行参数`--no-default`或者node api的`options.default=false` 来禁止使用默认配置，默认配置相对比较通用，大部分情况不需要禁止，当默认配置和你的配置冲突时可以使用此选项\n\n配置文件导出类型为[👉`RenderOptions`](#RenderOptions),理论上支持所有的renderOption，由默认模板提供的`helpers`配置请看[👉默认模板支持的helpers](#DefaultHelpers)、[👉默认模板](#defaultTemplate)\n\n简单配置文件示例\n\n```js\n// agds.doc.config.js\nconst GenDoc = require('@agds/cli-plugin-doc');\n// 对象类型\nmodule.exports = GenDoc.configDeclare({\n    files: ['src/index.js'],\n    output: 'README.md',\n});\n\n// 异步函数\nmodule.exports = GenDoc.configDeclare(async () => {\n    const [template, cliUsages] = (await Promise.all([\n        GenDoc.getFilesCode({ dir: './src/template', files: ['*'] }),\n        GenDoc.getCliUsages(),\n    ]));\n    return {\n        files: ['src/index.js'],\n        output: 'README.md',\n        helpers: {\n            postfixes: [\n                {\n                    id: 'defaultTemplate',\n                    title: '默认文档渲染模板',\n                    content: GenDoc.renderCode(template),\n                },\n            ],\n            cliUsages,\n        },\n    };\n});\n```\n\n\n## 代码演示\n\n```js\n\nconst GenDoc = require('@agds/cli-plugin-doc');\n/**\n * render配置生成\n *\n * @param {object} [options={}] 选项\n * @param {boolean} [options.needDirError] 是否需要触发文件路径错误\n * @param {boolean} [options.noFiles] 是否需要去除files选项\n * @param {boolean} [options.noDefault] 是否取消default配置\n * @param {boolean} [options.noCodes] 是否去除codes相关配置\n * @returns {import('../../src/index').RenderOptions}\n */\nmodule.exports = ({ needDirError, noFiles, noDefault, noCodes } = {}) => {\n    return GenDoc.configDeclare(\n        async () => {\n            const [template, defaultConfig, cliUsages] = (await Promise.all([\n                GenDoc.getFilesCode({ dir: './src/template', files: ['*'] }),\n                GenDoc.getFilesCode({ dir: './src/utils', files: ['config.js'] }),\n                GenDoc.getCliUsages(),\n            ]));\n            return {\n                files: noFiles ? null : ['./src/**/*.js'],\n                ...(noCodes\n                    ? {}\n                    : {\n                        codesDir: needDirError ? './aaa' : './exa',\n                        codesFiles: ['*'],\n                    }\n                ),\n                config: './agds.doc.conf.js',\n                default: !noDefault,\n                jsdocEngineOptions: noDefault && {\n                    plugins: [\n                        require.resolve('jsdoc-tsimport-plugin'),\n                    ],\n                },\n                helpers: {\n                    template,\n                    defaultConfig,\n                    cliUsages,\n                },\n            };\n        },\n    );\n};\n```\n```js\nconst { expect, test } = require('@jest/globals');\nconst GenDoc = require('@agds/cli-plugin-doc');\nconst config = require('../__mock__/index');\nconst path = require('path');\ntest('GenDoc render', async () => {\n    const res = await GenDoc.render(await config());\n    expect(typeof res === 'string').toBe(true);\n});\n\ntest('GenDoc render output & use agds.doc.config.js', async () => {\n    const res = await GenDoc.render({\n        output: path.resolve(__dirname, '../../.temp/README.md'),\n    });\n    expect(typeof res === 'undefined').toBe(true);\n});\n\ntest('GenDoc render no files', async () => {\n    const res = await GenDoc.render(await config({ noFiles: true }));\n    expect(typeof res === 'string').toBe(true);\n});\n\ntest('GenDoc render no codes', async () => {\n    const res = await GenDoc.render(await config({ noCodes: true }));\n    expect(typeof res === 'string').toBe(true);\n});\n\ntest('GenDoc render error', async () => {\n    try {\n        await GenDoc.render(await config({ needDirError: true }));\n    } catch (error) {\n        expect(error.message).toMatch('未匹配到任何目录，请确认输入路径');\n    }\n});\n\ntest('GenDoc getRenderData nodefault', async () => {\n    const res = await GenDoc.getRenderData(await config({ noDefault: true }));\n    expect(typeof res === 'object').toBe(true);\n});\n\ntest('GenDoc getRenderData', async () => {\n    const res = await GenDoc.getRenderData(await config(), false);\n    expect(typeof res === 'object').toBe(true);\n});\n\ntest('GenDoc getFileContent', () => {\n    const res = GenDoc.getFileContent('./README.md');\n    expect(typeof res === 'string').toBe(true);\n});\n```\n\n## API文档\n\n<a name=\"GenDoc\"></a>\n\n### GenDoc\n\nGenDoc 基于注释和可运行的示例代码自动生成文档的强大工具类\n\n#### 引入\n\n```js\nconst GenDoc = require('@agds/cli-plugin-doc');\n```\n\n**性质**: 类\n\n<a name=\"GenDoc.render\"></a>\n\n#### GenDoc.render(options) ⇒ <code>Promise.&lt;string&gt;</code>\n\n基于ejs，用模板渲染文档\n\n**性质**: [<code>GenDoc</code>](#GenDoc)的静态方法\n**返回值**: <code>Promise.&lt;string&gt;</code> - 异步返回基于ejs模板渲染的文档文本\n\n| 参数 | 类型 | 描述 |\n| --- | --- | --- |\n| options | [<code>RenderOptions</code>](#GenDoc.renderRenderOptions) | 获取用来渲染模板的数据 |\n\n\n<a name=\"GenDoc.renderRenderOptions\"></a>\n\n##### RenderOptions : <code>object</code>\n\n渲染函数的配置参数\n\n**性质**: [<code>render</code>](#GenDoc.render)的类型声明\n\n**属性**\n\n| 属性 | 类型 | 默认值 | 描述 |\n| --- | --- | --- | --- |\n| files | <code>Array.&lt;string&gt;</code> |  | `jsdoc2mdOptions.files`的别名 |\n| output | <code>module:fs-extra~PathLike</code> |  | doc文档渲染导出的文件名称路径，相对于cwd目录 |\n| template | <code>string</code> |  | ejs渲染的模板相对于cwd的路径或者绝对路径 |\n| [codesDir] | <code>string</code> |  | `codesOptions.dir`的别名 |\n| [codesFiles] | <code>Array.&lt;string&gt;</code> |  | `codesOptions.codesFiles`的别名 |\n| [conifg] | <code>module:fs-extra~PathLike</code> | <code>agds.doc.config.js</code> | 配置文件路径，默认为运行目录下的`agds.doc.config.js`,仅支持`js`文件类型 |\n| [default] | <code>boolean</code> |  | 是否合并默认配置，一般我们认为您是需要默认配置的，当默认配置和你的需求冲突时可以设置为`false` |\n| [jsdoc2mdOptions] | [<code>Jsdoc2mdOptions</code>](#GenDoc.renderJsdoc2mdOptions) |  | jsdocToMarkdown配置参数 |\n| [codesOptions] | [<code>GetFilesCodeOptions</code>](#GenDoc.renderGetFilesCodeOptions) |  | 获取源代码的文件路径配置参数 |\n| [jsdocEngineOptions] | [<code>JsdocEngineOptions</code>](#GenDoc.renderJsdocEngineOptions) |  | jsdoc解析引擎的配置，实际上是`jsdoc.conf.js`的整合， 也可以使用  `RenderOptions.jsdoc2mdOptions.configure`字段来指定本地的jsdoc配置 配置选项[👉参考文档](https://jsdoc.app/about-configuring-jsdoc.html) |\n| [helpers] | [<code>DefaultHelpers</code>](#GenDoc.renderDefaultHelpers) |  | 注入ejs模板的`helpers`对象，提供模板使用的帮助函数和变量，配合模板使用 |\n| [presets] | [<code>Array.&lt;RenderOptions&gt;</code>](#GenDoc.renderRenderOptions) |  | 基于preset机制实现配置支持预设的功能， 具体[👉参考文档](https://gitee.com/agile-development-system/node-utils#presetutilsgetdeeppresetmergeconfig--config)`PresetUtils.getDeepPresetMerge` |\n| [modify] | <code>module:@agds/node-utils/lib/types/utils/PresetUtils~ConfigModify</code> |  | 将默认配置和preset合并后生成的config再次处理的钩子 具体[👉参考文档](https://gitee.com/agile-development-system/node-utils#presetutilsgetdeeppresetmergeconfig--config) |\n\n\n<a name=\"GenDoc.renderDefaultHelpers\"></a>\n\n##### DefaultHelpers : <code>Object</code>\n\n默认模板所支持的`helpers`属性\n\n**性质**: [<code>render</code>](#GenDoc.render)的类型声明\n\n**属性**\n\n| 属性 | 类型 | 描述 |\n| --- | --- | --- |\n| [installCode] | <code>string</code> | 安装脚本，bash脚本，默认为`npm i ${pkg.name}`，如不符合要求，可以通过此字段自行修改 |\n| [devInstall] | <code>boolean</code> | 是否是作为开发依赖下载，`true`时，默认下载代码自动拼接npm `-D` 参数 |\n| [importCode] | <code>string</code> | 引入代码示例，js字符串 |\n| [exportCode] | <code>string</code> | 导出代码，js字符串 |\n| [cliUsages] | <code>Array.&lt;string&gt;</code> | cli命令行使用帮助文档，格式类似`agds-doc -h`的输出内容 |\n| [remark] | <code>string</code> | 文档备注信息，md字符串 |\n| [renderCode] | [<code>renderCode</code>](#GenDoc.renderCode) | 将`GenDoc.getFileCodes`的返回值渲染成对应的代码段 |\n| [postfixes] | [<code>Array.&lt;Postfix&gt;</code>](#GenDoc.renderPostfix) | 后缀内容数组 |\n| [logo] | <code>string</code> | logo |\n| [bradges] | [<code>Array.&lt;Badge&gt;</code>](#GenDoc.renderBadge) | 徽标数组 |\n\n\n<a name=\"GenDoc.renderBadge\"></a>\n\n##### Badge : <code>Object</code>\n\n徽标对象\n\n**性质**: [<code>render</code>](#GenDoc.render)的类型声明\n\n**属性**\n\n| 属性 | 类型 | 描述 |\n| --- | --- | --- |\n| url | <code>string</code> | 图片链接 |\n| [name] | <code>string</code> | 图片名称 |\n| [link] | <code>string</code> | 跳转链接 |\n\n\n<a name=\"GenDoc.renderPostfix\"></a>\n\n##### Postfix : <code>Object</code>\n\n后缀内容类型\n\n**性质**: [<code>render</code>](#GenDoc.render)的类型声明\n\n**属性**\n\n| 属性 | 类型 | 描述 |\n| --- | --- | --- |\n| [id] | <code>string</code> | 锚点的名称，填写之后可以支持 `href=\"#${id}\"`锚点定位 |\n| [title] | <code>string</code> | 内容的标题 |\n| [desc] | <code>string</code> | 内容的描述 |\n| [content] | <code>string</code> | 内容的正文 |\n\n\n<a name=\"GenDoc.renderJsdocEngineOptions\"></a>\n\n##### JsdocEngineOptions : <code>Object</code>\n\njsdoc引擎配置[👉参考文档](https://jsdoc.app/about-configuring-jsdoc.html)\n\n**性质**: [<code>render</code>](#GenDoc.render)的类型声明\n\n**属性**\n\n| 属性 | 类型 | 默认值 | 描述 |\n| --- | --- | --- | --- |\n| plugins | <code>Array.&lt;string&gt;</code> |  | 插件路径数组(建议使用绝对路径) |\n| recurseDepth | <code>number</code> |  | 指定递归深度 |\n| source | <code>object</code> |  | 指定输入文件 |\n| source.include | <code>Array.&lt;string&gt;</code> |  | 路径数组，包含 JSDoc 应为其生成文档的文件 |\n| source.exclude | <code>Array.&lt;string&gt;</code> |  | JSDoc 应该忽略的可选路径数组 |\n| source.includePattern | <code>string</code> |  | 可选字符串，解释为正则表达式,如果存在，则所有文件名都必须与此正则表达式匹配才能由 JSDoc 处理 |\n| source.excludePattern | <code>string</code> |  | 可选字符串，解释为正则表达式。如果存在，任何匹配此正则表达式的文件都将被忽略。 |\n| [sourceType] | <code>&#x27;module&#x27;</code> \\| <code>&#x27;script&#x27;</code> | <code>&#x27;module&#x27;</code> | 指定源类型,会影响 JSDoc 解析 JavaScript 文件的方式 |\n| tags | <code>object</code> |  | 配置标签和标签字典,tags控制允许使用哪些 JSDoc 标签以及如何解释每个标签的选项。 |\n| [tags.allowUnknownTags] | <code>boolean</code> \\| <code>Array.&lt;string&gt;</code> | <code>true</code> | 影响 JSDoc 处理无法识别的标签的方式 |\n| [tags.dictionaries] | <code>Array.&lt;string&gt;</code> | <code>[&quot;jsdoc&quot;,&quot;closure&quot;]</code> | 控制 JSDoc 识别哪些标签，以及 JSDoc 如何解释它识别的标签。 |\n\n\n<a name=\"GenDoc.renderGetFilesCodeOptions\"></a>\n\n##### GetFilesCodeOptions : <code>object</code>\n\n获取源代码的文件路径配置参数\n\n**性质**: [<code>render</code>](#GenDoc.render)的类型声明\n\n**属性**\n\n| 属性 | 类型 | 描述 |\n| --- | --- | --- |\n| dir | <code>string</code> | glob路径 |\n| files | <code>Array.&lt;string&gt;</code> | glob文件名称数组 |\n\n\n<a name=\"GenDoc.renderJsdoc2mdOptions\"></a>\n\n##### Jsdoc2mdOptions : <code>module:jsdoc-to-markdown~JsdocOptions</code> \\| <code>module:jsdoc-to-markdown~RenderOptions</code> \\| [<code>DataModifySupport</code>](#GenDoc.renderDataModifySupport)\n\njsdocToMarkdown配置参数，具体可[👉参考文档](https://github.com/jsdoc2md/jsdoc-to-markdown/blob/master/docs/API.md)\n\n**性质**: [<code>render</code>](#GenDoc.render)的类型声明\n\n<a name=\"GenDoc.renderDataModifySupport\"></a>\n\n##### DataModifySupport : <code>object</code>\n\n在原有Jsdoc2mdOptions基础上扩展dataModify属性，支持修改templateData\n\n**性质**: [<code>render</code>](#GenDoc.render)的类型声明\n\n**属性**\n\n| 属性 | 类型 | 描述 |\n| --- | --- | --- |\n| dataModify | [<code>DataModify</code>](#GenDoc.renderDataModify) | 处理jsdoc Doclet对象数组的函数 |\n\n\n<a name=\"GenDoc.renderDataModify\"></a>\n\n##### DataModify ⇒ [<code>Array.&lt;Doclet&gt;</code>](#GenDoc.renderDoclet)\n\n**性质**: [<code>render</code>](#GenDoc.render)的类型声明\n\n| 参数 | 类型 |\n| --- | --- |\n| doclets | [<code>Array.&lt;Doclet&gt;</code>](#GenDoc.renderDoclet) | \n\n\n<a name=\"GenDoc.renderDoclet\"></a>\n\n##### Doclet : <code>object</code>\n\njsdoc Doclet对象\n\n**性质**: [<code>render</code>](#GenDoc.render)的类型声明\n\n**属性**\n\n| 属性 | 类型 |\n| --- | --- |\n| id | <code>string</code> | \n| longname | <code>string</code> | \n| name | <code>string</code> | \n| kind | <code>string</code> | \n| description | <code>string</code> | \n| order | <code>number</code> | \n| meta | <code>object</code> | \n| meta.lineno | <code>number</code> | \n| meta.filename | <code>string</code> | \n| meta.path | <code>string</code> | \n\n\n<a name=\"GenDoc.getRenderData\"></a>\n\n#### GenDoc.getRenderData(options, [needMergeConfig]) ⇒ [<code>Promise.&lt;GetRenderDataResult&gt;</code>](#GenDoc.getRenderDataGetRenderDataResult)\n\n获取用来渲染模板的数据（jsdoc生成的文档和示例代码的内容）\n\n**性质**: [<code>GenDoc</code>](#GenDoc)的静态方法\n\n| 参数 | 类型 | 默认值 | 描述 |\n| --- | --- | --- | --- |\n| options | [<code>RenderOptions</code>](#GenDoc.renderRenderOptions) |  | 配置参数 |\n| [needMergeConfig] | <code>boolean</code> | <code>true</code> | 是否需要调用`_mergeToDefaultConfig`， options已经是merge处理过的就不需要调用,否则不推荐传入`false` 会导致别名不支持 |\n\n\n<a name=\"GenDoc.getRenderDataGetRenderDataResult\"></a>\n\n##### GetRenderDataResult : <code>object</code>\n\n函数[GenDoc.getRenderData](#GenDoc.getRenderData)的返回值\n\n**性质**: [<code>getRenderData</code>](#GenDoc.getRenderData)的类型声明\n\n**属性**\n\n| 属性 | 类型 | 描述 |\n| --- | --- | --- |\n| docs | <code>string</code> | 源码使用jsdoc渲染后的markdown文本 |\n| codes | [<code>Array.&lt;GetFilesCodeResult&gt;</code>](#GenDoc.getFilesCodeGetFilesCodeResult) | 获取到的代码内容 |\n\n\n<a name=\"GenDoc.getFilesCode\"></a>\n\n#### GenDoc.getFilesCode(options) ⇒ <code>Promise.&lt;Array.&lt;GetFilesCodeResult&gt;&gt;</code>\n\n基于glob的文件遍历函数，返回文件对应内容的数组，\n以文件夹为单位返回文件内容对象，key是文件的extname\n\n**性质**: [<code>GenDoc</code>](#GenDoc)的静态方法\n\n| 参数 | 类型 | 描述 |\n| --- | --- | --- |\n| options | [<code>GetFilesCodeOptions</code>](#GenDoc.renderGetFilesCodeOptions) | 获取源代码的文件路径配置参数 |\n\n\n<a name=\"GenDoc.getFilesCodeGetFilesCodeResult\"></a>\n\n##### GetFilesCodeResult : <code>Object.&lt;string, string&gt;</code>\n\n获取文件的内容的返回值类型，key是文件的extname\n\n**性质**: [<code>getFilesCode</code>](#GenDoc.getFilesCode)的类型声明\n\n<a name=\"GenDoc.getCliUsages\"></a>\n\n#### GenDoc.getCliUsages() ⇒ <code>Promise.&lt;Array.&lt;string&gt;&gt;</code>\n\n获取命令行使用帮助文档\n建议提前确保全局使用了最新的脚本\n函数为异步函数，注意不能作为ejs帮助函数传入，可以获取返回值后，将返回值作为helpers的变量传入\n\n**性质**: [<code>GenDoc</code>](#GenDoc)的静态方法\n\n<a name=\"GenDoc.getFileContent\"></a>\n\n#### GenDoc.getFileContent(filename) ⇒ <code>string</code>\n\n读取文件内容\n\n**性质**: [<code>GenDoc</code>](#GenDoc)的静态方法\n\n| 参数 | 类型 | 描述 |\n| --- | --- | --- |\n| filename | <code>string</code> | 相对于运行目录的文件路径 |\n\n\n<a name=\"GenDoc.configDeclare\"></a>\n\n#### GenDoc.configDeclare(config) ⇒ [<code>RenderOptions</code>](#GenDoc.renderRenderOptions)\n\n辅助编写配置文件，优化类型显示\n\n**性质**: [<code>GenDoc</code>](#GenDoc)的静态方法\n\n| 参数 | 类型 | 描述 |\n| --- | --- | --- |\n| config | [<code>RenderOptions</code>](#GenDoc.renderRenderOptions) \\| [<code>RenderOptionsFn</code>](#GenDoc.configDeclareRenderOptionsFn) | 配置 |\n\n\n<a name=\"GenDoc.configDeclareRenderOptionsFn\"></a>\n\n##### RenderOptionsFn ⇒ [<code>RenderOptions</code>](#GenDoc.renderRenderOptions) \\| [<code>Promise.&lt;RenderOptions&gt;</code>](#GenDoc.renderRenderOptions)\n\n**性质**: [<code>configDeclare</code>](#GenDoc.configDeclare)的类型声明\n\n<a name=\"GenDoc.renderCode\"></a>\n\n#### GenDoc.renderCode(codes, [extSort], [extTrans]) ⇒ <code>string</code>\n\n将codes渲染成md代码片段\n\n**性质**: [<code>GenDoc</code>](#GenDoc)的静态方法\n\n| 参数 | 类型 | 默认值 | 描述 |\n| --- | --- | --- | --- |\n| codes | [<code>Array.&lt;GetFilesCodeResult&gt;</code>](#GenDoc.getFilesCodeGetFilesCodeResult) |  | `GenDoc.getFilesCode`函数获取到的codes数组 |\n| [extSort] | <code>Array.&lt;string&gt;</code> | <code>[&#x27;md&#x27;, &#x27;vue&#x27;, &#x27;jsx&#x27;, &#x27;js&#x27;]</code> | 优先并且按照`extSort`数组顺序获取遍历codes |\n| [extTrans] | <code>Object.&lt;string, string&gt;</code> | <code>{vue:&#x27;html&#x27;}</code> | ext转换的映射map 简单示例`{vue:'html'}` |\n\n\n\n<a name=\"defaultTemplate\"></a>\n\n## 默认文档渲染模板\n\n```ejs\n<%\nconst {docs, codes, helpers, pkg} = locals\n%><% if(helpers.logo) { %><p align=\"center\">\n    <img src=\"<%- helpers.logo %>\" alt=\"logo\">\n</p>\n\n<% } if(pkg.name){ %># <%- pkg.name %><% } %><% if (helpers.badges && helpers.badges.length > 0) { %>\n\n<%-\nhelpers.badges.map(item => {\n    let badge = `![${item.name}](${item.url})`;\n    if (item.link) {\n        badge = `[${badge}](${item.link})`;\n    }\n    return badge;\n}).join(' ');\n%><% } %><% if(pkg.version){ %>\n\n**版本** ：<%- pkg.version %><% } %><% if(pkg.description){ %>\n\n<%- pkg.description %><% } %><% if(pkg.name||helpers.importCode||helpers.exportCode) { %>\n\n## 快速开始\n<% } %><% if(pkg.name){ %>\n### 安装\n\n<%  %>```bash\n<%- helpers.installCode || 'npm i '+ (helpers.devInstall? '-D ' : '') + pkg.name %>\n<%  %>```\n<% } %><% if(helpers.importCode) { %>\n### 引入\n\n<%  %>```js\n<%- helpers.importCode %>\n<%  %>```\n<% } %><% if(helpers.exportCode) { %>\n### 导出\n\n<%  %>```js\n<%- helpers.exportCode %>\n<%  %>```\n<% } %><% if(helpers.cliUsages&&helpers.cliUsages.length) { %>\n### 命令行使用文档\n<% helpers.cliUsages.forEach(usage=>{ %>\n<%  %>```\n<%- usage %>\n<%  %>```<% }) %><% } %><% if(helpers.remark) { %>\n\n<%- helpers.remark %>\n<% } %><% if(codes&&codes.length) { %>\n## 代码演示\n\n<%-\n    helpers.renderCode\n        &&helpers.renderCode(codes)\n%><% } %><% if(docs) { %>\n## API文档\n<%- docs %><% } %><% if(helpers.postfixes&&helpers.postfixes.length) { // 后缀内容 %><% helpers.postfixes.forEach(postfix=>{ %>\n<% if(postfix.id) { %>\n<a name=\"<%- postfix.id %>\"></a><% } %><% if(postfix.title) { %>\n\n## <%- postfix.title %>\n<% } %><% if(postfix.desc) { %>\n> <%- postfix.desc %>\n<% } %><% if(postfix.content) { %>\n<%- postfix.content %><% }\n})\n} %>\n\n\n```\n\n\n<a name=\"defaultConfig\"></a>\n\n## 默认文档渲染配置\n\n> 当前`__dirname`为`@agds/cli-plugin-doc/lib/utils`\n\n```js\nconst path = require('path');\nconst defaultTemplate = path.resolve(__dirname, '../template/template.ejs');\nconst renderCode = require('./renderCode');\nconst defaultConfig = {\n    template: defaultTemplate,\n    jsdoc2mdOptions: {\n        // 'no-cache': true,\n        partial: [path.resolve(__dirname, '../dmdRewrite/partials/*.hbs')],\n        helper: [path.resolve(__dirname, '../dmdRewrite/helpers/*.js')],\n        'heading-depth': 3,\n        // 使用`@alias`标签时优化id的显示，以确保id的唯一性\n        dataModify: (doclets) => doclets.forEach((doclet) => {\n            if (doclet.alias && doclet.memberof) {\n                /* istanbul ignore next */\n                const accessSymbol = (doclet.scope === 'static' || doclet.scope === 'instance') ? '.' : doclet.scope === 'inner' ? '~' : '';\n                doclet.id = doclet.memberof + accessSymbol + doclet.name;\n            }\n        }),\n    },\n    // 默认`jsdocEngineOptions`配置一般只能增加无法删除，\n    // 但是可以在配置noDefault来去除默认配置\n    jsdocEngineOptions: {\n        plugins: [\n            require.resolve('jsdoc-tsimport-plugin'),\n            require.resolve('./jsdoc-plugin-arrowfn'),\n            require.resolve('jsdoc-typeof-plugin'),\n        ],\n    },\n    helpers: {\n        renderCode,\n    },\n};\n\nmodule.exports = defaultConfig;\n```\n\n\n<a name=\"license\"></a>\n\n## 许可证\n\n[MIT License](https://gitee.com/agile-development-system/cli-plugin-doc/blob/master/LICENSE)\nCopyright (c) 2021 锦阳\n\n<a name=\"donate\"></a>\n\n## 请维护者喝杯咖啡\n\n<div style=\"display:flex;\">\n<img src=\"https://gitee.com/agile-development-system/agds-doc-preset/raw/master/lib/docs/qrcode/alipay.jpeg\" width=\"209px\" >\n<img src=\"https://gitee.com/agile-development-system/agds-doc-preset/raw/master/lib/docs/qrcode/wechatpay.jpeg\" width=\"237px\" >\n</div>\n\n<a name=\"dingtalk\"></a>\n\n## 加入钉钉群讨论或加入开发\n\n<img src=\"https://gitee.com/agile-development-system/agds-doc-preset/raw/master/lib/docs/qrcode/dingtalk.jpeg\" width=\"188px\" >\n\n","readmeFilename":"README.md","gitHead":"3c0ec0a1ca8e6247974e2ab883c2cca4a792c119","_id":"@agds/cli-plugin-doc@1.0.17","_nodeVersion":"12.16.2","_npmVersion":"7.11.1","dist":{"integrity":"sha512-ZkIhcFVCkgdZWTZNRP256xLX/dgyTl6Alvi/lOtyNAulnEoIu/8iFUbtpuC+3rbh6G/82Qo837himf2rUUk3ew==","shasum":"f04f98caee051c314e52bdf5a7d964627bf8bfe6","tarball":"https://registry.npmjs.org/@agds/cli-plugin-doc/-/cli-plugin-doc-1.0.17.tgz","fileCount":57,"unpackedSize":142920,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh1abRCRA9TVsSAnZWagAAWGQP+gO4iVyl/tSmycL5NlMg\nKcwNFWmQ0eGWdHSFQs3Ou30chYVL9XaG5Mw7UsYhSoMCB/aShjzHCox9IN8P\n5p+VomIS6MEi2VsYLgE/D8ULqASNKsGPzy2F7d3IZqgxLdQwI7wmnhDuJnLC\n+taGEg3zHYxukP0SaJeR9rZnoAOPsSHV+Bi1brimnAy9x5CtcN6hsl70+RWU\nIDm9411Elu7jzayC5M+omgadRNa7AOkArwilLKnLl92uNXw1jvdrCYByo2CF\nGrWNbvtBGLA4VkBQeuJFkatfzCYSsxvuFXQtnhXz1dGNxik5ryuDNQvxIz5V\nIom89ijngPYoyMVrglwxHr9T7agbRFg3MCdZZzCY3gsf0PoYvRFfM+lwG9Bq\n6EdQo6eZOGGd0adgw7HpV9CFhGyxndI8fiMd/hBI9kZXihXkT2eexi48amD/\ny/bvi+KbGv0bX7DGk9Pzjl/yvAIve3UC3keSFelXI82FQFe3Sp0xzHgu1Zsg\nFkt2huiWMQyZ3r1zVvw7SmfmPGjYs6c6gybU5YckkbHuIrj9i7Li1K90FmwY\nAizQOOjaiHiXzRqgousF+7H0mxn3P9WsYw2D/pggdDOE9Acq4tOXgpOsNc+o\nx0pI2TAPSpK9txAHzyzIJF5bq5yq0Hoy/JtDc1N6qm2fG23D+VgiYmePUalD\nLzwS\r\n=NsCT\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDJDyCXNPMsd/HvQ/kihxUEjKG5faedWFPNJhoReut+CQIgVmlQCktnjuym1jMNqAYTbyqreHNGy9/tUCsddryn0Zw="}]},"_npmUser":{"name":"chujunyang","email":"961284688@qq.com"},"directories":{},"maintainers":[{"name":"chujunyang","email":"961284688@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cli-plugin-doc_1.0.17_1641391825186_0.9186621044776782"},"_hasShrinkwrap":false}},"time":{"created":"2021-06-15T13:39:46.359Z","1.0.0":"2021-06-15T13:39:46.923Z","modified":"2022-04-04T11:54:42.335Z","1.0.1":"2021-06-15T14:16:30.686Z","1.0.2":"2021-06-15T15:07:56.070Z","1.0.9":"2021-06-16T14:50:04.853Z","1.0.10":"2021-07-07T15:29:45.073Z","1.0.12":"2021-07-19T13:30:38.266Z","1.0.13":"2021-07-21T14:16:43.017Z","1.0.14":"2021-10-12T13:46:38.648Z","1.0.15":"2021-11-10T15:43:10.374Z","1.0.16":"2021-12-09T17:51:35.884Z","1.0.17":"2022-01-05T14:10:25.344Z"},"maintainers":[{"name":"chujunyang","email":"961284688@qq.com"}],"description":"agds系统doc文档生成器","keywords":["jsdoc","vuedoc","reactdoc","markdown","md"],"repository":{"type":"git","url":"https://gitee.com/agile-development-system/cli-plugin-doc.git"},"author":{"name":"junyang"},"license":"MIT","readme":"","readmeFilename":""}