fix: resolve TS function type

closes #328
vue-macros · Apr 3, 2023 · 14d7886 · 14d7886
1 parent b48cd29
commit 14d7886
Show file tree

Hide file tree

Showing 6 changed files with 81 additions and 5 deletions.
diff --git a/.changeset/red-mice-warn.md b/.changeset/red-mice-warn.md
@@ -0,0 +1,7 @@
+---
+'@vue-macros/better-define': patch
+'@vue-macros/single-define': patch
+'@vue-macros/api': patch
+---
+
+resolve TS function type
diff --git a/packages/api/src/ts.ts b/packages/api/src/ts.ts
@@ -20,6 +20,7 @@ import type {
   TSDeclareFunction,
   TSEntityName,
   TSEnumDeclaration,
+  TSFunctionType,
   TSInterfaceBody,
   TSInterfaceDeclaration,
   TSIntersectionType,
@@ -53,7 +54,9 @@ export interface TSFile {
 export type TSScope = TSFile | TSResolvedType<TSModuleBlock>
 
 export interface TSProperties {
-  callSignatures: Array<TSResolvedType<TSCallSignatureDeclaration>>
+  callSignatures: Array<
+    TSResolvedType<TSCallSignatureDeclaration | TSFunctionType>
+  >
   constructSignatures: Array<TSResolvedType<TSConstructSignatureDeclaration>>
   methods: Record<string | number, Array<TSResolvedType<TSMethodSignature>>>
   properties: Record<
@@ -109,6 +112,7 @@ export async function resolveTSProperties({
   | TSTypeLiteral
   | TSIntersectionType
   | TSMappedType
+  | TSFunctionType
 >): Promise<TSProperties> {
   switch (type.type) {
     case 'TSInterfaceBody':
@@ -203,6 +207,15 @@ export async function resolveTSProperties({
 
       return properties
     }
+    case 'TSFunctionType': {
+      const properties: TSProperties = {
+        callSignatures: [{ type, scope }],
+        constructSignatures: [],
+        methods: {},
+        properties: {},
+      }
+      return properties
+    }
     default:
       // @ts-expect-error type is never
       throw new Error(`unknown node: ${type?.type}`)

diff --git a/packages/api/src/vue/emits.ts b/packages/api/src/vue/emits.ts
@@ -22,6 +22,7 @@ import type {
   Node,
   StringLiteral,
   TSCallSignatureDeclaration,
+  TSFunctionType,
   TSInterfaceDeclaration,
   TSIntersectionType,
   TSType,
@@ -131,9 +132,12 @@ export async function handleTSEmitsDefinition({
     if (
       definitionsAst.type !== 'TSInterfaceDeclaration' &&
       definitionsAst.type !== 'TSTypeLiteral' &&
-      definitionsAst.type !== 'TSIntersectionType'
+      definitionsAst.type !== 'TSIntersectionType' &&
+      definitionsAst.type !== 'TSFunctionType'
     )
-      throw new SyntaxError(`Cannot resolve TS definition.`)
+      throw new SyntaxError(
+        `Cannot resolve TS definition: ${definitionsAst.type}`
+      )
 
     const properties = await resolveTSProperties({
       scope,
@@ -205,9 +209,12 @@ export interface EmitsBase {
 export interface TSEmits extends EmitsBase {
   kind: DefinitionKind.TS
 
-  definitions: Record<string, ASTDefinition<TSCallSignatureDeclaration>[]>
+  definitions: Record<
+    string,
+    ASTDefinition<TSCallSignatureDeclaration | TSFunctionType>[]
+  >
   definitionsAst: ASTDefinition<
-    TSTypeLiteral | TSIntersectionType | TSInterfaceDeclaration
+    TSTypeLiteral | TSIntersectionType | TSInterfaceDeclaration | TSFunctionType
   >
 
   /**

diff --git a/packages/better-define/tests/__snapshots__/fixtures.test.ts.snap b/packages/better-define/tests/__snapshots__/fixtures.test.ts.snap
@@ -374,6 +374,44 @@ export { issue260 as default };
 "
 `;
 
+exports[`fixtures > tests/fixtures/issue-328.vue > isProduction = false 1`] = `
+"import { defineComponent } from 'vue';
+import _export_sfc from '/plugin-vue/export-helper';
+
+var _sfc_main = /* @__PURE__ */ defineComponent({
+  __name: \\"issue-328\\",
+  emits: [\\"foo\\"],
+  setup(__props) {
+    return () => {
+    };
+  }
+});
+
+var issue328 = /* @__PURE__ */ _export_sfc(_sfc_main, [__FILE__]);
+
+export { issue328 as default };
+"
+`;
+
+exports[`fixtures > tests/fixtures/issue-328.vue > isProduction = true 1`] = `
+"import { defineComponent } from 'vue';
+import _export_sfc from '/plugin-vue/export-helper';
+
+var _sfc_main = /* @__PURE__ */ defineComponent({
+  __name: \\"issue-328\\",
+  emits: [\\"foo\\"],
+  setup(__props) {
+    return () => {
+    };
+  }
+});
+
+var issue328 = /* @__PURE__ */ _export_sfc(_sfc_main, [__FILE__]);
+
+export { issue328 as default };
+"
+`;
+
 exports[`fixtures > tests/fixtures/optional-method.vue > isProduction = false 1`] = `
 "import { defineComponent } from 'vue';
 import _export_sfc from '/plugin-vue/export-helper';

diff --git a/packages/better-define/tests/fixtures/issue-328.vue b/packages/better-define/tests/fixtures/issue-328.vue
@@ -0,0 +1,4 @@
+<script setup lang="ts">
+defineEmits<(evt: 'foo', id?: string) => void>()
+</script>
+
diff --git a/packages/single-define/tests/__snapshots__/fixtures.test.ts.snap b/packages/single-define/tests/__snapshots__/fixtures.test.ts.snap
@@ -56,21 +56,28 @@ import { expectTypeOf } from 'expect-type'
 import type { ComputedRef } from 'vue'
 import type { Qux } from './types'
 
+// defineProp(prop_name)
 const foo = __MACROS_computed(() => __MACROS_props[\\"foo\\"])
 expectTypeOf(foo).toEqualTypeOf<ComputedRef<string>>()
 
+// defineProp(prop_name, options)
 const bar = __MACROS_computed(() => __MACROS_props[\\"bar\\"])
 expectTypeOf(bar).toEqualTypeOf<ComputedRef<string>>()
 
+// defineProp(prop_name, options)
 const baz = __MACROS_computed(() => __MACROS_props[\\"baz\\"])
 expectTypeOf(baz).toEqualTypeOf<ComputedRef<string | number>>()
 
+// defineProp(prop_name)
 __MACROS_computed(() => __MACROS_props[\\"qux\\"])
 
+// defineProp(prop_name, options)
 __MACROS_computed(() => __MACROS_props[\\"quux\\"])
 
 // infer prop name from variable name
+// const prop_name = defineProp()
 const quuz = __MACROS_computed(() => __MACROS_props[\\"quuz\\"])
+expectTypeOf(quuz).toEqualTypeOf<ComputedRef<any>>()
 console.log(quuz)
 </script>
 \`;