{"_id":"@wc-toolkit/jsdoc-tags","_rev":"6-2c6ce77b26c5501718c3772c5a3eacb2","name":"@wc-toolkit/jsdoc-tags","dist-tags":{"latest":"1.2.1"},"versions":{"1.0.0":{"name":"@wc-toolkit/jsdoc-tags","version":"1.0.0","keywords":["custom-elements","custom-elements-manifest","web-components","components","cem"],"author":"","license":"MIT","_id":"@wc-toolkit/jsdoc-tags@1.0.0","maintainers":[{"name":"breakstuff","email":"burton@breakstuff.io"}],"homepage":"https://wc-toolkit.com/documentation/jsdoc-tags","bugs":{"url":"https://github.com/wc-toolkit/jsdoc-tags/issues"},"dist":{"shasum":"e2db3c0d33166d389bf46a42c0f057daec2ccba7","tarball":"https://registry.npmjs.org/@wc-toolkit/jsdoc-tags/-/jsdoc-tags-1.0.0.tgz","fileCount":7,"integrity":"sha512-2zT3pbTmy5uMrsmawiQvPp1N9fBlVcMkGMLVqeGYgxEv/AY60lHpwWsC5L+/myr0p58oY5YE4/m8rAsxwGzlIw==","signatures":[{"sig":"MEQCICJqTepITk/KisJFmg0S8Hmryw8aiJpFmHSd9biXbajyAiA3ico+LERo4GJ5eqJgTvaD9j/2KJR6VPnKlV4wjXei1Q==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":41226},"main":"./dist/index.cjs","type":"module","types":"./dist/index.d.ts","module":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.cjs"}},"gitHead":"2579764f1077d36bff37b55385acaaf89f0de9a7","scripts":{"lint":"eslint 'src/**/*.ts'","test":"vitest --run --passWithNoTests","build":"tsup src/index.ts --dts --format cjs,esm","clean":"git clean -fdX","deploy":"npm run build && npm publish","format":"prettier . --write","analyze":"npm run build && cem analyze --globs demo/src/**/*.js --outdir demo","prepare":"husky","release":"pnpm run build && changeset publish --access=public","lint:fix":"eslint 'src/**/*.ts' --fix","changeset":"changeset add"},"_npmUser":{"name":"breakstuff","email":"burton@breakstuff.io"},"repository":{"url":"git+https://github.com/wc-toolkit/jsdoc-tags.git","type":"git"},"_npmVersion":"10.9.1","description":"A set of tools for retrieving and transforming data from the Custom Elements Manifest","directories":{},"lint-staged":{"*.ts":"eslint --cache --fix","*.--write":"prettier --write"},"_nodeVersion":"23.3.0","_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.3.6","husky":"^9.1.7","eslint":"^9.19.0","vitest":"^3.0.4","prettier":"3.4.2","@eslint/js":"^9.19.0","typescript":"^5.7.3","comment-parser":"^1.4.1","@changesets/cli":"^2.27.12","typescript-eslint":"^8.21.0","eslint-config-prettier":"^10.0.1","custom-elements-manifest":"2.1.0","@wc-toolkit/cem-utilities":"^1.0.0","@custom-elements-manifest/analyzer":"^0.10.4"},"_npmOperationalInternal":{"tmp":"tmp/jsdoc-tags_1.0.0_1739371030732_0.4549547866135215","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"@wc-toolkit/jsdoc-tags","version":"1.0.2","keywords":["custom-elements","custom-elements-manifest","web-components","components","cem"],"author":"","license":"MIT","_id":"@wc-toolkit/jsdoc-tags@1.0.2","maintainers":[{"name":"breakstuff","email":"burton@breakstuff.io"}],"homepage":"https://wc-toolkit.com/documentation/jsdoc-tags","bugs":{"url":"https://github.com/wc-toolkit/jsdoc-tags/issues"},"dist":{"shasum":"1ee61d3ba288e78ca4fac0d4e15d19d6fe4fad9e","tarball":"https://registry.npmjs.org/@wc-toolkit/jsdoc-tags/-/jsdoc-tags-1.0.2.tgz","fileCount":7,"integrity":"sha512-9tHPOddyQNeWQqTiBdbpubMCBjC/Ak/FQ5Uk5tGK72skK/m1MM4Y5HxRAK0lOerTILh0faeKm+fBJQFjGJir/Q==","signatures":[{"sig":"MEUCIQDU/6mdm/RzoN9q5u01sZoSnz8siy5dcm/dXNOA1TVxHAIgHlgoTgYPhb27ChR9Iw0ar7PtP4uIn+5LT3zf0Oo4/Fw=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@wc-toolkit%2fjsdoc-tags@1.0.2","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":41443},"main":"./dist/index.cjs","type":"module","_from":"file:wc-toolkit-jsdoc-tags-1.0.2.tgz","types":"./dist/index.d.ts","module":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.cjs"}},"scripts":{"lint":"eslint 'src/**/*.ts'","test":"vitest --run --passWithNoTests","build":"tsup src/index.ts --dts --format cjs,esm","clean":"git clean -fdX","deploy":"npm run build && npm publish","format":"prettier . --write","analyze":"npm run build && cem analyze --globs demo/src/**/*.js --outdir demo","release":"pnpm run build && changeset publish --access=public","lint:fix":"eslint 'src/**/*.ts' --fix","changeset":"changeset add"},"_npmUser":{"name":"breakstuff","email":"burton@breakstuff.io"},"_resolved":"/tmp/a16f1537c8b87f826e8c73206575a101/wc-toolkit-jsdoc-tags-1.0.2.tgz","_integrity":"sha512-9tHPOddyQNeWQqTiBdbpubMCBjC/Ak/FQ5Uk5tGK72skK/m1MM4Y5HxRAK0lOerTILh0faeKm+fBJQFjGJir/Q==","repository":{"url":"git+https://github.com/wc-toolkit/jsdoc-tags.git","type":"git"},"_npmVersion":"10.8.2","description":"A set of tools for retrieving and transforming data from the Custom Elements Manifest","directories":{},"lint-staged":{"*.ts":"eslint --cache --fix","*.--write":"prettier --write"},"_nodeVersion":"20.18.2","publishConfig":{"access":"public","provenance":true},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.3.6","husky":"^9.1.7","eslint":"^9.19.0","vitest":"^3.0.4","prettier":"3.4.2","@eslint/js":"^9.19.0","typescript":"^5.7.3","comment-parser":"^1.4.1","@changesets/cli":"^2.27.12","typescript-eslint":"^8.21.0","eslint-config-prettier":"^10.0.1","custom-elements-manifest":"2.1.0","@wc-toolkit/cem-utilities":"^1.0.0","@custom-elements-manifest/analyzer":"^0.10.4"},"_npmOperationalInternal":{"tmp":"tmp/jsdoc-tags_1.0.2_1739412074628_0.1357895993418794","host":"s3://npm-registry-packages-npm-production"}},"1.0.3":{"name":"@wc-toolkit/jsdoc-tags","version":"1.0.3","keywords":["custom-elements","custom-elements-manifest","web-components","components","cem","jsdoc","@wc-toolkit/jsdoc-tags"],"author":"","license":"MIT","_id":"@wc-toolkit/jsdoc-tags@1.0.3","maintainers":[{"name":"breakstuff","email":"burton@breakstuff.io"}],"homepage":"https://wc-toolkit.com/documentation/jsdoc-tags","bugs":{"url":"https://github.com/wc-toolkit/jsdoc-tags/issues"},"dist":{"shasum":"fe99ac252442cae575e51302d73f15bcd45ed7e2","tarball":"https://registry.npmjs.org/@wc-toolkit/jsdoc-tags/-/jsdoc-tags-1.0.3.tgz","fileCount":7,"integrity":"sha512-nXJNuZ7HHHMEOhh43JRB404Rvdsq2Z6c17E+Y6hmh9WQC5ZL0jbVTr+9uoafwHotIWwHnQ2i7DsbGsmjQFo0YA==","signatures":[{"sig":"MEUCIA0FoYVCzPxivXXZkMv9RsEJX1A+zt+3NwqhG3dVUldCAiEAwlSsIY6MPXuwjKTAtfdVIgempOQZ2iU8FK9n9JeqJq4=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@wc-toolkit%2fjsdoc-tags@1.0.3","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":41483},"main":"./dist/index.cjs","type":"module","_from":"file:wc-toolkit-jsdoc-tags-1.0.3.tgz","types":"./dist/index.d.ts","module":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.cjs"}},"scripts":{"lint":"eslint 'src/**/*.ts'","test":"vitest --run --passWithNoTests","build":"tsup src/index.ts --dts --format cjs,esm","clean":"git clean -fdX","deploy":"npm run build && npm publish","format":"prettier . --write","analyze":"npm run build && cem analyze --globs demo/src/**/*.js --outdir demo","release":"pnpm run build && changeset publish --access=public","lint:fix":"eslint 'src/**/*.ts' --fix","changeset":"changeset add"},"_npmUser":{"name":"breakstuff","email":"burton@breakstuff.io"},"_resolved":"/tmp/0e432f2860923ea51398d0ba6edfcad5/wc-toolkit-jsdoc-tags-1.0.3.tgz","_integrity":"sha512-nXJNuZ7HHHMEOhh43JRB404Rvdsq2Z6c17E+Y6hmh9WQC5ZL0jbVTr+9uoafwHotIWwHnQ2i7DsbGsmjQFo0YA==","repository":{"url":"git+https://github.com/wc-toolkit/jsdoc-tags.git","type":"git"},"_npmVersion":"10.8.2","description":"A set of tools for retrieving and transforming data from the Custom Elements Manifest","directories":{},"lint-staged":{"*.ts":"eslint --cache --fix","*.--write":"prettier --write"},"_nodeVersion":"20.18.2","publishConfig":{"access":"public","provenance":true},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.3.6","husky":"^9.1.7","eslint":"^9.19.0","vitest":"^3.0.4","prettier":"3.4.2","@eslint/js":"^9.19.0","typescript":"^5.7.3","comment-parser":"^1.4.1","@changesets/cli":"^2.27.12","typescript-eslint":"^8.21.0","eslint-config-prettier":"^10.0.1","custom-elements-manifest":"2.1.0","@wc-toolkit/cem-utilities":"^1.0.0","@custom-elements-manifest/analyzer":"^0.10.4"},"_npmOperationalInternal":{"tmp":"tmp/jsdoc-tags_1.0.3_1739454294857_0.06622528078190792","host":"s3://npm-registry-packages-npm-production"}},"1.1.0":{"name":"@wc-toolkit/jsdoc-tags","version":"1.1.0","keywords":["custom-elements","custom-elements-manifest","web-components","components","cem","jsdoc","@wc-toolkit/jsdoc-tags"],"author":"","license":"MIT","_id":"@wc-toolkit/jsdoc-tags@1.1.0","maintainers":[{"name":"breakstuff","email":"burton@breakstuff.io"}],"homepage":"https://wc-toolkit.com/documentation/jsdoc-tags","bugs":{"url":"https://github.com/wc-toolkit/jsdoc-tags/issues"},"dist":{"shasum":"b2ff6ea7208057eaa8f451a27ec83764e446741d","tarball":"https://registry.npmjs.org/@wc-toolkit/jsdoc-tags/-/jsdoc-tags-1.1.0.tgz","fileCount":7,"integrity":"sha512-7MHpQ3FtRNJBJONMChkfIWxOWy1rvDtwOJJ4ubeGJBUEj2hp8Xy/9G8GqqNvPGzp38haAfdMcmwx6rySu4AAqg==","signatures":[{"sig":"MEQCIGC1dwgfzqd0CUwiGvBkk9ftn/EYX6/Va7eKKuiS4SOxAiB2T48yDS1bZvFn3f0I6NFgziYdqLy++GyCUsR9/wtOzQ==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@wc-toolkit%2fjsdoc-tags@1.1.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":41930},"main":"./dist/index.cjs","type":"module","_from":"file:wc-toolkit-jsdoc-tags-1.1.0.tgz","types":"./dist/index.d.ts","module":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.cjs"}},"scripts":{"lint":"eslint 'src/**/*.ts'","test":"npm run analyze && vitest --run --passWithNoTests","build":"tsup src/index.ts --dts --format cjs,esm","clean":"git clean -fdX","deploy":"npm run build && npm publish","format":"prettier . --write","analyze":"npm run build && cem analyze --globs demo/src/**/*.js --outdir demo","release":"pnpm run build && changeset publish --access=public","lint:fix":"eslint 'src/**/*.ts' --fix","changeset":"changeset add"},"_npmUser":{"name":"breakstuff","email":"burton@breakstuff.io"},"_resolved":"/tmp/424b979223c946083d2952c91a664e68/wc-toolkit-jsdoc-tags-1.1.0.tgz","_integrity":"sha512-7MHpQ3FtRNJBJONMChkfIWxOWy1rvDtwOJJ4ubeGJBUEj2hp8Xy/9G8GqqNvPGzp38haAfdMcmwx6rySu4AAqg==","repository":{"url":"git+https://github.com/wc-toolkit/jsdoc-tags.git","type":"git"},"_npmVersion":"10.8.2","description":"A set of tools for retrieving and transforming data from the Custom Elements Manifest","directories":{},"lint-staged":{"*.ts":"eslint --cache --fix","*.--write":"prettier --write"},"_nodeVersion":"20.18.2","publishConfig":{"access":"public","provenance":true},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.3.6","husky":"^9.1.7","eslint":"^9.19.0","vitest":"^3.0.4","prettier":"3.4.2","@eslint/js":"^9.19.0","typescript":"^5.7.3","comment-parser":"^1.4.1","@changesets/cli":"^2.27.12","typescript-eslint":"^8.21.0","eslint-config-prettier":"^10.0.1","custom-elements-manifest":"2.1.0","@wc-toolkit/cem-utilities":"^1.0.0","@custom-elements-manifest/analyzer":"^0.10.4"},"_npmOperationalInternal":{"tmp":"tmp/jsdoc-tags_1.1.0_1739925972047_0.7083701674302798","host":"s3://npm-registry-packages-npm-production"}},"1.2.0":{"name":"@wc-toolkit/jsdoc-tags","version":"1.2.0","keywords":["custom-elements","custom-elements-manifest","web-components","components","cem","jsdoc","@wc-toolkit/jsdoc-tags"],"author":"","license":"MIT","_id":"@wc-toolkit/jsdoc-tags@1.2.0","maintainers":[{"name":"breakstuff","email":"burton@breakstuff.io"}],"homepage":"https://wc-toolkit.com/documentation/jsdoc-tags","bugs":{"url":"https://github.com/wc-toolkit/jsdoc-tags/issues"},"dist":{"shasum":"8ab43a58e5c2931f12059ccac6f3fd7666245dbe","tarball":"https://registry.npmjs.org/@wc-toolkit/jsdoc-tags/-/jsdoc-tags-1.2.0.tgz","fileCount":7,"integrity":"sha512-GEWmv4UVqJXDTxHgR+qwgJdjouXYupIM0mVa62BLeSQQ9++ga9DtmJrbd/w7KAxKgrzUDUJ6TfNkBCqe5hnOCA==","signatures":[{"sig":"MEYCIQDuldsD82TiPYcRm9rTGInwtAkJz+lc6v7qleK0ZqkL0wIhAPiOA0PKXVDg3y+aqBpNB/NViJAkIkKuZtBtOmQZr9E2","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@wc-toolkit%2fjsdoc-tags@1.2.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":44915},"main":"./dist/index.cjs","type":"module","_from":"file:wc-toolkit-jsdoc-tags-1.2.0.tgz","types":"./dist/index.d.ts","module":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.cjs"}},"scripts":{"lint":"eslint 'src/**/*.ts'","test":"npm run analyze && vitest --run --passWithNoTests","build":"tsup src/index.ts --dts --format cjs,esm","clean":"git clean -fdX","deploy":"npm run build && npm publish","format":"prettier . --write","analyze":"npm run build && cem analyze --globs demo/src/**/*.js --outdir demo","release":"pnpm run build && changeset publish --access=public","lint:fix":"eslint 'src/**/*.ts' --fix","changeset":"changeset add"},"_npmUser":{"name":"breakstuff","email":"burton@breakstuff.io"},"_resolved":"/tmp/4312fa67d33b4f62a0c8602ac0b6b7a3/wc-toolkit-jsdoc-tags-1.2.0.tgz","_integrity":"sha512-GEWmv4UVqJXDTxHgR+qwgJdjouXYupIM0mVa62BLeSQQ9++ga9DtmJrbd/w7KAxKgrzUDUJ6TfNkBCqe5hnOCA==","repository":{"url":"git+https://github.com/wc-toolkit/jsdoc-tags.git","type":"git"},"_npmVersion":"10.8.2","description":"A set of tools for retrieving and transforming data from the Custom Elements Manifest","directories":{},"lint-staged":{"*.ts":"eslint --cache --fix","*.--write":"prettier --write"},"_nodeVersion":"20.20.2","publishConfig":{"access":"public","provenance":true},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.3.6","husky":"^9.1.7","eslint":"^9.19.0","vitest":"^3.0.4","prettier":"3.4.2","@eslint/js":"^9.19.0","typescript":"^5.7.3","comment-parser":"^1.4.1","@changesets/cli":"^2.27.12","typescript-eslint":"^8.21.0","eslint-config-prettier":"^10.0.1","custom-elements-manifest":"2.1.0","@wc-toolkit/cem-utilities":"^1.0.0","@custom-elements-manifest/analyzer":"^0.10.4"},"_npmOperationalInternal":{"tmp":"tmp/jsdoc-tags_1.2.0_1776171252594_0.18961326065159856","host":"s3://npm-registry-packages-npm-production"}},"1.2.1":{"name":"@wc-toolkit/jsdoc-tags","version":"1.2.1","description":"A set of tools for retrieving and transforming data from the Custom Elements Manifest","main":"./dist/index.cjs","module":"./dist/index.js","types":"./dist/index.d.ts","type":"module","exports":{".":{"types":"./dist/index.d.ts","require":"./dist/index.cjs","import":"./dist/index.js"}},"author":"","license":"MIT","repository":{"type":"git","url":"git+https://github.com/wc-toolkit/jsdoc-tags.git"},"bugs":{"url":"https://github.com/wc-toolkit/jsdoc-tags/issues"},"homepage":"https://wc-toolkit.com/documentation/jsdoc-tags","devDependencies":{"@changesets/cli":"^2.27.12","@custom-elements-manifest/analyzer":"^0.10.4","@eslint/js":"^9.19.0","@wc-toolkit/cem-utilities":"^1.0.0","comment-parser":"^1.4.1","custom-elements-manifest":"2.1.0","eslint":"^9.19.0","eslint-config-prettier":"^10.0.1","husky":"^9.1.7","prettier":"3.4.2","tsup":"^8.3.6","typescript":"^5.7.3","typescript-eslint":"^8.21.0","vitest":"^3.0.4"},"keywords":["custom-elements","custom-elements-manifest","web-components","components","cem","jsdoc","@wc-toolkit/jsdoc-tags"],"lint-staged":{"*.ts":"eslint --cache --fix","*.--write":"prettier --write"},"publishConfig":{"provenance":true,"access":"public"},"scripts":{"analyze":"npm run build && cem analyze --globs demo/src/**/*.js --outdir demo","changeset":"changeset add","build":"tsup src/index.ts --dts --format cjs,esm","clean":"git clean -fdX","deploy":"npm run build && npm publish","format":"prettier . --write","lint":"eslint 'src/**/*.ts'","lint:fix":"eslint 'src/**/*.ts' --fix","test":"npm run analyze && vitest --run --passWithNoTests","release":"pnpm run build && changeset publish --access=public"},"_id":"@wc-toolkit/jsdoc-tags@1.2.1","_integrity":"sha512-O58tdyiKcTiVCeacGBPZ2lulY7EoTbLay1YlmsXxTOU1UgPxTwGpi5USWXbkstr1HZgWmPjEiIVEyL+3ABBaAg==","_resolved":"/tmp/d3127e871e1c302e337da7d097525a88/wc-toolkit-jsdoc-tags-1.2.1.tgz","_from":"file:wc-toolkit-jsdoc-tags-1.2.1.tgz","_nodeVersion":"20.20.2","_npmVersion":"10.8.2","dist":{"integrity":"sha512-O58tdyiKcTiVCeacGBPZ2lulY7EoTbLay1YlmsXxTOU1UgPxTwGpi5USWXbkstr1HZgWmPjEiIVEyL+3ABBaAg==","shasum":"8c6bff74e97a76c5c6bb17fd22c3dfa8459ce46e","tarball":"https://registry.npmjs.org/@wc-toolkit/jsdoc-tags/-/jsdoc-tags-1.2.1.tgz","fileCount":7,"unpackedSize":45275,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@wc-toolkit%2fjsdoc-tags@1.2.1","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQCfNPIY3EGnWH7GQJPLXqbzmoefb2HXnC5TAfKl4ybZBwIhAPQGej4nOKIVSmax8RFRZU9zRboeBxPRrmQvPuTA9jTd"}]},"_npmUser":{"name":"breakstuff","email":"burton@breakstuff.io"},"directories":{},"maintainers":[{"name":"breakstuff","email":"burton@breakstuff.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/jsdoc-tags_1.2.1_1779190904015_0.8148863802931099"},"_hasShrinkwrap":false}},"time":{"created":"2025-02-12T14:37:10.604Z","modified":"2026-05-19T11:41:44.500Z","1.0.0":"2025-02-12T14:37:10.891Z","1.0.2":"2025-02-13T02:01:14.827Z","1.0.3":"2025-02-13T13:44:55.031Z","1.1.0":"2025-02-19T00:46:12.214Z","1.2.0":"2026-04-14T12:54:12.737Z","1.2.1":"2026-05-19T11:41:44.159Z"},"bugs":{"url":"https://github.com/wc-toolkit/jsdoc-tags/issues"},"license":"MIT","homepage":"https://wc-toolkit.com/documentation/jsdoc-tags","keywords":["custom-elements","custom-elements-manifest","web-components","components","cem","jsdoc","@wc-toolkit/jsdoc-tags"],"repository":{"type":"git","url":"git+https://github.com/wc-toolkit/jsdoc-tags.git"},"description":"A set of tools for retrieving and transforming data from the Custom Elements Manifest","maintainers":[{"name":"breakstuff","email":"burton@breakstuff.io"}],"readme":"<div align=\"center\">\n  \n![workbench with tools, html, css, javascript, and jsdoc logos](https://raw.githubusercontent.com/wc-toolkit/jsdoc-tags/refs/heads/main/assets/wc-toolkit_jsdoc.png)\n\n</div>\n\n# WC Toolkit Custom JSDoc Tags Plugin\n\nThis is a plugin maps custom JSDoc tags on your component classes to properties in Custom Elements Manifest using the [Custom Element Manifest Analyzer](https://custom-elements-manifest.open-wc.org/).\n\n## Installation \n\n```bash\nnpm i -D @wc-toolkit/jsdoc-tags\n```\n\n## Usage\n\nAdd the information you would like to include with you component in the class's JSDoc comment using custom tags. In this example, the `@dependency`, `@since`, `@status`, and `@spec` tags are all custom.\n\n```js\n// my-component.js\n\n/**\n *\n * My custom element does some amazing things\n *\n * @tag my-element\n *\n * @dependency icon\n * @dependency button\n *\n * @since 1.2.5\n * \n * @status beta - not ready for production\n * \n * @spec https://www.figma.com/...\n *\n */\nexport class MyElement extends HTMLElement {\n  ...\n}\n```\n\nIn the [CEM analyzer config](https://custom-elements-manifest.open-wc.org/analyzer/config/), import the plugin and add the mappings for the new tags.\n\n```js\n// custom-elements-manifest.config.mjs\n\nimport { jsDocTagsPlugin } from \"@wc-toolkit/jsdoc-tags\";\n\nexport default {\n  ...\n  /** Provide custom plugins */\n  plugins: [\n    jsDocTagsPlugin({\n      tags: {\n        // finds the values for the `@since` tag\n        since: {},\n        // finds the values for the `@status` tag\n        status: {},\n        // finds the values for the `@spec` tag\n        spec: {},\n        // finds the values for the `@dependency` tag\n        dependency: {\n          // maps the values to the `dependencies` property in the CEM\n          mappedName: 'dependencies',\n          // ensures the values are always in an array (even if there is only 1)\n          isArray: true,\n        },\n      }\n    }),\n  ],\n};\n```\n\n## Property-level Custom Tags\n\nYou can also add custom JSDoc tags to class properties. These will be extracted and included in the Custom Elements Manifest under the member's field for each property.\n\n### Example\n\n```js\nexport class MyComponent extends HTMLElement {\n  /**\n   * The greeting to display\n   * @myCustomTag important\n   */\n  greeting = \"Hello, World!\";\n}\n```\n\n### Configuration\n\nAdd your custom property tag to the plugin config:\n\n```js\njsDocTagsPlugin({\n  tags: {\n    myCustomTag: {\n      description: \"A custom property tag\",\n      mappedName: \"myCustomTag\"\n    }\n  }\n})\n```\n\n### Result in custom-elements.json\n\n```json\n{\n  \"kind\": \"field\",\n  \"name\": \"greeting\",\n  \"type\": { \"text\": \"string\" },\n  \"myCustomTag\": \"important\"\n}\n```\n\nThis allows you to document and extract custom metadata for properties in a structured way.\n\n## Result\n\nThe data should now be included in the Custom Elements Manifest.\n\n```json\n// custom-elements.json\n\n{\n  \"kind\": \"class\",\n  \"description\": \"My custom element does some amazing things\",\n  \"name\": \"MyElement\",\n  \"tagName\": \"my-element\",\n  \"since\": {\n    \"name\": \"1.2.5\",\n    \"description\": \"\"\n  },\n  \"status\": {\n    \"name\": \"beta\",\n    \"description\": \"not ready for production\"\n  },\n  \"spec\": {\n    \"name\": \"https://www.figma.com/...\",\n    \"description\": \"\"\n  },\n  \"dependencies\": [\n    {\n      \"name\": \"icon\",\n      \"description\": \"\"\n    },\n    {\n      \"name\": \"button\",\n      \"description\": \"\"\n    }\n  ],\n  \"customTags\": {\n    \"myCustomTag\": \"important\"\n  }\n}\n```\n\n<div style=\"text-align: center; margin-top: 32px;\">\n  <a href=\"https://stackblitz.com/edit/stackblitz-starters-endx3har?file=README.md\">\n    <img\n      alt=\"Open in StackBlitz\"\n      src=\"https://developer.stackblitz.com/img/open_in_stackblitz.svg\"\n    />\n  </a>\n</div>\n\nBe sure to check out the [official docs](https://wc-toolkit.com/documentation/jsdoc-tags) for more information on how to use this.","readmeFilename":"README.md"}