{"_id":"@chrp/typedoc-plugin-lerna-packages","_rev":"2-a4b195162c23db30f8f0b1eaeb3a1160","name":"@chrp/typedoc-plugin-lerna-packages","dist-tags":{"latest":"0.4.1"},"versions":{"0.4.0":{"name":"@chrp/typedoc-plugin-lerna-packages","version":"0.4.0","description":"Display Typescript documentation for Lerna monorepo with the correct module exports.","main":"dist/index.js","scripts":{"build":"tsc","prepare":"tsc"},"keywords":["typedocplugin","typedoc","lerna"],"repository":{"type":"git","url":"git+https://github.com/christophehurpeau/typedoc-plugin-lerna-packages.git"},"author":{"name":"Marc J. Schmidt","email":"marc@marcjschmidt.de"},"license":"MIT","peerDependencies":{"typedoc":"^0.17.0 || ^0.19.0 || ^0.19.0"},"devDependencies":{"@types/glob":"^7.1.1","@types/node":"^13.1.8","typedoc":"^0.17.0","typescript":"^3.8.3"},"gitHead":"2923777ed87b35c800f87782e3ee901b9c006d1d","bugs":{"url":"https://github.com/christophehurpeau/typedoc-plugin-lerna-packages/issues"},"homepage":"https://github.com/christophehurpeau/typedoc-plugin-lerna-packages#readme","_id":"@chrp/typedoc-plugin-lerna-packages@0.4.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-v7iklMxx8MK3c/RhDw3o4T0GyL+KJ/xgyvPi3tcVaD1ZHWWwvVUfCjLLRg2FlsnUQJlX+2YKpRsD3ptiW+twBA==","shasum":"a3871fc3bacafb59226b72c5227e282b5e0dcbd1","tarball":"https://registry.npmjs.org/@chrp/typedoc-plugin-lerna-packages/-/typedoc-plugin-lerna-packages-0.4.0.tgz","fileCount":7,"unpackedSize":26208,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfsS8eCRA9TVsSAnZWagAAwU8P+QBt/Vc5Q+125kM9e39W\nvHmCmts23bWixvHC5AQPPF1LNJJF70g0KrD38hQg73UneXL3aMcz1A4x4XEq\nS3FiLC2xl1fSANfGkm9oSu28Q+kvE1CoGiGtR+vnWCbDGXS4TuVgCgNs0U35\nh8zEEIQJlTx6EXmDs60wHrWk23wtrB8+QEmYWqNVi123kwCwB/uytRYf30TT\ncFHPC/y8DxB/3Ocy6hXP575OBRdp58UVHzGqABQcVftzNJxaNOgpCq4GZH4B\n2K7ZiBaquaJWxvsIotcIvP+kIUxXVQdbn547eDYkLb9aFvLtkRaBQ3EqMHaF\n24YhY0A+3uiZDa5EvYq09nZiaKNGh0sfvVn42rKGmKiN+BlnIKpNl6BFQO0x\nae5MuTr/A0BQY2yhNdbqATAPnl/fHvpVnNPJN1l0yCAVL33CO0we2iBvLeFq\nCd/GEtbs4Vtkpz6+TVkrdXeYPsT6DvbuCipRuMQzPe7whDZ180CvThdTMfsW\nHmwWHVTJO7mmx2d15WBN3QUVuY67KT4GKQFH3TZM9uD0LpkXsqZqO8pcugJb\nZwp1+7nVpkEUZqkuLN1PwmRZXoGYiLeTPITDdCLuCf7MNoAoliDrjeoLoKLS\nzpDmXKz+Z9DxfpB5snJFCZtPVMuq/dS0l+v50U0GVX07IGfCufAQXkS3NYCo\nGwhh\r\n=lU9s\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCYCIPbj7yAsCpghYIKYgJBSSGTtq6UMS5aHrJllhtF/gIgLjF9Ddy1lna6U0IbpcHzVqnNSkeTsu8Rzvby8vOFBlA="}]},"_npmUser":{"name":"churpeau","email":"christophe@hurpeau.com"},"directories":{},"maintainers":[{"name":"churpeau","email":"christophe@hurpeau.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/typedoc-plugin-lerna-packages_0.4.0_1605447453710_0.8606384206867623"},"_hasShrinkwrap":false},"0.4.1":{"name":"@chrp/typedoc-plugin-lerna-packages","version":"0.4.1","description":"Display Typescript documentation for Lerna monorepo with the correct module exports.","main":"dist/index.js","scripts":{"build":"tsc","prepare":"tsc"},"keywords":["typedocplugin","typedoc","lerna"],"repository":{"type":"git","url":"git+https://github.com/christophehurpeau/typedoc-plugin-lerna-packages.git"},"author":{"name":"Marc J. Schmidt","email":"marc@marcjschmidt.de"},"license":"MIT","dependencies":{"glob":"^7.1.6"},"peerDependencies":{"typedoc":"^0.17.0 || ^0.19.0 || ^0.19.0"},"devDependencies":{"@types/glob":"^7.1.1","@types/node":"^13.1.8","typedoc":"^0.17.0","typescript":"^3.8.3"},"gitHead":"6c0fca4cc6a94393ac698a8493ff2f445b147d75","bugs":{"url":"https://github.com/christophehurpeau/typedoc-plugin-lerna-packages/issues"},"homepage":"https://github.com/christophehurpeau/typedoc-plugin-lerna-packages#readme","_id":"@chrp/typedoc-plugin-lerna-packages@0.4.1","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-vNdmMPeAS12ZpIGxQcG8r6EPyC6PtcJWS49fwqZQbRDyOiFg+3LKbkAPt4F1KSVnobY0EPE5GHO3NLC6DPd+Iw==","shasum":"2caa71c60b09e2474e10d0d3f127c0336eceee7c","tarball":"https://registry.npmjs.org/@chrp/typedoc-plugin-lerna-packages/-/typedoc-plugin-lerna-packages-0.4.1.tgz","fileCount":7,"unpackedSize":26254,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfsTExCRA9TVsSAnZWagAAwW8QAJnz6WmZ+CVbW5ZDovmb\nY1RWTdtu6dB25uwsvJxCpKvU6e0GDAaIlQf9zZxdTN/lkRu08Q7pddScjkiu\nc7pusMZ4v+Qei2F3sdSWL/HYtfcxd8CbKMcVmNCTSjxE4ObAXeQfvd+erlb2\n6bufrhl2WK6jGCWFgPQiCP5TBIHuuEtZ2C9R6tBEentVi6yzSX7P9zJ1M1YF\n9gC1LbRZ5sTG0dQtt4jRGZ+jT351yNHPUW/8ERILGlozP4MzKBcMkslZtqcg\n/QZ9M1OaCp4Vy03cd5UU+zO81n6P6COxqraQJAELXguCA9OWwt5aUR6V9Zap\nLgGubL9c2cg7OMS+grCYm6otSwtskTrzs07lSi+Dg6SCL3V5XK2WFaKRss3P\nNJO0PEBWpPfNQ7aTxOUNenXh8lCOoTJPQhq3sa7S+uLavWp4iVLreeS55lM+\nUftL35ji5cDIns2t8W4xJ4gJ64XnsEl71xe2n7Z8+HQu4yymxF4shu2+hQys\nPek4C4ISn3W7Y8jsvOFI4J7o6k5THm7rB8aLVfhC25bwEJXMG9hD0akz2BUN\nzUf/09xWoGu4d7Iem76v7AzyTHFC2AI6NDDlikJWchzbf3GM5UAyLSL2ipE6\nsXfX3hz9uCWjgdQ1Fg+G5ecW4GX21SJU2X1wzV7dkqIjFjyQFUoEc2vCg/wN\ntX8J\r\n=kDzO\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICF6sEqGArFYiiID96zM336vZrb6E5oL++QLBnukJhJsAiB24sD949OV9UumMd5fqN6g/VItgoqxgeqKHb+/JjFzuw=="}]},"_npmUser":{"name":"churpeau","email":"christophe@hurpeau.com"},"directories":{},"maintainers":[{"name":"churpeau","email":"christophe@hurpeau.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/typedoc-plugin-lerna-packages_0.4.1_1605447985461_0.48113315046681704"},"_hasShrinkwrap":false}},"time":{"created":"2020-11-15T13:37:33.625Z","0.4.0":"2020-11-15T13:37:33.841Z","modified":"2022-04-04T22:56:24.593Z","0.4.1":"2020-11-15T13:46:25.563Z"},"maintainers":[{"name":"churpeau","email":"christophe@hurpeau.com"}],"description":"Display Typescript documentation for Lerna monorepo with the correct module exports.","homepage":"https://github.com/christophehurpeau/typedoc-plugin-lerna-packages#readme","keywords":["typedocplugin","typedoc","lerna"],"repository":{"type":"git","url":"git+https://github.com/christophehurpeau/typedoc-plugin-lerna-packages.git"},"author":{"name":"Marc J. Schmidt","email":"marc@marcjschmidt.de"},"bugs":{"url":"https://github.com/christophehurpeau/typedoc-plugin-lerna-packages/issues"},"license":"MIT","readme":"## @chrp/typedoc-plugin-lerna-packages\n\nFork of [typedoc-plugin-lerna-packages](https://github.com/marcj/typedoc-plugin-lerna-packages)\n\nA plugin for [Typedoc](http://typedoc.org) that groups all Lerna packages\ninto own TS module. Normally Typedoc handles each file as a module, this\nisn't correct for lerna packages, as each package should be treated as\na module. This plugins handles that. Also if you have a README.md in your\npackage folder, it will be used as comment for that module.\n\nExample Demo: https://marshal.marcj.dev/\n\nExample source code: https://github.com/marcj/marshal.ts\n\nJust install it and type `typedoc`:\n\n```bash\nnpm i -D typedoc-plugin-lerna-packages typedoc\n# yarn add -D typedoc-plugin-lerna-packages typedoc\n\nnpx typedoc\n# yarn typedoc\n```\n\nExample `typedoc.js` in your root folder\n\n```js\nmodule.exports = {\n  mode: \"modules\",\n  out: \"docs\",\n  exclude: [\"**/node_modules/**\", \"**/*.spec.ts\"],\n  name: \"MY NAME\",\n  excludePrivate: true,\n};\n```\n\n## Options\n\nIn `typedoc.js` you can add following extra config values to change the behavior of this plugin.\n\n```js\nmodule.exports = {\n  //...\n\n  //exclude packages from being generated\n  lernaExclude: [\"@vendor/integration-tests\", \"@vendor/examples\"],\n};\n```\n\n### Development\n\nWhen you work on this package you should link to it in a other lerna repo,\nand then execute following command to make generation working:\n\n```\nrm -rf docs && NODE_PRESERVE_SYMLINKS=1 ./node_modules/.bin/typedoc\n```\n","readmeFilename":"README.md"}