| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502 |
- import { BindingTypes } from '@vue/compiler-core'
- import { assertCode, compileSFCScript as compile, 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,
- })
- })
- })
- 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' }
- const height = ref(0)
- </script>
- <template>
- <div>{{ count }}</div>
- <div>static</div>
- </template>
- <style>
- div { color: v-bind(count) }
- span { color: v-bind(style.color) }
- span { color: v-bind(height + "px") }
- </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)`)
- expect(content).toMatch(
- `"--${mockId}-height\\\\ \\\\+\\\\ \\\\\\"px\\\\\\"": (height.value + "px")`,
- )
- 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()
- })
- test('unref + new expression', () => {
- const { content } = compile(
- `
- <script setup>
- import Foo from './foo'
- </script>
- <template>
- <div>{{ new Foo() }}</div>
- <div>{{ new Foo.Bar() }}</div>
- </template>
- `,
- { inlineTemplate: true },
- )
- expect(content).toMatch(`new (_unref(Foo))()`)
- expect(content).toMatch(`new (_unref(Foo)).Bar()`)
- 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('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,
- )
- })
- test('defineModel() referencing local var', () => {
- expect(() =>
- compile(`<script setup>
- let bar = 1
- defineModel({
- default: () => bar
- })
- </script>`),
- ).toThrow(`cannot reference locally declared variables`)
- // allow const
- expect(() =>
- compile(`<script setup>
- const bar = 1
- defineModel({
- default: () => bar
- })
- </script>`),
- ).not.toThrow(`cannot reference locally declared variables`)
- // allow in get/set
- expect(() =>
- compile(`<script setup>
- let bar = 1
- defineModel({
- get: () => bar,
- set: () => bar
- })
- </script>`),
- ).not.toThrow(`cannot reference locally declared variables`)
- })
- })
- })
- 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)
- })
- })
- })
- describe('compileScript', () => {
- test('should care about runtimeModuleName', () => {
- const { content } = compile(
- `
- <script setup>
- await Promise.resolve(1)
- </script>
- `,
- {
- templateOptions: {
- compilerOptions: {
- runtimeModuleName: 'npm:vue',
- },
- },
- },
- )
- expect(content).toMatch(
- `import { withAsyncContext as _withAsyncContext } from "npm:vue"\n`,
- )
- assertCode(content)
- })
- })
|