feat(define-props): support vue 2

sxzz · sxzz · commit b82161836e74 · 2023-01-17T01:30:50.000+08:00
diff --git a/.changeset/modern-bottles-pretend.md b/.changeset/modern-bottles-pretend.md
@@ -0,0 +1,6 @@
+---
+'@vue-macros/define-props': patch
+'unplugin-vue-macros': patch
+---
+
+support vue 2
diff --git a/docs/macros/define-props.md b/docs/macros/define-props.md
@@ -10,7 +10,7 @@ See also [Vue issue](https://github.com/vuejs/core/issues/6876), [Reactivity Tra
 | :----------------: | :----------------: |
 |       Vue 3        | :white_check_mark: |
 |       Nuxt 3       | :white_check_mark: |
-|       Vue 2        |        :x:         |
+|       Vue 2        | :white_check_mark: |
 | TypeScript / Volar | :white_check_mark: |
 
 ::: warning
diff --git a/package.json b/package.json
@@ -48,6 +48,7 @@
     "vite": "^4.0.4",
     "vitest": "^0.27.1",
     "vue": "^3.2.45",
+    "vue2": "npm:vue@^2.7.14",
     "webpack": "^5.75.0"
   },
   "engines": {
diff --git a/packages/define-props/package.json b/packages/define-props/package.json
@@ -67,7 +67,7 @@
     "dev": "DEV=1 tsup"
   },
   "peerDependencies": {
-    "vue": "^3.2.25"
+    "vue": "^2.7.0 || ^3.2.25"
   },
   "dependencies": {
     "@rollup/pluginutils": "^5.0.2",
diff --git a/packages/define-props/vue2-macros-global.d.ts b/packages/define-props/vue2-macros-global.d.ts
@@ -0,0 +1,7 @@
+import type { $defineProps as _$defineProps } from './macros'
+
+declare global {
+  const $defineProps: typeof _$defineProps
+}
+
+export {}
diff --git a/packages/define-props/vue2-macros.d.ts b/packages/define-props/vue2-macros.d.ts
@@ -0,0 +1,20 @@
+import type {
+  ComponentObjectPropsOptions,
+  ExtractPropTypes,
+} from 'vue/types/v3-component-props'
+// @ts-expect-error
+import type { RefValue } from '@vue-macros/reactivity-transform-vue2/macros'
+
+export type RefValueObject<T> = {
+  [K in keyof T]: RefValue<T[K]>
+}
+
+export declare function $defineProps<PropNames extends string = string>(
+  props: PropNames[]
+): Readonly<{
+  [key in PropNames]?: any
+}>
+export declare function $defineProps<
+  PP extends ComponentObjectPropsOptions = ComponentObjectPropsOptions
+>(props: PP): RefValueObject<ExtractPropTypes<PP>>
+export declare function $defineProps<TypeProps>(): RefValueObject<TypeProps>
diff --git a/packages/macros/vue2-macros-global.d.ts b/packages/macros/vue2-macros-global.d.ts
@@ -1,5 +1,6 @@
 /// <reference types="@vue-macros/define-model/macros-global" />
 /// <reference types="unplugin-vue-define-options/macros-global" />
+/// <reference types="@vue-macros/define-props/macros-global" />
 /// <reference types="@vue-macros/define-render/vue2-macros-global" />
 /// <reference types="@vue-macros/define-slots/macros-global" />
 /// <reference types="@vue-macros/reactivity-transform-vue2/macros-global" />
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/tsconfig.json b/tsconfig.json
@@ -2,6 +2,7 @@
   "files": [],
   "references": [
     { "path": "./tsconfig.lib.json" },
+    { "path": "./tsconfig.lib.vue2.json" },
     { "path": "./tsconfig.test.json" },
     { "path": "./tsconfig.fixture.json" }
   ]
diff --git a/tsconfig.lib.json b/tsconfig.lib.json
@@ -26,6 +26,7 @@
     "**/dist",
     "**/tests",
     "**/macros-global.d.ts",
-    "packages/volar/*.js"
+    "packages/volar/*.js",
+    "**/vue2-macros*"
   ]
 }
diff --git a/tsconfig.lib.vue2.json b/tsconfig.lib.vue2.json
@@ -0,0 +1,18 @@
+{
+  "extends": "./tsconfig.lib.json",
+  "compilerOptions": {
+    "paths": {
+      "unplugin-vue-define-options": ["./packages/define-options/src"],
+      "unplugin-vue-macros": ["./packages/macros/src"],
+      "@vue-macros/*": ["packages/*/src"],
+      "vue": ["node_modules/vue2"],
+      "vue/*": ["node_modules/vue2/*"]
+    }
+  },
+  "exclude": [
+    "**/dist",
+    "**/tests",
+    "**/macros-global.d.ts",
+    "packages/volar/*.js"
+  ]
+}

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`	`"files": [],`
`3`	`3`	`"references": [`
`4`	`4`	`{ "path": "./tsconfig.lib.json" },`
	`5`	`+ { "path": "./tsconfig.lib.vue2.json" },`
`5`	`6`	`{ "path": "./tsconfig.test.json" },`
`6`	`7`	`{ "path": "./tsconfig.fixture.json" }`
`7`	`8`	`]`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@`
`26`	`26`	`"**/dist",`
`27`	`27`	`"**/tests",`
`28`	`28`	`"**/macros-global.d.ts",`
`29`		`- "packages/volar/*.js"`
	`29`	`+ "packages/volar/*.js",`
	`30`	`+ "*/vue2-macros"`
`30`	`31`	`]`
`31`	`32`	`}`