{"_id":"typescript-doc-gen","_rev":"28-22937105a0acf0537bf2800f929c0c75","time":{"1.0.0":"2021-07-26T03:21:32.739Z","1.0.1":"2021-07-26T03:21:32.739Z","1.0.10":"2021-07-26T03:21:32.739Z","1.0.10-0":"2021-07-26T03:21:32.739Z","1.0.11":"2021-07-26T03:21:32.739Z","1.0.11-0":"2021-07-26T03:21:32.739Z","1.0.12":"2021-07-26T03:21:32.739Z","1.0.12-0":"2021-07-26T03:21:32.739Z","1.0.13":"2021-07-26T03:21:32.739Z","1.0.13-0":"2021-07-26T03:21:32.739Z","1.0.14":"2021-07-26T03:21:32.739Z","1.0.14-0":"2021-07-26T03:21:32.739Z","1.0.15":"2021-07-26T03:21:32.739Z","1.0.15-0":"2021-07-26T03:21:32.739Z","1.0.2":"2021-07-26T03:21:32.739Z","1.0.3":"2021-07-26T03:21:32.739Z","1.0.4-0":"2021-07-26T03:21:32.739Z","1.0.5":"2021-07-26T03:21:32.739Z","1.0.6":"2021-07-26T03:21:32.739Z","1.0.6-0":"2021-07-26T03:21:32.739Z","1.0.7-0":"2021-07-26T03:21:32.739Z","1.0.8":"2021-07-26T03:21:32.739Z","1.0.8-0":"2021-07-26T03:21:32.739Z","1.0.9":"2021-07-26T03:21:32.739Z","1.0.9-0":"2021-07-26T03:21:32.739Z","created":"2021-07-28T09:58:00.620Z","1.0.16":"2021-07-28T09:58:00.898Z","modified":"2022-05-22T13:39:15.467Z"},"name":"typescript-doc-gen","dist-tags":{"latest":"1.0.16"},"versions":{"1.0.16":{"name":"typescript-doc-gen","version":"1.0.16","description":"一个快速将TSX interface转成Markdown的命令行工具","main":"dist/src/main.js","license":"MIT","engines":{"node":">=14"},"bin":{"doc-gen":"dist/src/cli.js","tsdg":"dist/src/cli.js"},"keywords":["Typescript","API","Markdown"],"scripts":{"gen":"node -r ts-node/register ./src/main.ts","dev":"ts-node-dev ./src/main.ts","format":"prettier --write markdown/*.{json,js,md,yml}","parse":"babel src -d dist -x .ts,.js","build":"tsc","copyPackageJson":"cp package.json dist/","copySample":"cp source/sample.tsx dist/","clean":"rm -rf dist/dist/","minifier":"uglifyjs dist/src/*.js -o dist/src/*.js --compress --mangle","prepublishOnly":"npm run build && npm run copyPackageJson && npm run copySample && npm run clean"},"dependencies":{"@babel/core":"7.14.8","@babel/generator":"7.14.8","@babel/parser":"7.14.8","@babel/plugin-proposal-class-properties":"7.14.5","@babel/plugin-proposal-decorators":"7.14.5","@babel/plugin-proposal-private-methods":"7.14.5","@babel/plugin-syntax-dynamic-import":"7.8.3","@babel/plugin-transform-modules-commonjs":"7.14.5","@babel/plugin-transform-runtime":"7.14.5","@babel/preset-env":"7.14.8","@babel/preset-react":"7.14.5","@babel/preset-typescript":"7.14.5","@babel/traverse":"7.14.8","chalk":"4.1.1","commander":"8.0.0","global":"^4.4.0","inquirer":"8.1.2","lodash.get":"4.4.2","npm-check-updates":"^11.8.3","prettier":"2.3.2"},"devDependencies":{"@types/babel__core":"7.1.15","@types/babel__generator":"7.6.3","@types/babel__preset-env":"7.9.2","@types/babel__traverse":"7.14.2","@types/inquirer":"7.3.3","@types/node":"16.4.1","@types/prettier":"2.3.2","ts-node":"10.1.0","ts-node-dev":"1.1.8","typescript":"4.3.5","uglify-js":"3.14.0"},"homepage":"https://github.com/Matthrews/typescript-doc-gen.git","bugs":{"url":"https://github.com/Matthrews/typescript-doc-gen/issues","email":"matthrews@outlook.com"},"author":{"name":"Oliver","email":"matthrews@outlook.com","url":"https://github.com/Matthrews/typescript-doc-gen"},"publishConfig":{"registry":"https://registry.npmjs.org/","access":"public"},"gitHead":"f2b93df0b169322c4dd77ce3c899def4bda743a3","_id":"typescript-doc-gen@1.0.16","_nodeVersion":"14.16.0","_npmVersion":"7.13.0","dist":{"integrity":"sha512-Pjs7JujnC4v6WzyOqJvSK163xvEPwBbyuumCbiRBk2LgeXGgiRlUxCQ0455yYMPONTPJq7Fw3vNiWGe+/7Kq0g==","shasum":"5b882d53daecde819c188a10402cab9ca5bf3bd5","tarball":"https://registry.npmjs.org/typescript-doc-gen/-/typescript-doc-gen-1.0.16.tgz","fileCount":11,"unpackedSize":21153,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhASooCRA9TVsSAnZWagAADtAP/1rHiCVHj4PEUh/KXH1h\n0NzkvLL+vqiRcG6J++xvSAHLVZdUJ79X0TMWXuyULeWKRb/GdpgdkqjQU6NW\nsnjRVo2aObvxa18DRLWxRAIOkdBHG08T/87sMf/LC2LfNR2lY2+xGl5rE14A\nEaDnvKnInk5JXHebyswQDwqke2+smaHV7zy97jw5EzIV+i3RUiWroP8feUq/\nCisMqLIbbldQBfnTO3qcqGsbwA3Wvcuebw/kJsshe9VNe3166PvEmCRuU6ZV\nuuLtVzE05GUZzpwEbki37iUPwfw0yd9bXQq6wBCV2fSTFgbzYuXUqN1/5+0j\n0mxYzn81DzDmOm6udaPeJkX8euigsBKz49KKg3qiedfPJNy6qlsRmmHCpBPJ\nvbB7EVMYgj7bZz4lfI665aH2N4mW7TPQ5VkaCimZH5isTgX60LZmpb7iYacL\nXssHN4526HPTN18AENjxt8nA2+7d+g7NOT/asAUwmJNUfeia3aVg3uob566i\nJSeE/rOuW3dE7R+k5xO/nWCwMYjTm1vJbTD2JWxrBlS79MvT7C/g+bSyROrB\nvsff5idWzCPmfqFh+Ay3b38Jta05hqciCHx4q8k8n/1eSvORHoQJOnxS0y2D\nU5x2pDK4dbRyYwcSIDr3TMfQbL3Bg68drtRpIPmrJf4QTWoLfrc8Z9J+/lpi\nWNiA\r\n=61bi\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICV6jGdzW3LWiYQJREFX4zhqEhTS9BXsdOENXNLKYFvLAiBnAHzwaxN+WqQYyGyCJ9y3JkjeO+BT3qiYYj7GM/sKpw=="}]},"_npmUser":{"name":"matthrew","email":"matthrews@outlook.com"},"directories":{},"maintainers":[{"name":"matthrew","email":"matthrews@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/typescript-doc-gen_1.0.16_1627466280699_0.9311366456313028"},"_hasShrinkwrap":false}},"maintainers":[{"name":"matthrew","email":"matthrews@outlook.com"}],"description":"一个快速将TSX interface转成Markdown的命令行工具","homepage":"https://github.com/Matthrews/typescript-doc-gen.git","keywords":["Typescript","API","Markdown"],"author":{"name":"Oliver","email":"matthrews@outlook.com","url":"https://github.com/Matthrews/typescript-doc-gen"},"bugs":{"url":"https://github.com/Matthrews/typescript-doc-gen/issues","email":"matthrews@outlook.com"},"license":"MIT","readme":"# typescript-doc-gen\r\n\r\n一个快速将 TSX interface 转成 Markdown 的命令行工具\r\n\r\n## 如何开始\r\n\r\n```bash\r\nnpm install -g typescript-doc-gen\r\ndoc-gen\r\n# 将`src\\\\Sample\\\\index.tsx`文件的interface提取出Markdown，默认保存到当前目录out下，注意在`.gitignore`文件里面添加out目录\r\ndoc-gen generate src\\\\Sample\\\\index.tsx\r\n\r\n# or 将`src\\\\Sample\\\\index.tsx`文件的interface提取出Markdown 并保存到桌面\r\ndoc-gen generate src\\\\Sample\\\\index.tsx D:\\\\Users\\\\admin\\\\Desktop\r\n```\r\n\r\n## 功能\r\n\r\n- 识别 interface\r\n- 识别 extends，将其内容转化为子表格\r\n- 识别自定义类型，将其转化为子表并内链\r\n\r\n## 来喷源码\r\n\r\n```bash\r\ngit clone git@gitlab.zmaxis.com:rongfu.zhu/typescript-doc-gen.git\r\ncd typescript-doc-gen\r\nyarn\r\nyarn gen\r\n```\r\n\r\n## 去喷竞品\r\n\r\n[api-hose](https://github.com/HerbertHe/api-hose)\r\n\r\n[react-docgen-typescript](https://www.npmjs.com/package/react-docgen-typescript)\r\n\r\n[Documentation](http://documentation.js.org/)\r\n","readmeFilename":"README.md"}