vue-docgen-api - npm Package Compare versions

Comparing version 4.72.5 to 4.73.0

dist/script-handlers/componentHandler.js

@@ -30,6 +30,4 @@ "use strict";
 var bt = __importStar(require("@babel/types"));
-var getDocblock_1 = __importDefault(require("../utils/getDocblock"));
-var getDoclets_1 = __importDefault(require("../utils/getDoclets"));
-var transformTagsIntoObject_1 = __importDefault(require("../utils/transformTagsIntoObject"));
 var getProperties_1 = __importDefault(require("./utils/getProperties"));
+var handleComponentJSDoc_1 = __importDefault(require("../utils/handleComponentJSDoc"));
 /**
@@ -74,27 +72,5 @@ * Extracts prop information from an object-style VueJs component
     }
-    var docBlock = (0, getDocblock_1.default)(componentCommentedPath);
-    // if no prop return
-    if (!docBlock || !docBlock.length) {
-        return Promise.resolve();
-    }
-    var jsDoc = (0, getDoclets_1.default)(docBlock);
-    documentation.set('description', jsDoc.description);
-    if (jsDoc.tags) {
-        var displayNamesTags = jsDoc.tags.filter(function (t) { return t.title === 'displayName'; });
-        if (displayNamesTags.length) {
-            var displayName = displayNamesTags[0];
-            documentation.set('displayName', displayName.content);
-        }
-        var tagsAsObject = (0, transformTagsIntoObject_1.default)(jsDoc.tags.filter(function (t) { return t.title !== 'example' && t.title !== 'displayName'; }) || []);
-        var examples = jsDoc.tags.filter(function (t) { return t.title === 'example'; });
-        if (examples.length) {
-            tagsAsObject.examples = examples;
-        }
-        documentation.set('tags', tagsAsObject);
-    }
-    else {
-        documentation.set('tags', {});
-    }
-    return Promise.resolve();
+    // always return a promise to trigger next handler in chain
+    return (0, handleComponentJSDoc_1.default)(componentCommentedPath, documentation);
 }
 exports.default = componentHandler;

dist/script-setup-handlers/index.js

@@ -7,4 +7,5 @@ "use strict";
 var setupEventHandler_1 = __importDefault(require("./setupEventHandler"));
+var setupOptionsHandler_1 = __importDefault(require("./setupOptionsHandler"));
 var setupPropHandler_1 = __importDefault(require("./setupPropHandler"));
 var setupExposeHandler_1 = __importDefault(require("./setupExposeHandler"));
-exports.default = [setupEventHandler_1.default, setupPropHandler_1.default, setupExposeHandler_1.default];
+exports.default = [setupEventHandler_1.default, setupOptionsHandler_1.default, setupPropHandler_1.default, setupExposeHandler_1.default];

package.json

 {
   "name": "vue-docgen-api",
-  "version": "4.72.5",
+  "version": "4.73.0",
   "description": "Toolbox to extract information from Vue component files for documentation generation purposes.",
@@ -5,0 +5,0 @@ "homepage": "https://vue-styleguidist.github.io",

No alert changes

Improved metrics

Total package byte prevSize

771930

increased by1.4%

Number of package files

129

increased by3.2%

Lines of code

12075

increased by1.56%

No dependency changes