vue-docgen-api - npm Package Compare versions

Comparing version 4.56.2 to 4.56.4

dist/script-setup-handlers/utils/tsUtils.js

@@ -37,2 +37,8 @@ "use strict";
             return false;
+        },
+        visitTSTypeAliasDeclaration(nodePath) {
+            if (bt.isIdentifier(nodePath.node.id) && nodePath.node.id.name === typeName) {
+                typeBody = nodePath.get('typeAnnotation', 'members');
+            }
+            return false;
         }
@@ -39,0 +45,0 @@ });

dist/script-setup-handlers/utils/tsUtils.test.js

@@ -10,9 +10,36 @@ "use strict";
     it('resolves an interface in the global scope', () => {
-        var _a;
         const parser = (0, babel_parser_1.default)({ plugins: ['typescript'] });
-        expect((_a = (0, tsUtils_1.getTypeDefinitionFromIdentifier)(parser.parse(`
-    interface Foo{
-
-    }`), 'Foo')) === null || _a === void 0 ? void 0 : _a.node.loc).toBeDefined();
-    });
+        const src = `
+					interface LocalType {
+            /**
+             * describe the local prop
+             */
+						prop1: boolean
+						prop2: string
+					}
+					defineProps<LocalType>()
+					`;
+        const astFile = parser.parse(src);
+        //console.log(astFile)
+        const nodePath = (0, tsUtils_1.getTypeDefinitionFromIdentifier)(astFile, 'LocalType');
+        const props = nodePath === null || nodePath === void 0 ? void 0 : nodePath.map((prop) => prop.node.key.name + ' ' + prop.node.typeAnnotation.typeAnnotation.type);
+        expect(props).toStrictEqual(["prop1 TSBooleanKeyword", "prop2 TSStringKeyword"]);
+    }),
+        it('resolves an Type alias in the global scope', () => {
+            const parser = (0, babel_parser_1.default)({ plugins: ['typescript'] });
+            const src = `
+					type LocalType = {
+            /**
+             * describe the local prop
+             */
+						prop1: boolean
+						prop2: string
+					}
+					defineProps<LocalType>()
+					`;
+            const astFile = parser.parse(src);
+            const nodePath = (0, tsUtils_1.getTypeDefinitionFromIdentifier)(astFile, 'LocalType');
+            const props = nodePath === null || nodePath === void 0 ? void 0 : nodePath.map((prop) => prop.node.key.name + ' ' + prop.node.typeAnnotation.typeAnnotation.type);
+            expect(props).toStrictEqual(["prop1 TSBooleanKeyword", "prop2 TSStringKeyword"]);
+        });
 });

package.json

 {
   "name": "vue-docgen-api",
-  "version": "4.56.2",
+  "version": "4.56.4",
   "description": "Toolbox to extract information from Vue component files for documentation generation purposes.",
@@ -36,3 +36,3 @@ "homepage": "https://vue-styleguidist.github.io",
     "pug": "^3.0.2",
-    "recast": "0.21.5",
+    "recast": "0.22.0",
     "ts-map": "^1.0.3",
@@ -51,3 +51,3 @@ "vue-inbrowser-compiler-independent-utils": "^4.56.2"
     "vue-property-decorator": "7.3.0",
-    "vuetify": "2.6.12"
+    "vuetify": "2.6.13"
   },
@@ -54,0 +54,0 @@ "scripts": {

No alert changes

Improved metrics

Total package byte prevSize

495231

increased by0.3%

Lines of code

11637

increased by0.29%

Dependency changes

• + Addedassert@2.1.0(transitive)

• + Addedavailable-typed-arrays@1.0.7(transitive)

• + Addeddefine-properties@1.2.1(transitive)

• + Addedfor-each@0.3.3(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedis-arguments@1.1.1(transitive)

• + Addedis-callable@1.2.7(transitive)

• + Addedis-generator-function@1.0.10(transitive)

• + Addedis-nan@1.3.2(transitive)

• + Addedis-typed-array@1.1.13(transitive)

• + Addedobject-is@1.1.6(transitive)

• + Addedobject-keys@1.1.1(transitive)

• + Addedobject.assign@4.1.5(transitive)

• + Addedpossible-typed-array-names@1.0.0(transitive)

• + Addedrecast@0.22.0(transitive)

• + Addedutil@0.12.5(transitive)

• + Addedwhich-typed-array@1.1.15(transitive)

• - Removedrecast@0.21.5(transitive)

• Updatedrecast@0.22.0