{"library":"vue-docgen-api","type":"library","category":null,"description":"vue-docgen-api is a robust toolbox designed to programmatically extract detailed structural and behavioral information from Vue component files, whether they are Single File Components (SFCs), JavaScript, or TypeScript. It leverages `@babel/parser` to analyze component code, providing insights into props, events, slots, and methods, which is crucial for automated documentation generation. The current stable version is `4.79.2`, with a consistent release cadence of patch and minor updates, indicating active development and responsiveness to bug fixes and new Vue features (like `defineEmits` syntax in Vue 3.3). Its key differentiators include a highly configurable API with options for custom handlers to extend parsing logic, support for aliased paths, and the ability to handle both single and multiple component exports within a single file. This makes it an essential utility for projects building design systems, component libraries, or custom documentation platforms, often used as the core parser for tools like `vue-styleguidist`.","language":"javascript","status":"active","version":"4.79.2","tags":["javascript","vue","documentation-generation","jsdoc","parse","typescript"],"last_verified":"Wed May 27","install":[{"cmd":"npm install vue-docgen-api","imports":["import { parse } from 'vue-docgen-api';","import { parseMulti } from 'vue-docgen-api';","import { parseSource } from 'vue-docgen-api';","import type { DocGenOptions } from 'vue-docgen-api';"]},{"cmd":"yarn add vue-docgen-api","imports":[]},{"cmd":"pnpm add vue-docgen-api","imports":[]}],"homepage":"https://vue-styleguidist.github.io","github":"https://github.com/vue-styleguidist/vue-styleguidist","docs":null,"changelog":null,"pypi":null,"npm":"https://www.npmjs.com/package/vue-docgen-api","openapi_spec":null,"status_page":null,"smithery":null,"compatibility":{"summary":{"python_range":"18–22","success_rate":0,"avg_install_s":null,"avg_import_s":null,"wheel_type":null},"url":"https://checklist.day/v1/registry/vue-docgen-api/compatibility"}}