| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645 |
- import { BindingTypes } from '@vue/compiler-core'
- import { compileSFCScript as compile, assertCode, mockId } from './utils'
- describe('SFC compile <script setup>', () => {
- test('should compile JS syntax', () => {
- const { content } = compile(`
- <script setup lang='js'>
- const a = 1
- const b = 2
- </script>
- `)
- expect(content).toMatch(`return { a, b }`)
- assertCode(content)
- })
- 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 { get aa() { return aa }, set aa(v) { aa = v }, ` +
- `bb, cc, dd, get a() { return a }, set a(v) { a = v }, b, c, d, ` +
- `get xx() { return xx }, get x() { return 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.LITERAL_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)
- })
- 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)
- })
- // #7805
- test('keep original semi style', () => {
- const { content } = compile(`
- <script setup>
- console.log('test')
- const props = defineProps(['item']);
- const emit = defineEmits(['change']);
- (function () {})()
- </script>
- `)
- assertCode(content)
- expect(content).toMatch(`console.log('test')`)
- expect(content).toMatch(`const props = __props;`)
- expect(content).toMatch(`const emit = __emit;`)
- expect(content).toMatch(`(function () {})()`)
- })
- 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)
- })
- })
- test('export call expression as default', () => {
- const { content } = compile(`
- <script>
- function fn() {
- return "hello, world";
- }
- export default fn();
- </script>
- <script setup>
- console.log('foo')
- </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('dedupe between user & helper', () => {
- const { content } = compile(
- `
- <script setup>
- import { useCssVars, ref } from 'vue'
- const msg = ref()
- </script>
- <style>
- .foo {
- color: v-bind(msg)
- }
- </style>
- `
- )
- assertCode(content)
- expect(content).toMatch(
- `import { useCssVars as _useCssVars, unref as _unref } from 'vue'`
- )
- expect(content).toMatch(`import { useCssVars, ref } from 'vue'`)
- })
- 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 }`)
- )
- })
- describe('import ref/reactive function from other place', () => {
- test('import directly', () => {
- const { bindings } = compile(`
- <script setup>
- import { ref, reactive } from './foo'
- const foo = ref(1)
- const bar = reactive(1)
- </script>
- `)
- expect(bindings).toStrictEqual({
- ref: BindingTypes.SETUP_MAYBE_REF,
- reactive: BindingTypes.SETUP_MAYBE_REF,
- foo: BindingTypes.SETUP_MAYBE_REF,
- bar: BindingTypes.SETUP_MAYBE_REF
- })
- })
- test('import w/ alias', () => {
- const { bindings } = compile(`
- <script setup>
- import { ref as _ref, reactive as _reactive } from './foo'
- const foo = ref(1)
- const bar = reactive(1)
- </script>
- `)
- expect(bindings).toStrictEqual({
- _reactive: BindingTypes.SETUP_MAYBE_REF,
- _ref: BindingTypes.SETUP_MAYBE_REF,
- foo: BindingTypes.SETUP_MAYBE_REF,
- bar: BindingTypes.SETUP_MAYBE_REF
- })
- })
- test('aliased usage before import site', () => {
- const { bindings } = compile(`
- <script setup>
- const bar = x(1)
- import { reactive as x } from 'vue'
- </script>
- `)
- expect(bindings).toStrictEqual({
- bar: BindingTypes.SETUP_REACTIVE_CONST,
- x: BindingTypes.SETUP_CONST
- })
- })
- })
- test('should support module string names syntax', () => {
- const { content, bindings } = compile(`
- <script>
- import { "😏" as foo } from './foo'
- </script>
- <script setup>
- import { "😏" as foo } from './foo'
- </script>
- `)
- assertCode(content)
- expect(bindings).toStrictEqual({
- foo: BindingTypes.SETUP_MAYBE_REF
- })
- })
- })
- // 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, get FooBaz() { return FooBaz }, ` +
- `get FooQux() { return FooQux }, get foo() { return 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 { get vMyDir() { return vMyDir } }`)
- assertCode(content)
- })
- test('dynamic arguments', () => {
- const { content } = compile(`
- <script setup lang="ts">
- import { FooBar, foo, bar, unused, baz } from './x'
- </script>
- <template>
- <FooBar #[foo.slotName] />
- <FooBar #unused />
- <div :[bar.attrName]="15"></div>
- <div unused="unused"></div>
- <div #[\`item:\${baz.key}\`]="{ value }"></div>
- </template>
- `)
- expect(content).toMatch(
- `return { get FooBar() { return FooBar }, get foo() { return foo }, ` +
- `get bar() { return bar }, get baz() { return baz } }`
- )
- 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, get bar() { return bar }, get baz() { return 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 { get x() { return x }, get z() { return z }, get x$y() { return 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 { get VAR() { return VAR }, get VAR3() { return 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 { get FooBaz() { return FooBaz }, get Last() { return Last } }`
- )
- assertCode(content)
- })
- test('TS annotations', () => {
- const { content } = compile(`
- <script setup lang="ts">
- import { Foo, Bar, Baz, Qux, Fred } from './x'
- const a = 1
- function b() {}
- </script>
- <template>
- {{ a as Foo }}
- {{ b<Bar>() }}
- {{ 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, get Baz() { return Baz } }`)
- assertCode(content)
- })
- // vuejs/vue#12591
- test('v-on inline statement', () => {
- // should not error
- compile(`
- <script setup lang="ts">
- import { foo } from './foo'
- </script>
- <template>
- <div @click="$emit('update:a');"></div>
- </template>
- `)
- })
- test('template ref', () => {
- const { content } = compile(`
- <script setup lang="ts">
- import { foo, bar, Baz } from './foo'
- </script>
- <template>
- <div ref="foo"></div>
- <div ref=""></div>
- <Baz ref="bar" />
- </template>
- `)
- expect(content).toMatch(
- 'return { get foo() { return foo }, get bar() { return bar }, get Baz() { return Baz } }'
- )
- assertCode(content)
- })
- // https://github.com/nuxt/nuxt/issues/22416
- test('property access', () => {
- const { content } = compile(`
- <script setup lang="ts">
- import { Foo, Bar, Baz } from './foo'
- </script>
- <template>
- <div>{{ Foo.Bar.Baz }}</div>
- </template>
- `)
- expect(content).toMatch('return { get Foo() { return Foo } }')
- assertCode(content)
- })
- test('spread operator', () => {
- const { content } = compile(`
- <script setup lang="ts">
- import { Foo, Bar, Baz } from './foo'
- </script>
- <template>
- <div v-bind="{ ...Foo.Bar.Baz }"></div>
- </template>
- `)
- expect(content).toMatch('return { get Foo() { return Foo } }')
- assertCode(content)
- })
- test('property access (whitespace)', () => {
- const { content } = compile(`
- <script setup lang="ts">
- import { Foo, Bar, Baz } from './foo'
- </script>
- <template>
- <div>{{ Foo . Bar . Baz }}</div>
- </template>
- `)
- expect(content).toMatch('return { get Foo() { return Foo } }')
- 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: __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('v-model should not generate ref assignment code for non-setup bindings', () => {
- const { content } = compile(
- `<script setup>
- import { ref } from 'vue'
- const count = ref(0)
- </script>
- <script>
- export default {
- data() { return { foo: 123 } }
- }
- </script>
- <template>
- <input v-model="foo">
- </template>
- `,
- { inlineTemplate: true }
- )
- expect(content).not.toMatch(`_isRef(foo)`)
- })
- 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)
- const style = { color: 'red' }
- </script>
- <template>
- <div>{{ count }}</div>
- <div>static</div>
- </template>
- <style>
- div { color: v-bind(count) }
- span { color: v-bind(style.color) }
- </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)`)
- expect(content).toMatch(`"--${mockId}-style\\\\.color": (style.color)`)
- assertCode(content)
- })
- test('the v-for wrapped in parentheses can be correctly parsed & inline is false', () => {
- expect(() =>
- compile(
- `
- <script setup lang="ts">
- import { ref } from 'vue'
- const stacks = ref([])
- </script>
- <template>
- <div v-for="({ file: efile }) of stacks"></div>
- </template>
- `,
- {
- inlineTemplate: false
- }
- )
- ).not.toThrowError()
- })
- })
- describe('with TypeScript', () => {
- test('hoist type declarations', () => {
- const { content } = compile(`
- <script setup lang="ts">
- export interface Foo {}
- type Bar = {}
- </script>`)
- assertCode(content)
- })
- test('runtime Enum', () => {
- const { content, bindings } = compile(
- `<script setup lang="ts">
- enum Foo { A = 123 }
- </script>`
- )
- assertCode(content)
- expect(bindings).toStrictEqual({
- Foo: BindingTypes.LITERAL_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.LITERAL_CONST,
- C: BindingTypes.LITERAL_CONST,
- B: BindingTypes.LITERAL_CONST,
- Foo: BindingTypes.LITERAL_CONST
- })
- })
- test('const Enum', () => {
- const { content, bindings } = compile(
- `<script setup lang="ts">
- const enum Foo { A = 123 }
- </script>`,
- { hoistStatic: true }
- )
- assertCode(content)
- expect(bindings).toStrictEqual({
- Foo: BindingTypes.LITERAL_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 { get Baz() { return Baz } }`)
- assertCode(content)
- })
- test('with generic attribute', () => {
- const { content } = compile(`
- <script setup lang="ts" generic="T extends Record<string,string>">
- type Bar = {}
- </script>`)
- assertCode(content)
- })
- })
- describe('async/await detection', () => {
- function assertAwaitDetection(code: string, shouldAsync = true) {
- const { content } = compile(`<script setup>${code}</script>`)
- if (shouldAsync) {
- expect(content).toMatch(`let __temp, __restore`)
- }
- expect(content).toMatch(`${shouldAsync ? `async ` : ``}setup(`)
- assertCode(content)
- return content
- }
- test('expression statement', () => {
- assertAwaitDetection(`await foo`)
- })
- test('variable', () => {
- assertAwaitDetection(`const a = 1 + (await foo)`)
- })
- test('ref', () => {
- assertAwaitDetection(`let a = ref(1 + (await foo))`)
- })
- // #4448
- test('nested await', () => {
- assertAwaitDetection(`await (await foo)`)
- assertAwaitDetection(`await ((await foo))`)
- assertAwaitDetection(`await (await (await foo))`)
- })
- // should prepend semicolon
- test('nested leading await in expression statement', () => {
- const code = assertAwaitDetection(`foo()\nawait 1 + await 2`)
- expect(code).toMatch(`foo()\n;(`)
- })
- // #4596 should NOT prepend semicolon
- test('single line conditions', () => {
- const code = assertAwaitDetection(`if (false) await foo()`)
- expect(code).not.toMatch(`if (false) ;(`)
- })
- test('nested statements', () => {
- assertAwaitDetection(`if (ok) { await foo } else { await bar }`)
- })
- test('multiple `if` nested statements', () => {
- assertAwaitDetection(`if (ok) {
- let a = 'foo'
- await 0 + await 1
- await 2
- } else if (a) {
- await 10
- if (b) {
- await 0 + await 1
- } else {
- let a = 'foo'
- await 2
- }
- if (b) {
- await 3
- await 4
- }
- } else {
- await 5
- }`)
- })
- test('multiple `if while` nested statements', () => {
- assertAwaitDetection(`if (ok) {
- while (d) {
- await 5
- }
- while (d) {
- await 5
- await 6
- if (c) {
- let f = 10
- 10 + await 7
- } else {
- await 8
- await 9
- }
- }
- }`)
- })
- test('multiple `if for` nested statements', () => {
- assertAwaitDetection(`if (ok) {
- for (let a of [1,2,3]) {
- await a
- }
- for (let a of [1,2,3]) {
- await a
- await a
- }
- }`)
- })
- test('should ignore await inside functions', () => {
- // function declaration
- assertAwaitDetection(`async function foo() { await bar }`, false)
- // function expression
- assertAwaitDetection(`const foo = async () => { await bar }`, false)
- // object method
- assertAwaitDetection(`const obj = { async method() { await bar }}`, false)
- // class method
- assertAwaitDetection(
- `const cls = class Foo { async method() { await bar }}`,
- false
- )
- })
- })
- 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() referencing local var', () => {
- expect(() =>
- compile(`<script setup>
- let bar = 1
- defineProps({
- foo: {
- default: () => bar
- }
- })
- </script>`)
- ).toThrow(`cannot reference locally declared variables`)
- expect(() =>
- compile(`<script setup>
- let 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.LITERAL_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.LITERAL_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)
- })
- })
- })
- describe('SFC genDefaultAs', () => {
- test('normal <script> only', () => {
- const { content } = compile(
- `<script>
- export default {}
- </script>`,
- {
- genDefaultAs: '_sfc_'
- }
- )
- expect(content).not.toMatch('export default')
- expect(content).toMatch(`const _sfc_ = {}`)
- assertCode(content)
- })
- test('normal <script> w/ cssVars', () => {
- const { content } = compile(
- `<script>
- export default {}
- </script>
- <style>
- .foo { color: v-bind(x) }
- </style>`,
- {
- genDefaultAs: '_sfc_'
- }
- )
- expect(content).not.toMatch('export default')
- expect(content).not.toMatch('__default__')
- expect(content).toMatch(`const _sfc_ = {}`)
- assertCode(content)
- })
- test('<script> + <script setup>', () => {
- const { content } = compile(
- `<script>
- export default {}
- </script>
- <script setup>
- const a = 1
- </script>`,
- {
- genDefaultAs: '_sfc_'
- }
- )
- expect(content).not.toMatch('export default')
- expect(content).toMatch(
- `const _sfc_ = /*#__PURE__*/Object.assign(__default__`
- )
- assertCode(content)
- })
- test('<script> + <script setup>', () => {
- const { content } = compile(
- `<script>
- export default {}
- </script>
- <script setup>
- const a = 1
- </script>`,
- {
- genDefaultAs: '_sfc_'
- }
- )
- expect(content).not.toMatch('export default')
- expect(content).toMatch(
- `const _sfc_ = /*#__PURE__*/Object.assign(__default__`
- )
- assertCode(content)
- })
- test('<script setup> only', () => {
- const { content } = compile(
- `<script setup>
- const a = 1
- </script>`,
- {
- genDefaultAs: '_sfc_'
- }
- )
- expect(content).not.toMatch('export default')
- expect(content).toMatch(`const _sfc_ = {\n setup`)
- assertCode(content)
- })
- test('<script setup> only w/ ts', () => {
- const { content } = compile(
- `<script setup lang="ts">
- const a = 1
- </script>`,
- {
- genDefaultAs: '_sfc_'
- }
- )
- expect(content).not.toMatch('export default')
- expect(content).toMatch(`const _sfc_ = /*#__PURE__*/_defineComponent(`)
- assertCode(content)
- })
- test('<script> + <script setup> w/ ts', () => {
- const { content } = compile(
- `<script lang="ts">
- export default {}
- </script>
- <script setup lang="ts">
- const a = 1
- </script>`,
- {
- genDefaultAs: '_sfc_'
- }
- )
- expect(content).not.toMatch('export default')
- expect(content).toMatch(
- `const _sfc_ = /*#__PURE__*/_defineComponent({\n ...__default__`
- )
- assertCode(content)
- })
- test('binding type for edge cases', () => {
- const { bindings } = compile(
- `<script setup lang="ts">
- import { toRef } from 'vue'
- const props = defineProps<{foo: string}>()
- const foo = toRef(() => props.foo)
- </script>`
- )
- expect(bindings).toStrictEqual({
- toRef: BindingTypes.SETUP_CONST,
- props: BindingTypes.SETUP_REACTIVE_CONST,
- foo: BindingTypes.SETUP_REF
- })
- })
- describe('parser plugins', () => {
- test('import attributes', () => {
- const { content } = compile(`
- <script setup>
- import { foo } from './foo.js' with { type: 'foobar' }
- </script>
- `)
- assertCode(content)
- expect(() =>
- compile(`
- <script setup>
- import { foo } from './foo.js' assert { type: 'foobar' }
- </script>`)
- ).toThrow()
- })
- test('import attributes (user override for deprecated syntax)', () => {
- const { content } = compile(
- `
- <script setup>
- import { foo } from './foo.js' assert { type: 'foobar' }
- </script>
- `,
- {
- babelParserPlugins: [
- ['importAttributes', { deprecatedAssertSyntax: true }]
- ]
- }
- )
- assertCode(content)
- })
- })
- })
|