fix(compiler-sfc): accept StringLiteral node in defineEmit tuple …

…syntax (vuejs#8041) close vuejs#8040
IAmSSH · Apr 29, 2023 · 1c454ea · 1c454ea
1 parent fab7eb6
commit 1c454ea
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 3 deletions.
diff --git a/packages/compiler-sfc/__tests__/__snapshots__/compileScript.spec.ts.snap b/packages/compiler-sfc/__tests__/__snapshots__/compileScript.spec.ts.snap
@@ -1457,6 +1457,22 @@ export default /*#__PURE__*/_defineComponent({
 
 
 
+return { emit }
+}
+
+})"
+`;
+
+exports[`SFC compile <script setup> > with TypeScript > defineEmits w/ type (property syntax string literal) 1`] = `
+"import { defineComponent as _defineComponent } from 'vue'
+
+export default /*#__PURE__*/_defineComponent({
+  emits: [\\"foo:bar\\"],
+  setup(__props, { expose: __expose, emit }) {
+  __expose();
+
+
+
 return { emit }
 }
 

diff --git a/packages/compiler-sfc/__tests__/compileScript.spec.ts b/packages/compiler-sfc/__tests__/compileScript.spec.ts
@@ -1629,6 +1629,17 @@ const emit = defineEmits(['a', 'b'])
       assertCode(content)
     })
 
+    // #8040
+    test('defineEmits w/ type (property syntax string literal)', () => {
+      const { content } = compile(`
+      <script setup lang="ts">
+      const emit = defineEmits<{ 'foo:bar': [] }>()
+      </script>
+      `)
+      expect(content).toMatch(`emits: ["foo:bar"]`)
+      assertCode(content)
+    })
+
     describe('defineSlots()', () => {
       test('basic usage', () => {
         const { content } = compile(`

diff --git a/packages/compiler-sfc/src/compileScript.ts b/packages/compiler-sfc/src/compileScript.ts
@@ -2316,11 +2316,15 @@ function extractRuntimeEmits(
         hasCallSignature = true
       }
       if (t.type === 'TSPropertySignature') {
-        if (t.key.type !== 'Identifier' || t.computed) {
+        if (t.key.type === 'Identifier' && !t.computed) {
+          emits.add(t.key.name)
+          hasProperty = true
+        } else if (t.key.type === 'StringLiteral' && !t.computed) {
+          emits.add(t.key.value)
+          hasProperty = true
+        } else {
           error(`defineEmits() type cannot use computed keys.`, t.key)
         }
-        emits.add(t.key.name)
-        hasProperty = true
       }
     }
     if (hasCallSignature && hasProperty) {