compileTemplate.spec.ts 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517
  1. import { type RawSourceMap, SourceMapConsumer } from 'source-map-js'
  2. import { parse as babelParse } from '@babel/parser'
  3. import {
  4. type SFCTemplateCompileOptions,
  5. compileTemplate,
  6. } from '../src/compileTemplate'
  7. import { type SFCTemplateBlock, parse } from '../src/parse'
  8. import { compileScript } from '../src'
  9. function compile(opts: Omit<SFCTemplateCompileOptions, 'id'>) {
  10. return compileTemplate({
  11. ...opts,
  12. id: '',
  13. })
  14. }
  15. test('should work', () => {
  16. const source = `<div><p>{{ render }}</p></div>`
  17. const result = compile({ filename: 'example.vue', source })
  18. expect(result.errors.length).toBe(0)
  19. expect(result.source).toBe(source)
  20. // should expose render fn
  21. expect(result.code).toMatch(`export function render(`)
  22. })
  23. // #6807
  24. test('should work with style comment', () => {
  25. const source = `
  26. <div style="
  27. /* nothing */
  28. width: 300px;
  29. height: 100px/* nothing */
  30. ">{{ render }}</div>
  31. `
  32. const result = compile({ filename: 'example.vue', source })
  33. expect(result.errors.length).toBe(0)
  34. expect(result.source).toBe(source)
  35. expect(result.code).toMatch(`{"width":"300px","height":"100px"}`)
  36. })
  37. test('preprocess pug', () => {
  38. const template = parse(
  39. `
  40. <template lang="pug">
  41. body
  42. h1 Pug Examples
  43. div.container
  44. p Cool Pug example!
  45. </template>
  46. `,
  47. { filename: 'example.vue', sourceMap: true },
  48. ).descriptor.template as SFCTemplateBlock
  49. const result = compile({
  50. filename: 'example.vue',
  51. source: template.content,
  52. preprocessLang: template.lang,
  53. })
  54. expect(result.errors.length).toBe(0)
  55. })
  56. test('preprocess pug with indents and blank lines', () => {
  57. const template = parse(
  58. `
  59. <template lang="pug">
  60. body
  61. h1 The next line contains four spaces.
  62. div.container
  63. p The next line is empty.
  64. p This is the last line.
  65. </template>
  66. `,
  67. { filename: 'example.vue', sourceMap: true },
  68. ).descriptor.template as SFCTemplateBlock
  69. const result = compile({
  70. filename: 'example.vue',
  71. source: template.content,
  72. preprocessLang: template.lang,
  73. })
  74. expect(result.errors.length).toBe(0)
  75. expect(result.source).toBe(
  76. '<body><h1>The next line contains four spaces.</h1><div class="container"><p>The next line is empty.</p></div><p>This is the last line.</p></body>',
  77. )
  78. })
  79. test('warn missing preprocessor', () => {
  80. const template = parse(`<template lang="unknownLang">hi</template>\n`, {
  81. filename: 'example.vue',
  82. sourceMap: true,
  83. }).descriptor.template as SFCTemplateBlock
  84. const result = compile({
  85. filename: 'example.vue',
  86. source: template.content,
  87. preprocessLang: template.lang,
  88. })
  89. expect(result.errors.length).toBe(1)
  90. })
  91. test('transform asset url options', () => {
  92. const input = { source: `<foo bar="~baz"/>`, filename: 'example.vue' }
  93. // Object option
  94. const { code: code1 } = compile({
  95. ...input,
  96. transformAssetUrls: {
  97. tags: { foo: ['bar'] },
  98. },
  99. })
  100. expect(code1).toMatch(`import _imports_0 from 'baz'\n`)
  101. // legacy object option (direct tags config)
  102. const { code: code2 } = compile({
  103. ...input,
  104. transformAssetUrls: {
  105. foo: ['bar'],
  106. },
  107. })
  108. expect(code2).toMatch(`import _imports_0 from 'baz'\n`)
  109. // false option
  110. const { code: code3 } = compile({
  111. ...input,
  112. transformAssetUrls: false,
  113. })
  114. expect(code3).not.toMatch(`import _imports_0 from 'baz'\n`)
  115. })
  116. test('source map', () => {
  117. const template = parse(
  118. `
  119. <template>
  120. <div><p>{{ foobar }}</p></div>
  121. </template>
  122. `,
  123. { filename: 'example.vue', sourceMap: true },
  124. ).descriptor.template!
  125. const { code, map } = compile({
  126. filename: 'example.vue',
  127. source: template.content,
  128. })
  129. expect(map!.sources).toEqual([`example.vue`])
  130. expect(map!.sourcesContent).toEqual([template.content])
  131. const consumer = new SourceMapConsumer(map as RawSourceMap)
  132. expect(
  133. consumer.originalPositionFor(getPositionInCode(code, 'foobar')),
  134. ).toMatchObject(getPositionInCode(template.content, `foobar`))
  135. })
  136. test('should work w/ AST from descriptor', () => {
  137. const source = `
  138. <template>
  139. <div><p>{{ foobar }}</p></div>
  140. </template>
  141. `
  142. const template = parse(source, {
  143. filename: 'example.vue',
  144. sourceMap: true,
  145. }).descriptor.template!
  146. expect(template.ast!.source).toBe(source)
  147. const { code, map } = compile({
  148. filename: 'example.vue',
  149. source: template.content,
  150. ast: template.ast,
  151. })
  152. expect(map!.sources).toEqual([`example.vue`])
  153. // when reusing AST from SFC parse for template compile,
  154. // the source corresponds to the entire SFC
  155. expect(map!.sourcesContent).toEqual([source])
  156. const consumer = new SourceMapConsumer(map as RawSourceMap)
  157. expect(
  158. consumer.originalPositionFor(getPositionInCode(code, 'foobar')),
  159. ).toMatchObject(getPositionInCode(source, `foobar`))
  160. expect(code).toBe(
  161. compile({
  162. filename: 'example.vue',
  163. source: template.content,
  164. }).code,
  165. )
  166. })
  167. test('should work w/ AST from descriptor in SSR mode', () => {
  168. const source = `
  169. <template>
  170. <div><p>{{ foobar }}</p></div>
  171. </template>
  172. `
  173. const template = parse(source, {
  174. filename: 'example.vue',
  175. sourceMap: true,
  176. }).descriptor.template!
  177. expect(template.ast!.source).toBe(source)
  178. const { code, map } = compile({
  179. filename: 'example.vue',
  180. source: '', // make sure it's actually using the AST instead of source
  181. ast: template.ast,
  182. ssr: true,
  183. })
  184. expect(map!.sources).toEqual([`example.vue`])
  185. // when reusing AST from SFC parse for template compile,
  186. // the source corresponds to the entire SFC
  187. expect(map!.sourcesContent).toEqual([source])
  188. const consumer = new SourceMapConsumer(map as RawSourceMap)
  189. expect(
  190. consumer.originalPositionFor(getPositionInCode(code, 'foobar')),
  191. ).toMatchObject(getPositionInCode(source, `foobar`))
  192. expect(code).toBe(
  193. compile({
  194. filename: 'example.vue',
  195. source: template.content,
  196. ssr: true,
  197. }).code,
  198. )
  199. })
  200. test('should not reuse AST if using custom compiler', () => {
  201. const source = `
  202. <template>
  203. <div><p>{{ foobar }}</p></div>
  204. </template>
  205. `
  206. const template = parse(source, {
  207. filename: 'example.vue',
  208. sourceMap: true,
  209. }).descriptor.template!
  210. const { code } = compile({
  211. filename: 'example.vue',
  212. source: template.content,
  213. ast: template.ast,
  214. compiler: {
  215. parse: () => null as any,
  216. // @ts-expect-error
  217. compile: input => ({ code: input }),
  218. },
  219. })
  220. // what we really want to assert is that the `input` received by the custom
  221. // compiler is the source string, not the AST.
  222. expect(code).toBe(template.content)
  223. })
  224. test('should force re-parse on already transformed AST', () => {
  225. const source = `
  226. <template>
  227. <div><p>{{ foobar }}</p></div>
  228. </template>
  229. `
  230. const template = parse(source, {
  231. filename: 'example.vue',
  232. sourceMap: true,
  233. }).descriptor.template!
  234. // force set to empty, if this is reused then it won't generate proper code
  235. template.ast!.children = []
  236. template.ast!.transformed = true
  237. const { code } = compile({
  238. filename: 'example.vue',
  239. source: '',
  240. ast: template.ast,
  241. })
  242. expect(code).toBe(
  243. compile({
  244. filename: 'example.vue',
  245. source: template.content,
  246. }).code,
  247. )
  248. })
  249. test('should force re-parse with correct compiler in SSR mode', () => {
  250. const source = `
  251. <template>
  252. <div><p>{{ foobar }}</p></div>
  253. </template>
  254. `
  255. const template = parse(source, {
  256. filename: 'example.vue',
  257. sourceMap: true,
  258. }).descriptor.template!
  259. // force set to empty, if this is reused then it won't generate proper code
  260. template.ast!.children = []
  261. template.ast!.transformed = true
  262. const { code } = compile({
  263. filename: 'example.vue',
  264. source: '',
  265. ast: template.ast,
  266. ssr: true,
  267. })
  268. expect(code).toBe(
  269. compile({
  270. filename: 'example.vue',
  271. source: template.content,
  272. ssr: true,
  273. }).code,
  274. )
  275. })
  276. test('template errors', () => {
  277. const result = compile({
  278. filename: 'example.vue',
  279. source: `<div
  280. :bar="a[" v-model="baz"/>`,
  281. })
  282. expect(result.errors).toMatchSnapshot()
  283. })
  284. test('preprocessor errors', () => {
  285. const template = parse(
  286. `
  287. <template lang="pug">
  288. div(class='class)
  289. </template>
  290. `,
  291. { filename: 'example.vue', sourceMap: true },
  292. ).descriptor.template as SFCTemplateBlock
  293. const result = compile({
  294. filename: 'example.vue',
  295. source: template.content,
  296. preprocessLang: template.lang,
  297. })
  298. expect(result.errors.length).toBe(1)
  299. const message = result.errors[0].toString()
  300. expect(message).toMatch(`Error: example.vue:3:1`)
  301. expect(message).toMatch(
  302. `The end of the string reached with no closing bracket ) found.`,
  303. )
  304. })
  305. // #3447
  306. test('should generate the correct imports expression', () => {
  307. const { code } = compile({
  308. filename: 'example.vue',
  309. source: `
  310. <img src="./foo.svg"/>
  311. <Comp>
  312. <img src="./bar.svg"/>
  313. </Comp>
  314. `,
  315. ssr: true,
  316. })
  317. expect(code).toMatch(`_ssrRenderAttr(\"src\", _imports_1)`)
  318. expect(code).toMatch(`_createVNode(\"img\", { src: _imports_1 })`)
  319. })
  320. // #3874
  321. test('should not hoist srcset URLs in SSR mode', () => {
  322. const { code } = compile({
  323. filename: 'example.vue',
  324. source: `
  325. <picture>
  326. <source srcset="./img/foo.svg"/>
  327. <img src="./img/foo.svg"/>
  328. </picture>
  329. <router-link>
  330. <picture>
  331. <source srcset="./img/bar.svg"/>
  332. <img src="./img/bar.svg"/>
  333. </picture>
  334. </router-link>
  335. `,
  336. ssr: true,
  337. })
  338. expect(code).toMatchSnapshot()
  339. })
  340. // #6742
  341. test('dynamic v-on + static v-on should merged', () => {
  342. const source = `<input @blur="onBlur" @[validateEvent]="onValidateEvent">`
  343. const result = compile({ filename: 'example.vue', source })
  344. expect(result.code).toMatchSnapshot()
  345. })
  346. // #9853 regression found in Nuxt tests
  347. // walkIdentifiers can get called multiple times on the same node
  348. // due to #9729 calling it during SFC template usage check.
  349. // conditions needed:
  350. // 1. `<script setup lang="ts">`
  351. // 2. Has import
  352. // 3. inlineTemplate: false
  353. // 4. AST being reused
  354. test('prefixing edge case for reused AST', () => {
  355. const src = `
  356. <script setup lang="ts">
  357. import { Foo } from './foo'
  358. </script>
  359. <template>
  360. {{ list.map((t, index) => ({ t: t })) }}
  361. </template>
  362. `
  363. const { descriptor } = parse(src)
  364. // compileScript triggers importUsageCheck
  365. compileScript(descriptor, { id: 'xxx' })
  366. const { code } = compileTemplate({
  367. id: 'xxx',
  368. filename: 'test.vue',
  369. ast: descriptor.template!.ast,
  370. source: descriptor.template!.content,
  371. })
  372. expect(code).not.toMatch(`_ctx.t`)
  373. })
  374. test('prefixing edge case for reused AST ssr mode', () => {
  375. const src = `
  376. <script setup lang="ts">
  377. import { Foo } from './foo'
  378. </script>
  379. <template>
  380. <Bar>
  381. <template #option="{ foo }"></template>
  382. </Bar>
  383. </template>
  384. `
  385. const { descriptor } = parse(src)
  386. // compileScript triggers importUsageCheck
  387. compileScript(descriptor, { id: 'xxx' })
  388. expect(() =>
  389. compileTemplate({
  390. id: 'xxx',
  391. filename: 'test.vue',
  392. ast: descriptor.template!.ast,
  393. source: descriptor.template!.content,
  394. ssr: true,
  395. }),
  396. ).not.toThrowError()
  397. })
  398. // #10852
  399. test('non-identifier expression in legacy filter syntax', () => {
  400. const src = `
  401. <template>
  402. <div>
  403. Today is
  404. {{ new Date() | formatDate }}
  405. </div>
  406. </template>
  407. `
  408. const { descriptor } = parse(src)
  409. const compilationResult = compileTemplate({
  410. id: 'xxx',
  411. filename: 'test.vue',
  412. ast: descriptor.template!.ast,
  413. source: descriptor.template!.content,
  414. ssr: false,
  415. compilerOptions: {
  416. compatConfig: {
  417. MODE: 2,
  418. },
  419. },
  420. })
  421. expect(() => {
  422. babelParse(compilationResult.code, { sourceType: 'module' })
  423. }).not.toThrow()
  424. })
  425. interface Pos {
  426. line: number
  427. column: number
  428. name?: string
  429. }
  430. function getPositionInCode(
  431. code: string,
  432. token: string,
  433. expectName: string | boolean = false,
  434. ): Pos {
  435. const generatedOffset = code.indexOf(token)
  436. let line = 1
  437. let lastNewLinePos = -1
  438. for (let i = 0; i < generatedOffset; i++) {
  439. if (code.charCodeAt(i) === 10 /* newline char code */) {
  440. line++
  441. lastNewLinePos = i
  442. }
  443. }
  444. const res: Pos = {
  445. line,
  446. column:
  447. lastNewLinePos === -1
  448. ? generatedOffset
  449. : generatedOffset - lastNewLinePos - 1,
  450. }
  451. if (expectName) {
  452. res.name = typeof expectName === 'string' ? expectName : token
  453. }
  454. return res
  455. }