feat(volar): support unified defineModel

vue-macros · Oct 16, 2022 · e1db377 · e1db377
1 parent 7877ac7
commit e1db377
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 20 deletions.
diff --git a/.changeset/lovely-eagles-suffer.md b/.changeset/lovely-eagles-suffer.md
@@ -0,0 +1,5 @@
+---
+'@vue-macros/volar': minor
+---
+
+support unified defineModel
diff --git a/packages/volar/src/define-model.ts b/packages/volar/src/define-model.ts
@@ -10,12 +10,19 @@ import type {
   VueLanguagePlugin,
 } from '@volar/vue-language-core'
 
-function transformDefineModel(
-  codes: SegmentWithData<PositionCapabilities>[],
-  sfc: Sfc,
-  typeArg: ts.TypeNode,
+function transformDefineModel({
+  codes,
+  sfc,
+  typeArg,
+  vueLibName,
+  unified,
+}: {
+  codes: SegmentWithData<PositionCapabilities>[]
+  sfc: Sfc
+  typeArg: ts.TypeNode
   vueLibName: string
-) {
+  unified: boolean
+}) {
   const source = sfc.scriptSetup!.content.slice(typeArg.pos, typeArg.end)
   const seg: Segment<PositionCapabilities> = [
     source,
@@ -26,24 +33,34 @@ function transformDefineModel(
   mergeProps() || addProps()
   mergeEmits() || addEmits()
 
+  codes.push(
+    `type __VLS_GetPropKey<K> = K extends 'modelValue'${
+      unified ? '' : ' & never'
+    } ? 'value' : K
+    type __VLS_ModelToProps<T> = {
+      [K in keyof T as __VLS_GetPropKey<K>]: T[K]
+    }
+    type __VLS_GetEventKey<K extends string | number> = K extends 'modelValue'${
+      unified ? '' : ' & never'
+    } ? 'input' : \`update:\${K}\`
+    type __VLS_ModelToEmits<T> = T extends Record<string | number, any> ? { [K in keyof T & (string | number) as __VLS_GetEventKey<K>]: (value: T[K]) => void } : T`
+  )
+
   function mergeProps() {
     const idx = codes.indexOf('__VLS_TypePropsToRuntimeProps<')
     if (idx === -1) return false
 
-    codes.splice(idx + 2, 0, ' & ', seg)
+    codes.splice(idx + 2, 0, ' & __VLS_ModelToProps<', seg, '>')
     return true
   }
 
   function addProps() {
     const idx = codes.indexOf('setup() {\n')
     if (idx === -1) return false
     const segs: Segment<PositionCapabilities>[] = [
-      'props: (',
-      '{} as ',
-      '__VLS_TypePropsToRuntimeProps<',
+      'props: ({} as __VLS_TypePropsToRuntimeProps<__VLS_ModelToProps<',
       seg,
-      '>',
-      '),\n',
+      '>>),\n',
     ]
     codes.splice(idx, 0, ...segs)
 
@@ -61,9 +78,6 @@ function transformDefineModel(
     if (idx === -1) return false
 
     codes.splice(idx + 2, 1, '>> & __VLS_ModelToEmits<', seg, '>),\n')
-    codes.push(
-      `type __VLS_ModelToEmits<T> = T extends Record<string | number, any> ? { [K in keyof T & (string | number) as \`update:\${K}\`]: (value: T[K]) => void } : T`
-    )
     return true
   }
 
@@ -77,9 +91,6 @@ function transformDefineModel(
       '>),\n',
     ]
     codes.splice(idx, 0, ...segs)
-    codes.push(
-      `type __VLS_ModelToEmits<T> = T extends Record<string | number, any> ? { [K in keyof T & (string | number) as \`update:\${K}\`]: (value: T[K]) => void } : T`
-    )
     return true
   }
 }
@@ -135,8 +146,19 @@ function resolve({
   const typeArg = getTypeArg(ts, sfc)
   if (!typeArg) return
 
-  const vueLibName = getVueLibraryName(vueCompilerOptions.target ?? 3)
-  transformDefineModel(embeddedFile.content, sfc, typeArg, vueLibName)
+  const vueVersion = vueCompilerOptions.target ?? 3
+  const vueLibName = getVueLibraryName(vueVersion)
+  const unified =
+    (vueVersion < 3 && (vueCompilerOptions as any)?.defineModel?.unified) ??
+    true
+
+  transformDefineModel({
+    codes: embeddedFile.content,
+    sfc,
+    typeArg,
+    vueLibName,
+    unified,
+  })
 }
 
 const plugin: VueLanguagePlugin = ({

diff --git a/playground/vue2/tsconfig.json b/playground/vue2/tsconfig.json
@@ -15,7 +15,10 @@
   },
   "vueCompilerOptions": {
     "target": 2.7,
-    "plugins": ["@vue-macros/volar/define-model"]
+    "plugins": ["@vue-macros/volar/define-model"],
+    "defineModel": {
+      "unified": true
+    }
   },
   "include": ["src", "*"]
 }