123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578 |
- import { BindingTypes } from '../src/types'
- import { compile, assertCode } from './util'
- describe('SFC compile <script setup>', () => {
- test('should expose top level declarations', () => {
- const { content, bindings } = compile(`
- <script setup>
- import { x } from './x'
- let a = 1
- const b = 2
- function c() {}
- class d {}
- </script>
- <script>
- import { xx } from './x'
- let aa = 1
- const bb = 2
- function cc() {}
- class dd {}
- </script>
- `)
- expect(content).toMatch('return { aa, bb, cc, dd, a, b, c, d, xx, x }')
- expect(bindings).toStrictEqual({
- x: BindingTypes.SETUP_MAYBE_REF,
- a: BindingTypes.SETUP_LET,
- b: BindingTypes.SETUP_CONST,
- c: BindingTypes.SETUP_CONST,
- d: BindingTypes.SETUP_CONST,
- xx: BindingTypes.SETUP_MAYBE_REF,
- aa: BindingTypes.SETUP_LET,
- bb: BindingTypes.SETUP_CONST,
- cc: BindingTypes.SETUP_CONST,
- dd: BindingTypes.SETUP_CONST
- })
- assertCode(content)
- })
- test('binding analysis for destructure', () => {
- const { content, bindings } = compile(`
- <script setup>
- const { foo, b: bar, ['x' + 'y']: baz, x: { y, zz: { z }}} = {}
- </script>
- `)
- expect(content).toMatch('return { foo, bar, baz, y, z }')
- expect(bindings).toStrictEqual({
- foo: BindingTypes.SETUP_MAYBE_REF,
- bar: BindingTypes.SETUP_MAYBE_REF,
- baz: BindingTypes.SETUP_MAYBE_REF,
- y: BindingTypes.SETUP_MAYBE_REF,
- z: BindingTypes.SETUP_MAYBE_REF
- })
- assertCode(content)
- })
- test('defineProps()', () => {
- const { content, bindings } = compile(`
- <script setup>
- const props = defineProps({
- foo: String
- })
- const bar = 1
- </script>
- `)
- // should generate working code
- assertCode(content)
- // should analyze bindings
- expect(bindings).toStrictEqual({
- foo: BindingTypes.PROPS,
- bar: BindingTypes.SETUP_CONST,
- props: BindingTypes.SETUP_REACTIVE_CONST
- })
- // should remove defineOptions import and call
- expect(content).not.toMatch('defineProps')
- // should generate correct setup signature
- expect(content).toMatch(`setup(__props) {`)
- // should assign user identifier to it
- expect(content).toMatch(`const props = __props`)
- // should include context options in default export
- expect(content).toMatch(`export default {
- props: {
- foo: String
- },`)
- })
- test('defineProps w/ external definition', () => {
- const { content } = compile(`
- <script setup>
- import { propsModel } from './props'
- const props = defineProps(propsModel)
- </script>
- `)
- assertCode(content)
- expect(content).toMatch(`export default {
- props: propsModel,`)
- })
- // #4764
- test('defineProps w/ leading code', () => {
- const { content } = compile(`
- <script setup>import { x } from './x'
- const props = defineProps({})
- </script>
- `)
- // props declaration should be inside setup, not moved along with the import
- expect(content).not.toMatch(`const props = __props\nimport`)
- assertCode(content)
- })
- test('defineEmits()', () => {
- const { content, bindings } = compile(`
- <script setup>
- const myEmit = defineEmits(['foo', 'bar'])
- </script>
- `)
- assertCode(content)
- expect(bindings).toStrictEqual({
- myEmit: BindingTypes.SETUP_CONST
- })
- // should remove defineOptions import and call
- expect(content).not.toMatch('defineEmits')
- // should generate correct setup signature
- expect(content).toMatch(`setup(__props, { emit: myEmit }) {`)
- // should include context options in default export
- expect(content).toMatch(`export default {
- emits: ['foo', 'bar'],`)
- })
- test('defineProps/defineEmits in multi-variable declaration', () => {
- const { content } = compile(`
- <script setup>
- const props = defineProps(['item']),
- a = 1,
- emit = defineEmits(['a']);
- </script>
- `)
- assertCode(content)
- expect(content).toMatch(`const a = 1;`) // test correct removal
- expect(content).toMatch(`props: ['item'],`)
- expect(content).toMatch(`emits: ['a'],`)
- })
- test('defineProps/defineEmits in multi-variable declaration (full removal)', () => {
- const { content } = compile(`
- <script setup>
- const props = defineProps(['item']),
- emit = defineEmits(['a']);
- </script>
- `)
- assertCode(content)
- expect(content).toMatch(`props: ['item'],`)
- expect(content).toMatch(`emits: ['a'],`)
- })
- test('defineExpose()', () => {
- const { content } = compile(`
- <script setup>
- defineExpose({ foo: 123 })
- </script>
- `)
- assertCode(content)
- // should remove defineOptions import and call
- expect(content).not.toMatch('defineExpose')
- // should generate correct setup signature
- expect(content).toMatch(`setup(__props, { expose }) {`)
- // should replace callee
- expect(content).toMatch(/\bexpose\(\{ foo: 123 \}\)/)
- })
- test('<script> after <script setup> the script content not end with `\\n`', () => {
- const { content } = compile(`
- <script setup>
- import { x } from './x'
- </script>
- <script>const n = 1</script>
- `)
- assertCode(content)
- })
- describe('<script> and <script setup> co-usage', () => {
- test('script first', () => {
- const { content } = compile(`
- <script>
- export const n = 1
- export default {}
- </script>
- <script setup>
- import { x } from './x'
- x()
- </script>
- `)
- assertCode(content)
- })
- test('script setup first', () => {
- const { content } = compile(`
- <script setup>
- import { x } from './x'
- x()
- </script>
- <script>
- export const n = 1
- export default {}
- </script>
- `)
- assertCode(content)
- })
- test('script setup first, named default export', () => {
- const { content } = compile(`
- <script setup>
- import { x } from './x'
- x()
- </script>
- <script>
- export const n = 1
- const def = {}
- export { def as default }
- </script>
- `)
- assertCode(content)
- })
- // #4395
- test('script setup first, lang="ts", script block content export default', () => {
- const { content } = compile(`
- <script setup lang="ts">
- import { x } from './x'
- x()
- </script>
- <script lang="ts">
- export default {
- name: "test"
- }
- </script>
- `)
- // ensure __default__ is declared before used
- expect(content).toMatch(/const __default__[\S\s]*\.\.\.__default__/m)
- assertCode(content)
- })
- describe('spaces in ExportDefaultDeclaration node', () => {
- // #4371
- test('with many spaces and newline', () => {
- // #4371
- const { content } = compile(`
- <script>
- export const n = 1
- export default
- {
- some:'option'
- }
- </script>
- <script setup>
- import { x } from './x'
- x()
- </script>
- `)
- assertCode(content)
- })
- test('with minimal spaces', () => {
- const { content } = compile(`
- <script>
- export const n = 1
- export default{
- some:'option'
- }
- </script>
- <script setup>
- import { x } from './x'
- x()
- </script>
- `)
- assertCode(content)
- })
- })
- })
- describe('imports', () => {
- test('should hoist and expose imports', () => {
- assertCode(
- compile(`<script setup>
- import { ref } from 'vue'
- import 'foo/css'
- </script>`).content
- )
- })
- test('should extract comment for import or type declarations', () => {
- assertCode(
- compile(`
- <script setup>
- import a from 'a' // comment
- import b from 'b'
- </script>
- `).content
- )
- })
- // #2740
- test('should allow defineProps/Emit at the start of imports', () => {
- assertCode(
- compile(`<script setup>
- import { ref } from 'vue'
- defineProps(['foo'])
- defineEmits(['bar'])
- const r = ref(0)
- </script>`).content
- )
- })
- test('import dedupe between <script> and <script setup>', () => {
- const { content } = compile(`
- <script>
- import { x } from './x'
- </script>
- <script setup>
- import { x } from './x'
- x()
- </script>
- `)
- assertCode(content)
- expect(content.indexOf(`import { x }`)).toEqual(
- content.lastIndexOf(`import { x }`)
- )
- })
- })
- // in dev mode, declared bindings are returned as an object from setup()
- // when using TS, users may import types which should not be returned as
- // values, so we need to check import usage in the template to determine
- // what to be returned.
- describe('dev mode import usage check', () => {
- test('components', () => {
- const { content } = compile(`
- <script setup lang="ts">
- import { FooBar, FooBaz, FooQux, foo } from './x'
- const fooBar: FooBar = 1
- </script>
- <template>
- <FooBaz></FooBaz>
- <foo-qux/>
- <foo/>
- FooBar
- </template>
- `)
- // FooBar: should not be matched by plain text or incorrect case
- // FooBaz: used as PascalCase component
- // FooQux: used as kebab-case component
- // foo: lowercase component
- expect(content).toMatch(`return { fooBar, FooBaz, FooQux, foo }`)
- assertCode(content)
- })
- test('directive', () => {
- const { content } = compile(`
- <script setup lang="ts">
- import { vMyDir } from './x'
- </script>
- <template>
- <div v-my-dir></div>
- </template>
- `)
- expect(content).toMatch(`return { vMyDir }`)
- assertCode(content)
- })
- // https://github.com/vuejs/core/issues/4599
- test('attribute expressions', () => {
- const { content } = compile(`
- <script setup lang="ts">
- import { bar, baz } from './x'
- const cond = true
- </script>
- <template>
- <div :class="[cond ? '' : bar(), 'default']" :style="baz"></div>
- </template>
- `)
- expect(content).toMatch(`return { cond, bar, baz }`)
- assertCode(content)
- })
- test('vue interpolations', () => {
- const { content } = compile(`
- <script setup lang="ts">
- import { x, y, z, x$y } from './x'
- </script>
- <template>
- <div :id="z + 'y'">{{ x }} {{ yy }} {{ x$y }}</div>
- </template>
- `)
- // x: used in interpolation
- // y: should not be matched by {{ yy }} or 'y' in binding exps
- // x$y: #4274 should escape special chars when creating Regex
- expect(content).toMatch(`return { x, z, x$y }`)
- assertCode(content)
- })
- // #4340 interpolations in template strings
- test('js template string interpolations', () => {
- const { content } = compile(`
- <script setup lang="ts">
- import { VAR, VAR2, VAR3 } from './x'
- </script>
- <template>
- {{ \`\${VAR}VAR2\${VAR3}\` }}
- </template>
- `)
- // VAR2 should not be matched
- expect(content).toMatch(`return { VAR, VAR3 }`)
- assertCode(content)
- })
- // edge case: last tag in template
- test('last tag', () => {
- const { content } = compile(`
- <script setup lang="ts">
- import { FooBaz, Last } from './x'
- </script>
- <template>
- <FooBaz></FooBaz>
- <Last/>
- </template>
- `)
- expect(content).toMatch(`return { FooBaz, Last }`)
- assertCode(content)
- })
- test('TS annotations', () => {
- const { content } = compile(`
- <script setup lang="ts">
- import { Foo, Baz, Qux, Fred } from './x'
- const a = 1
- function b() {}
- </script>
- <template>
- {{ a as Foo }}
- {{ Baz }}
- <Comp v-slot="{ data }: Qux">{{ data }}</Comp>
- <div v-for="{ z = x as Qux } in list as Fred"/>
- </template>
- `)
- expect(content).toMatch(`return { a, b, Baz }`)
- assertCode(content)
- })
- })
- // describe('inlineTemplate mode', () => {
- // test('should work', () => {
- // const { content } = compile(
- // `
- // <script setup>
- // import { ref } from 'vue'
- // const count = ref(0)
- // </script>
- // <template>
- // <div>{{ count }}</div>
- // <div>static</div>
- // </template>
- // `,
- // { inlineTemplate: true }
- // )
- // // check snapshot and make sure helper imports and
- // // hoists are placed correctly.
- // assertCode(content)
- // // in inline mode, no need to call expose() since nothing is exposed
- // // anyway!
- // expect(content).not.toMatch(`expose()`)
- // })
- // test('with defineExpose()', () => {
- // const { content } = compile(
- // `
- // <script setup>
- // const count = ref(0)
- // defineExpose({ count })
- // </script>
- // `,
- // { inlineTemplate: true }
- // )
- // assertCode(content)
- // expect(content).toMatch(`setup(__props, { expose })`)
- // expect(content).toMatch(`expose({ count })`)
- // })
- // test('referencing scope components and directives', () => {
- // const { content } = compile(
- // `
- // <script setup>
- // import ChildComp from './Child.vue'
- // import SomeOtherComp from './Other.vue'
- // import vMyDir from './my-dir'
- // </script>
- // <template>
- // <div v-my-dir></div>
- // <ChildComp/>
- // <some-other-comp/>
- // </template>
- // `,
- // { inlineTemplate: true }
- // )
- // expect(content).toMatch('[_unref(vMyDir)]')
- // expect(content).toMatch('_createVNode(ChildComp)')
- // // kebab-case component support
- // expect(content).toMatch('_createVNode(SomeOtherComp)')
- // assertCode(content)
- // })
- // test('avoid unref() when necessary', () => {
- // // function, const, component import
- // const { content } = compile(
- // `<script setup>
- // import { ref } from 'vue'
- // import Foo, { bar } from './Foo.vue'
- // import other from './util'
- // import * as tree from './tree'
- // const count = ref(0)
- // const constant = {}
- // const maybe = foo()
- // let lett = 1
- // function fn() {}
- // </script>
- // <template>
- // <Foo>{{ bar }}</Foo>
- // <div @click="fn">{{ count }} {{ constant }} {{ maybe }} {{ lett }} {{ other }}</div>
- // {{ tree.foo() }}
- // </template>
- // `,
- // { inlineTemplate: true }
- // )
- // // no need to unref vue component import
- // expect(content).toMatch(`createVNode(Foo,`)
- // // #2699 should unref named imports from .vue
- // expect(content).toMatch(`unref(bar)`)
- // // should unref other imports
- // expect(content).toMatch(`unref(other)`)
- // // no need to unref constant literals
- // expect(content).not.toMatch(`unref(constant)`)
- // // should directly use .value for known refs
- // expect(content).toMatch(`count.value`)
- // // should unref() on const bindings that may be refs
- // expect(content).toMatch(`unref(maybe)`)
- // // should unref() on let bindings
- // expect(content).toMatch(`unref(lett)`)
- // // no need to unref namespace import (this also preserves tree-shaking)
- // expect(content).toMatch(`tree.foo()`)
- // // no need to unref function declarations
- // expect(content).toMatch(`{ onClick: fn }`)
- // // no need to mark constant fns in patch flag
- // expect(content).not.toMatch(`PROPS`)
- // assertCode(content)
- // })
- // test('v-model codegen', () => {
- // const { content } = compile(
- // `<script setup>
- // import { ref } from 'vue'
- // const count = ref(0)
- // const maybe = foo()
- // let lett = 1
- // </script>
- // <template>
- // <input v-model="count">
- // <input v-model="maybe">
- // <input v-model="lett">
- // </template>
- // `,
- // { inlineTemplate: true }
- // )
- // // known const ref: set value
- // expect(content).toMatch(`(count).value = $event`)
- // // const but maybe ref: assign if ref, otherwise do nothing
- // expect(content).toMatch(`_isRef(maybe) ? (maybe).value = $event : null`)
- // // let: handle both cases
- // expect(content).toMatch(
- // `_isRef(lett) ? (lett).value = $event : lett = $event`
- // )
- // assertCode(content)
- // })
- // test('template assignment expression codegen', () => {
- // const { content } = compile(
- // `<script setup>
- // import { ref } from 'vue'
- // const count = ref(0)
- // const maybe = foo()
- // let lett = 1
- // let v = ref(1)
- // </script>
- // <template>
- // <div @click="count = 1"/>
- // <div @click="maybe = count"/>
- // <div @click="lett = count"/>
- // <div @click="v += 1"/>
- // <div @click="v -= 1"/>
- // <div @click="() => {
- // let a = '' + lett
- // v = a
- // }"/>
- // <div @click="() => {
- // // nested scopes
- // (()=>{
- // let x = a
- // (()=>{
- // let z = x
- // let z2 = z
- // })
- // let lz = z
- // })
- // v = a
- // }"/>
- // </template>
- // `,
- // { inlineTemplate: true }
- // )
- // // known const ref: set value
- // expect(content).toMatch(`count.value = 1`)
- // // const but maybe ref: only assign after check
- // expect(content).toMatch(`maybe.value = count.value`)
- // // let: handle both cases
- // expect(content).toMatch(
- // `_isRef(lett) ? lett.value = count.value : lett = count.value`
- // )
- // expect(content).toMatch(`_isRef(v) ? v.value += 1 : v += 1`)
- // expect(content).toMatch(`_isRef(v) ? v.value -= 1 : v -= 1`)
- // expect(content).toMatch(`_isRef(v) ? v.value = a : v = a`)
- // expect(content).toMatch(`_isRef(v) ? v.value = _ctx.a : v = _ctx.a`)
- // assertCode(content)
- // })
- // test('template update expression codegen', () => {
- // const { content } = compile(
- // `<script setup>
- // import { ref } from 'vue'
- // const count = ref(0)
- // const maybe = foo()
- // let lett = 1
- // </script>
- // <template>
- // <div @click="count++"/>
- // <div @click="--count"/>
- // <div @click="maybe++"/>
- // <div @click="--maybe"/>
- // <div @click="lett++"/>
- // <div @click="--lett"/>
- // </template>
- // `,
- // { inlineTemplate: true }
- // )
- // // known const ref: set value
- // expect(content).toMatch(`count.value++`)
- // expect(content).toMatch(`--count.value`)
- // // const but maybe ref (non-ref case ignored)
- // expect(content).toMatch(`maybe.value++`)
- // expect(content).toMatch(`--maybe.value`)
- // // let: handle both cases
- // expect(content).toMatch(`_isRef(lett) ? lett.value++ : lett++`)
- // expect(content).toMatch(`_isRef(lett) ? --lett.value : --lett`)
- // assertCode(content)
- // })
- // test('template destructure assignment codegen', () => {
- // const { content } = compile(
- // `<script setup>
- // import { ref } from 'vue'
- // const val = {}
- // const count = ref(0)
- // const maybe = foo()
- // let lett = 1
- // </script>
- // <template>
- // <div @click="({ count } = val)"/>
- // <div @click="[maybe] = val"/>
- // <div @click="({ lett } = val)"/>
- // </template>
- // `,
- // { inlineTemplate: true }
- // )
- // // known const ref: set value
- // expect(content).toMatch(`({ count: count.value } = val)`)
- // // const but maybe ref (non-ref case ignored)
- // expect(content).toMatch(`[maybe.value] = val`)
- // // let: assumes non-ref
- // expect(content).toMatch(`{ lett: lett } = val`)
- // assertCode(content)
- // })
- // test('ssr codegen', () => {
- // const { content } = compile(
- // `
- // <script setup>
- // import { ref } from 'vue'
- // const count = ref(0)
- // </script>
- // <template>
- // <div>{{ count }}</div>
- // <div>static</div>
- // </template>
- // <style>
- // div { color: v-bind(count) }
- // </style>
- // `,
- // {
- // inlineTemplate: true,
- // templateOptions: {
- // ssr: true
- // }
- // }
- // )
- // expect(content).toMatch(`\n __ssrInlineRender: true,\n`)
- // expect(content).toMatch(`return (_ctx, _push`)
- // expect(content).toMatch(`ssrInterpolate`)
- // expect(content).not.toMatch(`useCssVars`)
- // expect(content).toMatch(`"--${mockId}-count": (count.value)`)
- // assertCode(content)
- // })
- // })
- describe('with TypeScript', () => {
- test('hoist type declarations', () => {
- const { content } = compile(`
- <script setup lang="ts">
- export interface Foo {}
- type Bar = {}
- </script>`)
- assertCode(content)
- })
- test('defineProps/Emit w/ runtime options', () => {
- const { content } = compile(`
- <script setup lang="ts">
- const props = defineProps({ foo: String })
- const emit = defineEmits(['a', 'b'])
- </script>
- `)
- assertCode(content)
- expect(content).toMatch(`export default /*#__PURE__*/_defineComponent({
- props: { foo: String },
- emits: ['a', 'b'],
- setup(__props, { emit }) {`)
- })
- test('defineProps w/ type', () => {
- const { content, bindings } = compile(`
- <script setup lang="ts">
- interface Test {}
- type Alias = number[]
- defineProps<{
- string: string
- number: number
- boolean: boolean
- object: object
- objectLiteral: { a: number }
- fn: (n: number) => void
- functionRef: Function
- objectRef: Object
- dateTime: Date
- array: string[]
- arrayRef: Array<any>
- tuple: [number, number]
- set: Set<string>
- literal: 'foo'
- optional?: any
- recordRef: Record<string, null>
- interface: Test
- alias: Alias
- method(): void
- symbol: symbol
- union: string | number
- literalUnion: 'foo' | 'bar'
- literalUnionNumber: 1 | 2 | 3 | 4 | 5
- literalUnionMixed: 'foo' | 1 | boolean
- intersection: Test & {}
- foo: ((item: any) => boolean) | null
- }>()
- </script>`)
- assertCode(content)
- expect(content).toMatch(`string: { type: String, required: true }`)
- expect(content).toMatch(`number: { type: Number, required: true }`)
- expect(content).toMatch(`boolean: { type: Boolean, required: true }`)
- expect(content).toMatch(`object: { type: Object, required: true }`)
- expect(content).toMatch(`objectLiteral: { type: Object, required: true }`)
- expect(content).toMatch(`fn: { type: Function, required: true }`)
- expect(content).toMatch(`functionRef: { type: Function, required: true }`)
- expect(content).toMatch(`objectRef: { type: Object, required: true }`)
- expect(content).toMatch(`dateTime: { type: Date, required: true }`)
- expect(content).toMatch(`array: { type: Array, required: true }`)
- expect(content).toMatch(`arrayRef: { type: Array, required: true }`)
- expect(content).toMatch(`tuple: { type: Array, required: true }`)
- expect(content).toMatch(`set: { type: Set, required: true }`)
- expect(content).toMatch(`literal: { type: String, required: true }`)
- expect(content).toMatch(`optional: { type: null, required: false }`)
- expect(content).toMatch(`recordRef: { type: Object, required: true }`)
- expect(content).toMatch(`interface: { type: Object, required: true }`)
- expect(content).toMatch(`alias: { type: Array, required: true }`)
- expect(content).toMatch(`method: { type: Function, required: true }`)
- expect(content).toMatch(`symbol: { type: Symbol, required: true }`)
- expect(content).toMatch(
- `union: { type: [String, Number], required: true }`
- )
- expect(content).toMatch(`literalUnion: { type: String, required: true }`)
- expect(content).toMatch(
- `literalUnionNumber: { type: Number, required: true }`
- )
- expect(content).toMatch(
- `literalUnionMixed: { type: [String, Number, Boolean], required: true }`
- )
- expect(content).toMatch(`intersection: { type: Object, required: true }`)
- expect(content).toMatch(`foo: { type: [Function, null], required: true }`)
- expect(bindings).toStrictEqual({
- string: BindingTypes.PROPS,
- number: BindingTypes.PROPS,
- boolean: BindingTypes.PROPS,
- object: BindingTypes.PROPS,
- objectLiteral: BindingTypes.PROPS,
- fn: BindingTypes.PROPS,
- functionRef: BindingTypes.PROPS,
- objectRef: BindingTypes.PROPS,
- dateTime: BindingTypes.PROPS,
- array: BindingTypes.PROPS,
- arrayRef: BindingTypes.PROPS,
- tuple: BindingTypes.PROPS,
- set: BindingTypes.PROPS,
- literal: BindingTypes.PROPS,
- optional: BindingTypes.PROPS,
- recordRef: BindingTypes.PROPS,
- interface: BindingTypes.PROPS,
- alias: BindingTypes.PROPS,
- method: BindingTypes.PROPS,
- symbol: BindingTypes.PROPS,
- union: BindingTypes.PROPS,
- literalUnion: BindingTypes.PROPS,
- literalUnionNumber: BindingTypes.PROPS,
- literalUnionMixed: BindingTypes.PROPS,
- intersection: BindingTypes.PROPS,
- foo: BindingTypes.PROPS
- })
- })
- test('defineProps w/ interface', () => {
- const { content, bindings } = compile(`
- <script setup lang="ts">
- interface Props { x?: number }
- defineProps<Props>()
- </script>
- `)
- assertCode(content)
- expect(content).toMatch(`x: { type: Number, required: false }`)
- expect(bindings).toStrictEqual({
- x: BindingTypes.PROPS
- })
- })
- test('defineProps w/ exported interface', () => {
- const { content, bindings } = compile(`
- <script setup lang="ts">
- export interface Props { x?: number }
- defineProps<Props>()
- </script>
- `)
- assertCode(content)
- expect(content).toMatch(`x: { type: Number, required: false }`)
- expect(bindings).toStrictEqual({
- x: BindingTypes.PROPS
- })
- })
- test('defineProps w/ exported interface in normal script', () => {
- const { content, bindings } = compile(`
- <script lang="ts">
- export interface Props { x?: number }
- </script>
- <script setup lang="ts">
- defineProps<Props>()
- </script>
- `)
- assertCode(content)
- expect(content).toMatch(`x: { type: Number, required: false }`)
- expect(bindings).toStrictEqual({
- x: BindingTypes.PROPS
- })
- })
- test('defineProps w/ type alias', () => {
- const { content, bindings } = compile(`
- <script setup lang="ts">
- type Props = { x?: number }
- defineProps<Props>()
- </script>
- `)
- assertCode(content)
- expect(content).toMatch(`x: { type: Number, required: false }`)
- expect(bindings).toStrictEqual({
- x: BindingTypes.PROPS
- })
- })
- test('defineProps w/ exported type alias', () => {
- const { content, bindings } = compile(`
- <script setup lang="ts">
- export type Props = { x?: number }
- defineProps<Props>()
- </script>
- `)
- assertCode(content)
- expect(content).toMatch(`x: { type: Number, required: false }`)
- expect(bindings).toStrictEqual({
- x: BindingTypes.PROPS
- })
- })
- test('withDefaults (static)', () => {
- const { content, bindings } = compile(`
- <script setup lang="ts">
- const props = withDefaults(defineProps<{
- foo?: string
- bar?: number;
- baz: boolean;
- qux?(): number
- }>(), {
- foo: 'hi',
- qux() { return 1 }
- })
- </script>
- `)
- assertCode(content)
- expect(content).toMatch(
- `foo: { type: String, required: false, default: 'hi' }`
- )
- expect(content).toMatch(`bar: { type: Number, required: false }`)
- expect(content).toMatch(`baz: { type: Boolean, required: true }`)
- expect(content).toMatch(
- `qux: { type: Function, required: false, default() { return 1 } }`
- )
- expect(content).toMatch(
- `{ foo: string, bar?: number, baz: boolean, qux(): number }`
- )
- expect(content).toMatch(`const props = __props`)
- expect(bindings).toStrictEqual({
- foo: BindingTypes.PROPS,
- bar: BindingTypes.PROPS,
- baz: BindingTypes.PROPS,
- qux: BindingTypes.PROPS,
- props: BindingTypes.SETUP_CONST
- })
- })
- test('withDefaults (dynamic)', () => {
- const { content } = compile(`
- <script setup lang="ts">
- import { defaults } from './foo'
- const props = withDefaults(defineProps<{
- foo?: string
- bar?: number
- baz: boolean
- }>(), { ...defaults })
- </script>
- `)
- assertCode(content)
- expect(content).toMatch(`import { mergeDefaults as _mergeDefaults`)
- expect(content).toMatch(
- `
- _mergeDefaults({
- foo: { type: String, required: false },
- bar: { type: Number, required: false },
- baz: { type: Boolean, required: true }
- }, { ...defaults })`.trim()
- )
- })
- test('defineEmits w/ type', () => {
- const { content } = compile(`
- <script setup lang="ts">
- const emit = defineEmits<(e: 'foo' | 'bar') => void>()
- </script>
- `)
- assertCode(content)
- expect(content).toMatch(`emit: ((e: 'foo' | 'bar') => void),`)
- expect(content).toMatch(`emits: ["foo", "bar"]`)
- })
- test('defineEmits w/ type (union)', () => {
- const type = `((e: 'foo' | 'bar') => void) | ((e: 'baz', id: number) => void)`
- expect(() =>
- compile(`
- <script setup lang="ts">
- const emit = defineEmits<${type}>()
- </script>
- `)
- ).toThrow()
- })
- test('defineEmits w/ type (type literal w/ call signatures)', () => {
- const type = `{(e: 'foo' | 'bar'): void; (e: 'baz', id: number): void;}`
- const { content } = compile(`
- <script setup lang="ts">
- const emit = defineEmits<${type}>()
- </script>
- `)
- assertCode(content)
- expect(content).toMatch(`emit: (${type}),`)
- expect(content).toMatch(`emits: ["foo", "bar", "baz"]`)
- })
- test('defineEmits w/ type (interface)', () => {
- const { content } = compile(`
- <script setup lang="ts">
- interface Emits { (e: 'foo' | 'bar'): void }
- const emit = defineEmits<Emits>()
- </script>
- `)
- assertCode(content)
- expect(content).toMatch(`emit: ({ (e: 'foo' | 'bar'): void }),`)
- expect(content).toMatch(`emits: ["foo", "bar"]`)
- })
- test('defineEmits w/ type (exported interface)', () => {
- const { content } = compile(`
- <script setup lang="ts">
- export interface Emits { (e: 'foo' | 'bar'): void }
- const emit = defineEmits<Emits>()
- </script>
- `)
- assertCode(content)
- expect(content).toMatch(`emit: ({ (e: 'foo' | 'bar'): void }),`)
- expect(content).toMatch(`emits: ["foo", "bar"]`)
- })
- test('defineEmits w/ type (type alias)', () => {
- const { content } = compile(`
- <script setup lang="ts">
- type Emits = { (e: 'foo' | 'bar'): void }
- const emit = defineEmits<Emits>()
- </script>
- `)
- assertCode(content)
- expect(content).toMatch(`emit: ({ (e: 'foo' | 'bar'): void }),`)
- expect(content).toMatch(`emits: ["foo", "bar"]`)
- })
- test('defineEmits w/ type (exported type alias)', () => {
- const { content } = compile(`
- <script setup lang="ts">
- export type Emits = { (e: 'foo' | 'bar'): void }
- const emit = defineEmits<Emits>()
- </script>
- `)
- assertCode(content)
- expect(content).toMatch(`emit: ({ (e: 'foo' | 'bar'): void }),`)
- expect(content).toMatch(`emits: ["foo", "bar"]`)
- })
- test('defineEmits w/ type (referenced function type)', () => {
- const { content } = compile(`
- <script setup lang="ts">
- type Emits = (e: 'foo' | 'bar') => void
- const emit = defineEmits<Emits>()
- </script>
- `)
- assertCode(content)
- expect(content).toMatch(`emit: ((e: 'foo' | 'bar') => void),`)
- expect(content).toMatch(`emits: ["foo", "bar"]`)
- })
- test('defineEmits w/ type (referenced exported function type)', () => {
- const { content } = compile(`
- <script setup lang="ts">
- export type Emits = (e: 'foo' | 'bar') => void
- const emit = defineEmits<Emits>()
- </script>
- `)
- assertCode(content)
- expect(content).toMatch(`emit: ((e: 'foo' | 'bar') => void),`)
- expect(content).toMatch(`emits: ["foo", "bar"]`)
- })
- test('runtime Enum', () => {
- const { content, bindings } = compile(
- `<script setup lang="ts">
- enum Foo { A = 123 }
- </script>`
- )
- assertCode(content)
- expect(bindings).toStrictEqual({
- Foo: BindingTypes.SETUP_CONST
- })
- })
- test('runtime Enum in normal script', () => {
- const { content, bindings } = compile(
- `<script lang="ts">
- export enum D { D = "D" }
- const enum C { C = "C" }
- enum B { B = "B" }
- </script>
- <script setup lang="ts">
- enum Foo { A = 123 }
- </script>`
- )
- assertCode(content)
- expect(bindings).toStrictEqual({
- D: BindingTypes.SETUP_CONST,
- C: BindingTypes.SETUP_CONST,
- B: BindingTypes.SETUP_CONST,
- Foo: BindingTypes.SETUP_CONST
- })
- })
- test('const Enum', () => {
- const { content, bindings } = compile(
- `<script setup lang="ts">
- const enum Foo { A = 123 }
- </script>`
- )
- assertCode(content)
- expect(bindings).toStrictEqual({
- Foo: BindingTypes.SETUP_CONST
- })
- })
- test('import type', () => {
- const { content } = compile(
- `<script setup lang="ts">
- import type { Foo } from './main.ts'
- import { type Bar, Baz } from './main.ts'
- </script>`
- )
- expect(content).toMatch(`return { Baz }`)
- assertCode(content)
- })
- })
- describe('errors', () => {
- test('<script> and <script setup> must have same lang', () => {
- expect(() =>
- compile(`<script>foo()</script><script setup lang="ts">bar()</script>`)
- ).toThrow(`<script> and <script setup> must have the same language type`)
- })
- const moduleErrorMsg = `cannot contain ES module exports`
- test('non-type named exports', () => {
- expect(() =>
- compile(`<script setup>
- export const a = 1
- </script>`)
- ).toThrow(moduleErrorMsg)
- expect(() =>
- compile(`<script setup>
- export * from './foo'
- </script>`)
- ).toThrow(moduleErrorMsg)
- expect(() =>
- compile(`<script setup>
- const bar = 1
- export { bar as default }
- </script>`)
- ).toThrow(moduleErrorMsg)
- })
- test('defineProps/Emit() w/ both type and non-type args', () => {
- expect(() => {
- compile(`<script setup lang="ts">
- defineProps<{}>({})
- </script>`)
- }).toThrow(`cannot accept both type and non-type arguments`)
- expect(() => {
- compile(`<script setup lang="ts">
- defineEmits<{}>({})
- </script>`)
- }).toThrow(`cannot accept both type and non-type arguments`)
- })
- test('defineProps/Emit() referencing local var', () => {
- expect(() =>
- compile(`<script setup>
- const bar = 1
- defineProps({
- foo: {
- default: () => bar
- }
- })
- </script>`)
- ).toThrow(`cannot reference locally declared variables`)
- expect(() =>
- compile(`<script setup>
- const bar = 'hello'
- defineEmits([bar])
- </script>`)
- ).toThrow(`cannot reference locally declared variables`)
- // #4644
- expect(() =>
- compile(`
- <script>const bar = 1</script>
- <script setup>
- defineProps({
- foo: {
- default: () => bar
- }
- })
- </script>`)
- ).not.toThrow(`cannot reference locally declared variables`)
- })
- test('should allow defineProps/Emit() referencing scope var', () => {
- assertCode(
- compile(`<script setup>
- const bar = 1
- defineProps({
- foo: {
- default: bar => bar + 1
- }
- })
- defineEmits({
- foo: bar => bar > 1
- })
- </script>`).content
- )
- })
- test('should allow defineProps/Emit() referencing imported binding', () => {
- assertCode(
- compile(`<script setup>
- import { bar } from './bar'
- defineProps({
- foo: {
- default: () => bar
- }
- })
- defineEmits({
- foo: () => bar > 1
- })
- </script>`).content
- )
- })
- })
- })
- describe('SFC analyze <script> bindings', () => {
- it('can parse decorators syntax in typescript block', () => {
- const { scriptAst } = compile(`
- <script lang="ts">
- import { Options, Vue } from 'vue-class-component';
- @Options({
- components: {
- HelloWorld,
- },
- props: ['foo', 'bar']
- })
- export default class Home extends Vue {}
- </script>
- `)
- expect(scriptAst).toBeDefined()
- })
- it('recognizes props array declaration', () => {
- const { bindings } = compile(`
- <script>
- export default {
- props: ['foo', 'bar']
- }
- </script>
- `)
- expect(bindings).toStrictEqual({
- foo: BindingTypes.PROPS,
- bar: BindingTypes.PROPS
- })
- expect(bindings!.__isScriptSetup).toBe(false)
- })
- it('recognizes props object declaration', () => {
- const { bindings } = compile(`
- <script>
- export default {
- props: {
- foo: String,
- bar: {
- type: String,
- },
- baz: null,
- qux: [String, Number]
- }
- }
- </script>
- `)
- expect(bindings).toStrictEqual({
- foo: BindingTypes.PROPS,
- bar: BindingTypes.PROPS,
- baz: BindingTypes.PROPS,
- qux: BindingTypes.PROPS
- })
- expect(bindings!.__isScriptSetup).toBe(false)
- })
- it('recognizes setup return', () => {
- const { bindings } = compile(`
- <script>
- const bar = 2
- export default {
- setup() {
- return {
- foo: 1,
- bar
- }
- }
- }
- </script>
- `)
- expect(bindings).toStrictEqual({
- foo: BindingTypes.SETUP_MAYBE_REF,
- bar: BindingTypes.SETUP_MAYBE_REF
- })
- expect(bindings!.__isScriptSetup).toBe(false)
- })
- it('recognizes exported vars', () => {
- const { bindings } = compile(`
- <script>
- export const foo = 2
- </script>
- <script setup>
- console.log(foo)
- </script>
- `)
- expect(bindings).toStrictEqual({
- foo: BindingTypes.SETUP_CONST
- })
- })
- it('recognizes async setup return', () => {
- const { bindings } = compile(`
- <script>
- const bar = 2
- export default {
- async setup() {
- return {
- foo: 1,
- bar
- }
- }
- }
- </script>
- `)
- expect(bindings).toStrictEqual({
- foo: BindingTypes.SETUP_MAYBE_REF,
- bar: BindingTypes.SETUP_MAYBE_REF
- })
- expect(bindings!.__isScriptSetup).toBe(false)
- })
- it('recognizes data return', () => {
- const { bindings } = compile(`
- <script>
- const bar = 2
- export default {
- data() {
- return {
- foo: null,
- bar
- }
- }
- }
- </script>
- `)
- expect(bindings).toStrictEqual({
- foo: BindingTypes.DATA,
- bar: BindingTypes.DATA
- })
- })
- it('recognizes methods', () => {
- const { bindings } = compile(`
- <script>
- export default {
- methods: {
- foo() {}
- }
- }
- </script>
- `)
- expect(bindings).toStrictEqual({ foo: BindingTypes.OPTIONS })
- })
- it('recognizes computeds', () => {
- const { bindings } = compile(`
- <script>
- export default {
- computed: {
- foo() {},
- bar: {
- get() {},
- set() {},
- }
- }
- }
- </script>
- `)
- expect(bindings).toStrictEqual({
- foo: BindingTypes.OPTIONS,
- bar: BindingTypes.OPTIONS
- })
- })
- it('recognizes injections array declaration', () => {
- const { bindings } = compile(`
- <script>
- export default {
- inject: ['foo', 'bar']
- }
- </script>
- `)
- expect(bindings).toStrictEqual({
- foo: BindingTypes.OPTIONS,
- bar: BindingTypes.OPTIONS
- })
- })
- it('recognizes injections object declaration', () => {
- const { bindings } = compile(`
- <script>
- export default {
- inject: {
- foo: {},
- bar: {},
- }
- }
- </script>
- `)
- expect(bindings).toStrictEqual({
- foo: BindingTypes.OPTIONS,
- bar: BindingTypes.OPTIONS
- })
- })
- it('works for mixed bindings', () => {
- const { bindings } = compile(`
- <script>
- export default {
- inject: ['foo'],
- props: {
- bar: String,
- },
- setup() {
- return {
- baz: null,
- }
- },
- data() {
- return {
- qux: null
- }
- },
- methods: {
- quux() {}
- },
- computed: {
- quuz() {}
- }
- }
- </script>
- `)
- expect(bindings).toStrictEqual({
- foo: BindingTypes.OPTIONS,
- bar: BindingTypes.PROPS,
- baz: BindingTypes.SETUP_MAYBE_REF,
- qux: BindingTypes.DATA,
- quux: BindingTypes.OPTIONS,
- quuz: BindingTypes.OPTIONS
- })
- })
- it('works for script setup', () => {
- const { bindings } = compile(`
- <script setup>
- import { ref as r } from 'vue'
- defineProps({
- foo: String
- })
- const a = r(1)
- let b = 2
- const c = 3
- const { d } = someFoo()
- let { e } = someBar()
- </script>
- `)
- expect(bindings).toStrictEqual({
- r: BindingTypes.SETUP_CONST,
- a: BindingTypes.SETUP_REF,
- b: BindingTypes.SETUP_LET,
- c: BindingTypes.SETUP_CONST,
- d: BindingTypes.SETUP_MAYBE_REF,
- e: BindingTypes.SETUP_LET,
- foo: BindingTypes.PROPS
- })
- })
- describe('auto name inference', () => {
- test('basic', () => {
- const { content } = compile(
- `<script setup>const a = 1</script>
- <template>{{ a }}</template>`,
- undefined,
- {
- filename: 'FooBar.vue'
- }
- )
- expect(content).toMatch(`export default {
- __name: 'FooBar'`)
- assertCode(content)
- })
- test('do not overwrite manual name (object)', () => {
- const { content } = compile(
- `<script>
- export default {
- name: 'Baz'
- }
- </script>
- <script setup>const a = 1</script>
- <template>{{ a }}</template>`,
- undefined,
- {
- filename: 'FooBar.vue'
- }
- )
- expect(content).not.toMatch(`name: 'FooBar'`)
- expect(content).toMatch(`name: 'Baz'`)
- assertCode(content)
- })
- test('do not overwrite manual name (call)', () => {
- const { content } = compile(
- `<script>
- import { defineComponent } from 'vue'
- export default defineComponent({
- name: 'Baz'
- })
- </script>
- <script setup>const a = 1</script>
- <template>{{ a }}</template>`,
- undefined,
- {
- filename: 'FooBar.vue'
- }
- )
- expect(content).not.toMatch(`name: 'FooBar'`)
- expect(content).toMatch(`name: 'Baz'`)
- assertCode(content)
- })
- // #12591
- test('should not error when performing ts expression check for v-on inline statement', () => {
- compile(`
- <script setup lang="ts">
- import { foo } from './foo'
- </script>
- <template>
- <div @click="$emit('update:a');"></div>
- </tempalte>
- `)
- })
- })
- })
|