refactor(volar)!: rename shortVmodelPrefix

sxzz · sxzz · commit 901bbe36148f · 2022-10-17T04:05:51.000+08:00
diff --git a/.changeset/forty-pandas-enjoy.md b/.changeset/forty-pandas-enjoy.md
@@ -0,0 +1,5 @@
+---
+'@vue-macros/volar': minor
+---
+
+⚠️ BREAKING: rename `shortVmodelPrefix` to `shortVmodel.prefix`
diff --git a/README-zh-CN.md b/README-zh-CN.md
@@ -144,7 +144,9 @@ npm i -D @vue-macros/volar
       "@vue-macros/volar/short-vmodel"
     ],
     // `shortVmodel` 特性的 prefix
-    "shortVmodelPrefix": "$"
+    "shortVmodel": {
+      "prefix": "$"
+    }
   }
 }
 ```
diff --git a/docs/macros/short-vmodel.md b/docs/macros/short-vmodel.md
@@ -96,7 +96,9 @@ export default defineConfig({
       // ...
     ],
     // prefix
-    "shortVmodelPrefix": "$"
+    "shortVmodel": {
+      "prefix": "$"
+    }
   }
 }
 ```
diff --git a/packages/volar/src/short-vmodel.ts b/packages/volar/src/short-vmodel.ts
@@ -9,7 +9,7 @@ const plugin: VueLanguagePlugin = ({ vueCompilerOptions }) => {
       options.nodeTransforms ||= []
       options.nodeTransforms.push(
         transformShortVmodel({
-          prefix: (vueCompilerOptions as any)?.shortVmodelPrefix ?? '$',
+          prefix: (vueCompilerOptions as any)?.shortVmodel?.prefix ?? '$',
         })
       )
       return options
diff --git a/playground/vue3/tsconfig.json b/playground/vue3/tsconfig.json
@@ -18,7 +18,9 @@
       "@vue-macros/volar/define-model",
       "@vue-macros/volar/short-vmodel"
     ],
-    "shortVmodelPrefix": "$"
+    "shortVmodel": {
+      "prefix": "$"
+    }
   },
   "include": ["src", "*"]
 }

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@vue-macros/volar': minor
 +---
++
 +⚠️ BREAKING: rename `shortVmodelPrefix` to `shortVmodel.prefix`
Original file line number	Diff line number	Diff line change
`@@ -144,7 +144,9 @@ npm i -D @vue-macros/volar`
`144`	`144`	`"@vue-macros/volar/short-vmodel"`
`145`	`145`	`],`
`146`	`146`	// `shortVmodel` 特性的 prefix
`147`		`- "shortVmodelPrefix": "$"`
	`147`	`+ "shortVmodel": {`
	`148`	`+ "prefix": "$"`
	`149`	`+ }`
`148`	`150`	`}`
`149`	`151`	`}`
`150`	`152`	```
Original file line number	Diff line number	Diff line change
`@@ -96,7 +96,9 @@ export default defineConfig({`
`96`	`96`	`// ...`
`97`	`97`	`],`
`98`	`98`	`// prefix`
`99`		`- "shortVmodelPrefix": "$"`
	`99`	`+ "shortVmodel": {`
	`100`	`+ "prefix": "$"`
	`101`	`+ }`
`100`	`102`	`}`
`101`	`103`	`}`
`102`	`104`	```
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ const plugin: VueLanguagePlugin = ({ vueCompilerOptions }) => {`
`9`	`9`	`options.nodeTransforms \|\|= []`
`10`	`10`	`options.nodeTransforms.push(`
`11`	`11`	`transformShortVmodel({`
`12`		`- prefix: (vueCompilerOptions as any)?.shortVmodelPrefix ?? '$',`
	`12`	`+ prefix: (vueCompilerOptions as any)?.shortVmodel?.prefix ?? '$',`
`13`	`13`	`})`
`14`	`14`	`)`
`15`	`15`	`return options`