feat(better-define): support dynamic default definitions

sxzz · sxzz · commit b5fa18833b22 · 2022-10-28T09:49:27.000+08:00
diff --git a/.changeset/tidy-drinks-jump.md b/.changeset/tidy-drinks-jump.md
@@ -0,0 +1,7 @@
+---
+'@vue-macros/api': patch
+'@vue-macros/better-define': patch
+'@vue-macros/common': patch
+---
+
+support dynamic default definitions of props
diff --git a/packages/api/src/vue/props.ts b/packages/api/src/vue/props.ts
@@ -307,7 +307,6 @@ export async function handleTSPropsDefinition({
         array: true,
         object: true,
         objectMethod: true,
-        unary: true,
       })
     if (!isStatic) return { defaultsAst: defaultsAst as Expression }
 
diff --git a/packages/api/tests/__snapshots__/analyzeSFC.test.ts.snap b/packages/api/tests/__snapshots__/analyzeSFC.test.ts.snap
@@ -581,7 +581,7 @@ exports[`analyzeSFC > defineProps > should resolve referenced type 1`] = `
 }
 `;
 
-exports[`analyzeSFC > defineProps w/ withDefaults 1`] = `
+exports[`analyzeSFC > defineProps w/ withDefaults (static) 1`] = `
 {
   "bar": Node {
     "async": false,
diff --git a/packages/api/tests/analyzeSFC.test.ts b/packages/api/tests/analyzeSFC.test.ts
@@ -335,7 +335,7 @@ describe('analyzeSFC', () => {
     })
   })
 
