{"_id":"@divriots/vite-plugin-vue-docgen","_rev":"3-9caaca018b40a893727323da24d035d5","name":"@divriots/vite-plugin-vue-docgen","dist-tags":{"latest":"0.1.1-divRIOTS.0"},"versions":{"0.1.1-divRIOTS.0":{"name":"@divriots/vite-plugin-vue-docgen","version":"0.1.1-divRIOTS.0","keywords":["vite","plugin","vue-docgen"],"author":{"name":"Andrew Courtice"},"license":"ISC","_id":"@divriots/vite-plugin-vue-docgen@0.1.1-divRIOTS.0","maintainers":[{"name":"muryoh","email":"muryoh@gmail.com"},{"name":"gqio","email":"quinio.gregory@gmail.com"},{"name":"georges-gomes","email":"georges.gomes@gmail.com"},{"name":"gluck","email":"francois.valdy@gmail.com"},{"name":"_divriots_","email":"admin+npm@divriots.com"}],"homepage":"https://github.com/andrewcourtice/vite-plugin-vue-docgen#readme","bugs":{"url":"https://github.com/andrewcourtice/vite-plugin-vue-docgen/issues"},"dist":{"shasum":"30fba732c5f9023759028ff674a377fe7c993dd9","tarball":"https://registry.npmjs.org/@divriots/vite-plugin-vue-docgen/-/vite-plugin-vue-docgen-0.1.1-divRIOTS.0.tgz","fileCount":5,"integrity":"sha512-DGfy+6fWkyOVCwaoe+twuywWy4JHR0vpKmrZInTy4m3K9PTzk22Lvz8kMm/xWGzYb8Qq+yzam68cCAPYrpMHZA==","signatures":[{"sig":"MEUCIEAEd4o4SdqSVhuhyRkEn0wqXBIxIAP0IhrGKiMm6rLZAiEAxLGJT2F7W8qZiAlmAK0s3o6Xjj99MCNyVz3cW/fVkEY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":6687,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiXr55ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmr03hAAm4f0eDjtieoX2EGX/YiNV3qnL4r5EvnXj1Hxe5WKAT/IJwkJ\r\nhZGDE4jp9o4CUNgnYg7bV+PBrjQvXxome7t4P5/YoRjIC9OSnc2CVfwhv1nH\r\nRxuVF1OHOhKjZwwzdlrIUfa7IluQPLRem/RSBK1Jrp5xXqYhHywenY2Zm8Q3\r\nLmFxFk+nasFOfjvH7e1tW+MFa06v05rW1QoNADz8LInm9I4tAtSwJHuBb82P\r\nwbHNDebBJBtsoMzXM7duT/+vJqj6EayAT5XfAkoziHHWhGUEW6SKva/5L5aG\r\nqg2PL1Ry4NAx5VwWkc4dbzJGdD80/l0GIhW1x/tHI5Yg13KPurKEx4g1Q/6x\r\nHhAf9NVhuR6VxBNuPJhFxF4Zr0JWr40LLyBUHXgr/yYu++6aFfcW1LHJOEl/\r\nnvWrat9rDkvqk8jYcneVYBpN3U43ckCONjdeX+u7JV6GTmiWVvW8MXNSJrtj\r\nXOcbFyu/rW3lHbegHjkaEBAPyTBxzHETojX9jwG3StajY1LqleM71DczQMRG\r\nIlPiN17p47MNYL5NaNZbKOhqtq2j4upyHVwiBACc7kwn6Lup7G9+a5UDRjNs\r\nEcirPdBi7EcpPy8QBlbQz+tBraaJabJbMlqiUWQhWzWuMkQPuH5ac1JsLszi\r\nbgZxeBCKzlmf7fSfLwmtCmHI0aVuPCc8BOc=\r\n=n0W/\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.cjs","type":"module","types":"dist/index.d.ts","module":"dist/index.js","exports":{"node":"./dist/index.cjs","import":"./dist/index.js","default":"./dist/index.cjs","require":"./dist/index.cjs"},"gitHead":"d926381f21758ebc9700f2268b38a2428e3b4c0e","scripts":{"test":"jest","build":"tsup ./src/index.ts"},"_npmUser":{"name":"muryoh","email":"muryoh@gmail.com"},"jest-junit":{"suiteName":"Unit Tests","outputName":"./test-results.xml","outputDirectory":"."},"repository":{"url":"git+https://github.com/andrewcourtice/vite-plugin-vue-docgen.git","type":"git"},"_npmVersion":"8.5.0","description":"A simple vue-docgen plugin for Vite","directories":{},"_nodeVersion":"16.14.2","dependencies":{"vue-docgen-api":"^4.40.0","@rollup/pluginutils":"^4.2.1"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^27.0.6","tsup":"^4.12.0","vite":"^2.3.8","ts-jest":"^27.0.3","jest-junit":"^12.2.0","typescript":"^4.3.4","@types/jest":"^26.0.23"},"peerDependencies":{"vite":"^2.3.8"},"_npmOperationalInternal":{"tmp":"tmp/vite-plugin-vue-docgen_0.1.1-divRIOTS.0_1650376313595_0.9686753925378775","host":"s3://npm-registry-packages"}}},"time":{"created":"2022-04-19T13:51:53.531Z","modified":"2025-09-03T07:24:26.797Z","0.1.1-divRIOTS.0":"2022-04-19T13:51:53.724Z"},"bugs":{"url":"https://github.com/andrewcourtice/vite-plugin-vue-docgen/issues"},"author":{"name":"Andrew Courtice"},"license":"ISC","homepage":"https://github.com/andrewcourtice/vite-plugin-vue-docgen#readme","keywords":["vite","plugin","vue-docgen"],"repository":{"url":"git+https://github.com/andrewcourtice/vite-plugin-vue-docgen.git","type":"git"},"description":"A simple vue-docgen plugin for Vite","maintainers":[{"email":"quinio.gregory@gmail.com","name":"gqio"},{"email":"francois.valdy@gmail.com","name":"gluck"},{"email":"georges.gomes@gmail.com","name":"georges-gomes"},{"email":"muryoh@gmail.com","name":"muryoh"},{"email":"admin+npm@divriots.com","name":"_divriots_"}],"readme":"# Vite Vue-Docgen Plugin\n\n[![Test and Build](https://github.com/andrewcourtice/vite-plugin-vue-docgen/actions/workflows/test-and-build.yml/badge.svg)](https://github.com/andrewcourtice/vite-plugin-vue-docgen/actions/workflows/test-and-build.yml)\n\nThis is a very simple Vite plugin that wraps the [Vue Docgen API](https://github.com/vue-styleguidist/vue-styleguidist/tree/dev/packages/vue-docgen-api) for providing metadata about Vue single file components (SFC).\n\n## Usage\nTo use, simply import the plugin and register it **after** the Vue plugin in your Vite config:\n\n```javascript\n// vite.config.js\n\nimport vuePlugin from '@vitejs/plugin-vue';\nimport vueDocgenPlugin from 'vite-plugin-vue-docgen';\n\nexport default {\n    plugins: [\n        vuePlugin(),\n        vueDocgenPlugin()\n    ]\n}\n```\n\nThe docgen metadata will then be accessible as a property on the component:\n\n```javascript\nimport Button from './button.vue';\n\nconst {\n    displayName,\n    description,\n    props,\n    methods,\n    slots\n} = Button.__docgenInfo;\n```\n\n## Options\n```javascript\nconst options = {\n    \n    /* Regex (optional) - The file path pattern to match */\n    pattern: /\\.vue$/,\n\n    /* String (optional) - The property name to inject the docgen metadata at */\n    injectAt: '__docgenInfo'\n\n    /* Object (optional) - Specific Docgen API options */\n    docgenOptions: {\n        jsx: true\n    }\n};\n```\n\nSee [here](https://github.com/vue-styleguidist/vue-styleguidist/tree/dev/packages/vue-docgen-api#options-docgenoptions) for a full list of docgen API options.\n","readmeFilename":"README.md"}