do11y 0.5.3 → 0.5.5

package/dist/docs/plugins/meta/meta-mapper.d.ts

@@ -1,3 +1,4 @@
 import type { ComponentMeta } from "vue-component-meta";
+import type { ComponentDoc } from "vue-docgen-api";
 import type { Meta } from "./meta-types";
-export declare const mapMeta: (meta: ComponentMeta, render: (input: string) => string) => Meta;
+export declare const mapMeta: (docs: ComponentDoc, meta: ComponentMeta, render: (input: string) => string) => Meta;

package/dist/docs/plugins/meta/meta-mapper.js

@@ -1,4 +1,4 @@
-export const mapMeta = (meta, render) => {
+export const mapMeta = (docs, meta, render) => {
     const nonGlobalProps = meta.props.filter((prop) => !prop.global);
     const getDeprecated = (tags) => {
         const deprecated = getTag(tags, "deprecated");
@@ -11,13 +11,18 @@ export const mapMeta = (meta, render) => {
             text: tag.text ? render(tag.text) : undefined,
         }));
     };
-    const mapEvent = (prop) => ({
-        name: prop.name,
-        type: prop.type,
-        description: prop.description ? render(prop.description) : undefined,
-        deprecated: getDeprecated(prop.tags),
-        tags: getFilteredTags(prop.tags),
-    });
+    const mapEvent = (prop) => {
+        if (!prop.description) {
+            prop.description = docs.events?.find((event) => event.name === prop.name)?.description || "";
+        }
+        return {
+            name: prop.name,
+            type: prop.type,
+            description: prop.description ? render(prop.description) : undefined,
+            deprecated: getDeprecated(prop.tags),
+            tags: getFilteredTags(prop.tags),
+        };
+    };
     const mapSlotAndExposed = (se) => ({
         name: se.name,
         type: se.type,

package/dist/docs/plugins/meta/meta.js

@@ -2,6 +2,7 @@ import { existsSync, readFileSync } from "node:fs";
 import { join } from "node:path";
 import { createChecker } from "vue-component-meta";
 import { parse as parseVue } from "vue/compiler-sfc";
+import { parse as parseDocs } from "vue-docgen-api";
 import markdown from "markdown-it";
 import { root } from "../../files.js";
 import { mapMeta } from "./meta-mapper.js";
@@ -31,7 +32,7 @@ export default () => {
     });
     return {
         name: "do11y:meta",
-        transform(_, id) {
+        async transform(_, id) {
             if (id.endsWith(".vue?meta")) {
                 const file = id.replace("?meta", "");
                 const content = readFileSync(file, "utf-8");
@@ -39,8 +40,9 @@ export default () => {
                 const block = descriptor.customBlocks.find((b) => b.type === "docs" && b.lang === "md");
                 const description = block ? md.render(block.content) || undefined : undefined;
                 const meta = checker.getComponentMeta(file);
+                const docs = await parseDocs(file);
                 const mappedMeta = {
-                    ...mapMeta(meta, (content) => md.render(content)),
+                    ...mapMeta(docs, meta, (content) => md.render(content)),
                     description: description || meta.description,
                 };
                 const code = `export default ${JSON.stringify(mappedMeta)}`;

package/dist/docs/vite-config.js

@@ -33,11 +33,11 @@ const getPlugin = async (plugin) => {
 const getUserPlugins = async (userViteConfig) => {
     const userPlugins = userViteConfig.plugins?.map(async (p) => await getPlugin(p)) ?? [];
     const resolvedUserPlugins = (await Promise.all(userPlugins)).flat();
-    const vuePluginApi = resolvedUserPlugins.find((p) => p.name === "vite:vue").api;
+    const vuePluginApi = resolvedUserPlugins.find((p) => p.name === "vite:vue")?.api;
     const VuePlugin = (await import("@vitejs/plugin-vue")).default;
     return [
         VuePlugin({
-            ...vuePluginApi.options,
+            ...vuePluginApi?.options,
             include: [/\.vue$/, /\.md$/],
             exclude: [
                 /\.vue\?meta$/,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "do11y",
-  "version": "0.5.3",
+  "version": "0.5.5",
   "description": "A bare-bones tool to document Vue components.",
   "keywords": [
     "docs-generator",
@@ -37,7 +37,8 @@
     "shiki": "^4.0.2",
     "tinyglobby": "^0.2.16",
     "v-custom-block": "^1.0.67",
-    "vue-component-meta": "^3.2.8"
+    "vue-component-meta": "^3.2.8",
+    "vue-docgen-api": "^4.79.2"
   },
   "devDependencies": {
     "@tsconfig/node24": "^24.0.4",