Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

types(runtime-core): fix type constraints for default in PropOptions #12227

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

jh-leong
Copy link
Member

close #12145

Correct the default field type to prevent assigning arbitrary objects.

refix #1891. If type specifies a Function, the default field type should match the specified function type.


NOTE: Due to TypeScript's literal-inference, when type is a literal type, the default cannot be strictly enforced.

Consider the following example:

// `foo.default` is inferred as `string` instead of the literal type `'foo'`
const foo = {
  type: String as PropType<'foo' | 'bar'>,
  default: 'foo',
}

// Strictly enforcing `default` to be `'foo' | 'bar'` would break existing cases:
defineComponent({
  props: { foo }, // should allow
})

Copy link

Size Report

Bundles

File Size Gzip Brotli
runtime-dom.global.prod.js 100 kB 38 kB 34.2 kB
vue.global.prod.js 159 kB 57.9 kB 51.4 kB

Usages

Name Size Gzip Brotli
createApp (CAPI only) 46.9 kB 18.3 kB 16.7 kB
createApp 55 kB 21.3 kB 19.4 kB
createSSRApp 59 kB 23 kB 20.9 kB
defineCustomElement 59.8 kB 22.8 kB 20.8 kB
overall 68.7 kB 26.3 kB 24 kB

Copy link

pkg-pr-new bot commented Oct 21, 2024

Open in Stackblitz

@vue/compiler-core

pnpm add https://pkg.pr.new/@vue/compiler-core@12227

@vue/compiler-dom

pnpm add https://pkg.pr.new/@vue/compiler-dom@12227

@vue/compiler-sfc

pnpm add https://pkg.pr.new/@vue/compiler-sfc@12227

@vue/reactivity

pnpm add https://pkg.pr.new/@vue/reactivity@12227

@vue/compiler-ssr

pnpm add https://pkg.pr.new/@vue/compiler-ssr@12227

@vue/runtime-core

pnpm add https://pkg.pr.new/@vue/runtime-core@12227

@vue/runtime-dom

pnpm add https://pkg.pr.new/@vue/runtime-dom@12227

@vue/server-renderer

pnpm add https://pkg.pr.new/@vue/server-renderer@12227

@vue/shared

pnpm add https://pkg.pr.new/@vue/shared@12227

vue

pnpm add https://pkg.pr.new/vue@12227

@vue/compat

pnpm add https://pkg.pr.new/@vue/compat@12227

commit: 609d33b

@jh-leong
Copy link
Member Author

/ecosystem-ci run

@vue-bot
Copy link
Contributor

vue-bot commented Oct 21, 2024

📝 Ran ecosystem CI: Open

suite result latest scheduled
language-tools failure success
nuxt success success
pinia success success
primevue success success
quasar success success
radix-vue success success
router success success
test-utils success success
vant success success
vite-plugin-vue success success
vitepress success success
vue-i18n success success
vue-macros success success
vuetify success success
vueuse success success
vue-simple-compiler success success

@jh-leong
Copy link
Member Author

/ecosystem-ci run language-tools

@vue-bot
Copy link
Contributor

vue-bot commented Oct 21, 2024

📝 Ran ecosystem CI: Open

suite result latest scheduled
language-tools failure success

@jh-leong
Copy link
Member Author

/ecosystem-ci run language-tools

@vue-bot
Copy link
Contributor

vue-bot commented Oct 21, 2024

📝 Ran ecosystem CI: Open

suite result latest scheduled
language-tools success success

@jh-leong jh-leong added scope: types 🍰 p2-nice-to-have Priority 2: this is not breaking anything but nice to have it addressed. labels Oct 21, 2024
@jh-leong jh-leong marked this pull request as draft October 22, 2024 01:38
@jh-leong
Copy link
Member Author

/ecosystem-ci run

@vue-bot
Copy link
Contributor

vue-bot commented Oct 22, 2024

📝 Ran ecosystem CI: Open

suite result latest scheduled
language-tools success success
nuxt success success
pinia success success
primevue success success
quasar success success
radix-vue success success
router success success
test-utils success success
vant success success
vite-plugin-vue success success
vitepress success success
vue-i18n success success
vue-macros success success
vuetify success success
vueuse success success
vue-simple-compiler success success

@jh-leong jh-leong changed the title types(runtime-core): fix type restriction for default in PropOptions types(runtime-core): fix type constraints for default in PropOptions Oct 22, 2024
@jh-leong jh-leong marked this pull request as ready for review October 22, 2024 02:44
@edison1105 edison1105 added the ready to merge The PR is ready to be merged. label Oct 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🍰 p2-nice-to-have Priority 2: this is not breaking anything but nice to have it addressed. ready to merge The PR is ready to be merged. scope: types
Projects
None yet
Development

Successfully merging this pull request may close these issues.

defineModel() wrong 'default' type
3 participants