-  test('defineProps w/ withDefaults', async () => {
+  test('defineProps w/ withDefaults (static)', async () => {
     const { props } = await complie(`withDefaults(defineProps<{
       foo: string
       bar?(): void
@@ -396,6 +396,18 @@ describe('analyzeSFC', () => {
 
     snapshot(props!.defaults)
   })
+
+  test('defineProps w/ withDefaults (dynamic)', async () => {
+    const { props } = await complie(`withDefaults(defineProps<{
+      foo: string
+      bar?: number
+    }>(), {
+      ['b' + 'ar']: 'bar'
+    })`)
+    const defaults = await props!.getRuntimeDefinitions()
+    expect(defaults.bar.default).toBeUndefined()
+    expect(props!.defaults).toBeUndefined()
+  })
   test.todo('mutate defaults')
 
   describe('defineEmits', () => {
diff --git a/packages/better-define/src/core/index.ts b/packages/better-define/src/core/index.ts
@@ -35,13 +35,24 @@ export const transformBetterDefine = async (code: string, id: string) => {
       })
       .join(',\n  ')}\n}`
 
-    s.overwriteNode(
-      props.withDefaultsAst || props.definePropsAst,
-      `defineProps(${runtimeDecls})`,
-      {
+    let decl = runtimeDecls
+    if (props.withDefaultsAst && !props.defaults) {
+      // dynamic defaults
+      decl = `_BD_mergeDefaults(${decl}, ${s.sliceNode(
+        props.withDefaultsAst.arguments[1],
+        { offset }
+      )})`
+      // add helper
+      s.prependLeft(
         offset,
-      }
-    )
+        `import { mergeDefaults as _BD_mergeDefaults } from 'vue'`
+      )
+    }
+    decl = `defineProps(${decl})`
+
+    s.overwriteNode(props.withDefaultsAst || props.definePropsAst, decl, {
+      offset,
+    })
   }
 
   function processEmits(emits: TSEmits) {
diff --git a/packages/better-define/tests/__snapshots__/fixtures.test.ts.snap b/packages/better-define/tests/__snapshots__/fixtures.test.ts.snap
@@ -35,11 +35,42 @@ export { basic as default };
 "
 `;
 
-exports[`fixtures > tests/fixtures/defaults.vue 1`] = `
+exports[`fixtures > tests/fixtures/defaults-dynamic.vue 1`] = `
+"import { defineComponent, mergeDefaults, openBlock, createElementBlock } from 'vue';
+
+var _sfc_main = /* @__PURE__ */ defineComponent({
+  __name: \\"defaults-dynamic\\",
+  props: mergeDefaults({
+    foo: { type: String, required: false }
+  }, {
+    [\\"foo\\"]: \\"foo\\"
+  }),
+  setup(__props) {
+    return (_ctx, _cache) => {
+      return openBlock(), createElementBlock(\\"div\\");
+    };
+  }
+});
+
+var _export_sfc = (sfc, props) => {
+  const target = sfc.__vccOpts || sfc;
+  for (const [key, val] of props) {
+    target[key] = val;
+  }
+  return target;
+};
+
+var defaultsDynamic = /* @__PURE__ */ _export_sfc(_sfc_main, [__FILE__]);
+
+export { defaultsDynamic as default };
+"
+`;
+
+exports[`fixtures > tests/fixtures/defaults-static.vue 1`] = `
 "import { defineComponent, openBlock, createElementBlock } from 'vue';
 
 var _sfc_main = /* @__PURE__ */ defineComponent({
-  __name: \\"defaults\\",
+  __name: \\"defaults-static\\",
   props: {
     foo: { type: String, required: false, default: \\"foo\\" },
     bar: { type: Number, required: false, get default() {
@@ -64,9 +95,9 @@ var _export_sfc = (sfc, props) => {
   return target;
 };
 
-var defaults = /* @__PURE__ */ _export_sfc(_sfc_main, [__FILE__]);
+var defaultsStatic = /* @__PURE__ */ _export_sfc(_sfc_main, [__FILE__]);
 
-export { defaults as default };
+export { defaultsStatic as default };
 "
 `;
 
diff --git a/packages/better-define/tests/fixtures/defaults-dynamic.vue b/packages/better-define/tests/fixtures/defaults-dynamic.vue
@@ -0,0 +1,12 @@
+<script setup lang="ts">
+withDefaults(defineProps<{
+  foo?: string
+
+}>(), {
+  ['f' + 'oo']: 'foo'
+})
+</script>
+
+<template>
+  <div />
+</template>
diff --git a/packages/better-define/tests/fixtures/defaults-static.vue b/packages/better-define/tests/fixtures/defaults-static.vue
diff --git a/packages/common/src/ast.ts b/packages/common/src/ast.ts
@@ -121,7 +121,9 @@ export function isStaticExpression(
     case 'ArrayExpression': // [1, 2]
       return (
         !!array &&
-        node.elements.every((element) => element && isStaticExpression(element))
+        node.elements.every(
+          (element) => element && isStaticExpression(element, options)
+        )
       )
 
     case 'ObjectExpression': // { foo: 1 }
@@ -133,11 +135,11 @@ export function isStaticExpression(
               prop.argument.type === 'ObjectExpression' &&
               isStaticExpression(prop.argument, options)
             )
-          } else if (!isStaticExpression(prop.key) && prop.computed) {
+          } else if (!isLiteralType(prop.key) && prop.computed) {
             return false
           } else if (
             prop.type === 'ObjectProperty' &&
-            !isStaticExpression(prop.value)
+            !isStaticExpression(prop.value, options)
           ) {
             return false
           }
diff --git a/playground/vue3/src/examples/better-define/child.vue b/playground/vue3/src/examples/better-define/child.vue
@@ -11,9 +11,13 @@ withDefaults(
   defineProps<
     Props & {
       union?: string | number
+      nonStaticValue?: string
     }
   >(),
-  { union: 'defaultValue' }
+  {
+    ...{ union: 'defaultValue' },
+    ['non' + 'StaticValue']: 'defaultValue',
+  }
 )
 
 defineEmits<Emits>()
diff --git a/playground/vue3/src/examples/better-define/index.vue b/playground/vue3/src/examples/better-define/index.vue
@@ -1,7 +1,9 @@
 <script setup lang="ts">
 import child from './child.vue'
+import ReactivityTransform from './reactivity-transform.vue'
 </script>
 
 <template>
   <child name="" msg="" :age="10" union="" />
+  <reactivity-transform />
 </template>
diff --git a/playground/vue3/src/examples/better-define/reactivity-transform.vue b/playground/vue3/src/examples/better-define/reactivity-transform.vue
@@ -0,0 +1,11 @@
+<script setup lang="ts">
+const { foo = 'foo' } = defineProps<{
+  foo?: string
+}>()
+
+console.log(foo)
+</script>
+
+<template>
+  {{ foo }}
+</template>

Original file line number	Diff line number	Diff line change
@@ -581,7 +581,7 @@ exports[`analyzeSFC > defineProps > should resolve referenced type 1`] = `
`581`	`581`	`}`
`582`	`582`	`;
`583`	`583`
`584`		-exports[`analyzeSFC > defineProps w/ withDefaults 1`] = `
	`584`	+exports[`analyzeSFC > defineProps w/ withDefaults (static) 1`] = `
`585`	`585`	`{`
`586`	`586`	`"bar": Node {`
`587`	`587`	`"async": false,`
Original file line number	Diff line number	Diff line change
`@@ -11,9 +11,13 @@ withDefaults(`
`11`	`11`	`defineProps<`
`12`	`12`	`Props & {`
`13`	`13`	`union?: string \| number`
	`14`	`+ nonStaticValue?: string`
`14`	`15`	`}`
`15`	`16`	`>(),`
`16`		`- { union: 'defaultValue' }`
	`17`	`+ {`
	`18`	`+ ...{ union: 'defaultValue' },`
	`19`	`+ ['non' + 'StaticValue']: 'defaultValue',`
	`20`	`+ }`
`17`	`21`	`)`
`18`	`22`
`19`	`23`	`defineEmits<Emits>()`