compileTemplate.spec.ts 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546
  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('source map: v-if generated comment should not have original position', () => {
  137. const template = parse(
  138. `
  139. <template>
  140. <div v-if="true"></div>
  141. </template>
  142. `,
  143. { filename: 'example.vue', sourceMap: true },
  144. ).descriptor.template!
  145. const { code, map } = compile({
  146. filename: 'example.vue',
  147. source: template.content,
  148. })
  149. expect(map!.sources).toEqual([`example.vue`])
  150. expect(map!.sourcesContent).toEqual([template.content])
  151. const consumer = new SourceMapConsumer(map as RawSourceMap)
  152. const commentNode = code.match(/_createCommentVNode\("v-if", true\)/)
  153. expect(commentNode).not.toBeNull()
  154. const commentPosition = getPositionInCode(code, commentNode![0])
  155. const originalPosition = consumer.originalPositionFor(commentPosition)
  156. // the comment node should not be mapped to the original source
  157. expect(originalPosition.column).toBeNull()
  158. expect(originalPosition.line).toBeNull()
  159. expect(originalPosition.source).toBeNull()
  160. })
  161. test('should work w/ AST from descriptor', () => {
  162. const source = `
  163. <template>
  164. <div><p>{{ foobar }}</p></div>
  165. </template>
  166. `
  167. const template = parse(source, {
  168. filename: 'example.vue',
  169. sourceMap: true,
  170. }).descriptor.template!
  171. expect(template.ast!.source).toBe(source)
  172. const { code, map } = compile({
  173. filename: 'example.vue',
  174. source: template.content,
  175. ast: template.ast,
  176. })
  177. expect(map!.sources).toEqual([`example.vue`])
  178. // when reusing AST from SFC parse for template compile,
  179. // the source corresponds to the entire SFC
  180. expect(map!.sourcesContent).toEqual([source])
  181. const consumer = new SourceMapConsumer(map as RawSourceMap)
  182. expect(
  183. consumer.originalPositionFor(getPositionInCode(code, 'foobar')),
  184. ).toMatchObject(getPositionInCode(source, `foobar`))
  185. expect(code).toBe(
  186. compile({
  187. filename: 'example.vue',
  188. source: template.content,
  189. }).code,
  190. )
  191. })
  192. test('should work w/ AST from descriptor in SSR mode', () => {
  193. const source = `
  194. <template>
  195. <div><p>{{ foobar }}</p></div>
  196. </template>
  197. `
  198. const template = parse(source, {
  199. filename: 'example.vue',
  200. sourceMap: true,
  201. }).descriptor.template!
  202. expect(template.ast!.source).toBe(source)
  203. const { code, map } = compile({
  204. filename: 'example.vue',
  205. source: '', // make sure it's actually using the AST instead of source
  206. ast: template.ast,
  207. ssr: true,
  208. })
  209. expect(map!.sources).toEqual([`example.vue`])
  210. // when reusing AST from SFC parse for template compile,
  211. // the source corresponds to the entire SFC
  212. expect(map!.sourcesContent).toEqual([source])
  213. const consumer = new SourceMapConsumer(map as RawSourceMap)
  214. expect(
  215. consumer.originalPositionFor(getPositionInCode(code, 'foobar')),
  216. ).toMatchObject(getPositionInCode(source, `foobar`))
  217. expect(code).toBe(
  218. compile({
  219. filename: 'example.vue',
  220. source: template.content,
  221. ssr: true,
  222. }).code,
  223. )
  224. })
  225. test('should not reuse AST if using custom compiler', () => {
  226. const source = `
  227. <template>
  228. <div><p>{{ foobar }}</p></div>
  229. </template>
  230. `
  231. const template = parse(source, {
  232. filename: 'example.vue',
  233. sourceMap: true,
  234. }).descriptor.template!
  235. const { code } = compile({
  236. filename: 'example.vue',
  237. source: template.content,
  238. ast: template.ast,
  239. compiler: {
  240. parse: () => null as any,
  241. // @ts-expect-error
  242. compile: input => ({ code: input }),
  243. },
  244. })
  245. // what we really want to assert is that the `input` received by the custom
  246. // compiler is the source string, not the AST.
  247. expect(code).toBe(template.content)
  248. })
  249. test('should force re-parse on already transformed AST', () => {
  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. })
  267. expect(code).toBe(
  268. compile({
  269. filename: 'example.vue',
  270. source: template.content,
  271. }).code,
  272. )
  273. })
  274. test('should force re-parse with correct compiler in SSR mode', () => {
  275. const source = `
  276. <template>
  277. <div><p>{{ foobar }}</p></div>
  278. </template>
  279. `
  280. const template = parse(source, {
  281. filename: 'example.vue',
  282. sourceMap: true,
  283. }).descriptor.template!
  284. // force set to empty, if this is reused then it won't generate proper code
  285. template.ast!.children = []
  286. template.ast!.transformed = true
  287. const { code } = compile({
  288. filename: 'example.vue',
  289. source: '',
  290. ast: template.ast,
  291. ssr: true,
  292. })
  293. expect(code).toBe(
  294. compile({
  295. filename: 'example.vue',
  296. source: template.content,
  297. ssr: true,
  298. }).code,
  299. )
  300. })
  301. test('template errors', () => {
  302. const result = compile({
  303. filename: 'example.vue',
  304. source: `<div
  305. :bar="a[" v-model="baz"/>`,
  306. })
  307. expect(result.errors).toMatchSnapshot()
  308. })
  309. test('preprocessor errors', () => {
  310. const template = parse(
  311. `
  312. <template lang="pug">
  313. div(class='class)
  314. </template>
  315. `,
  316. { filename: 'example.vue', sourceMap: true },
  317. ).descriptor.template as SFCTemplateBlock
  318. const result = compile({
  319. filename: 'example.vue',
  320. source: template.content,
  321. preprocessLang: template.lang,
  322. })
  323. expect(result.errors.length).toBe(1)
  324. const message = result.errors[0].toString()
  325. expect(message).toMatch(`Error: example.vue:3:1`)
  326. expect(message).toMatch(
  327. `The end of the string reached with no closing bracket ) found.`,
  328. )
  329. })
  330. // #3447
  331. test('should generate the correct imports expression', () => {
  332. const { code } = compile({
  333. filename: 'example.vue',
  334. source: `
  335. <img src="./foo.svg"/>
  336. <Comp>
  337. <img src="./bar.svg"/>
  338. </Comp>
  339. `,
  340. ssr: true,
  341. })
  342. expect(code).toMatch(`_ssrRenderAttr(\"src\", _imports_1)`)
  343. expect(code).toMatch(`_createVNode(\"img\", { src: _imports_1 })`)
  344. })
  345. // #3874
  346. test('should not hoist srcset URLs in SSR mode', () => {
  347. const { code } = compile({
  348. filename: 'example.vue',
  349. source: `
  350. <picture>
  351. <source srcset="./img/foo.svg"/>
  352. <img src="./img/foo.svg"/>
  353. </picture>
  354. <router-link>
  355. <picture>
  356. <source srcset="./img/bar.svg"/>
  357. <img src="./img/bar.svg"/>
  358. </picture>
  359. </router-link>
  360. `,
  361. ssr: true,
  362. })
  363. expect(code).toMatchSnapshot()
  364. })
  365. // #6742
  366. test('dynamic v-on + static v-on should merged', () => {
  367. const source = `<input @blur="onBlur" @[validateEvent]="onValidateEvent">`
  368. const result = compile({ filename: 'example.vue', source })
  369. expect(result.code).toMatchSnapshot()
  370. })
  371. // #9853 regression found in Nuxt tests
  372. // walkIdentifiers can get called multiple times on the same node
  373. // due to #9729 calling it during SFC template usage check.
  374. // conditions needed:
  375. // 1. `<script setup lang="ts">`
  376. // 2. Has import
  377. // 3. inlineTemplate: false
  378. // 4. AST being reused
  379. test('prefixing edge case for reused AST', () => {
  380. const src = `
  381. <script setup lang="ts">
  382. import { Foo } from './foo'
  383. </script>
  384. <template>
  385. {{ list.map((t, index) => ({ t: t })) }}
  386. </template>
  387. `
  388. const { descriptor } = parse(src)
  389. // compileScript triggers importUsageCheck
  390. compileScript(descriptor, { id: 'xxx' })
  391. const { code } = compileTemplate({
  392. id: 'xxx',
  393. filename: 'test.vue',
  394. ast: descriptor.template!.ast,
  395. source: descriptor.template!.content,
  396. })
  397. expect(code).not.toMatch(`_ctx.t`)
  398. })
  399. test('prefixing edge case for reused AST ssr mode', () => {
  400. const src = `
  401. <script setup lang="ts">
  402. import { Foo } from './foo'
  403. </script>
  404. <template>
  405. <Bar>
  406. <template #option="{ foo }"></template>
  407. </Bar>
  408. </template>
  409. `
  410. const { descriptor } = parse(src)
  411. // compileScript triggers importUsageCheck
  412. compileScript(descriptor, { id: 'xxx' })
  413. expect(() =>
  414. compileTemplate({
  415. id: 'xxx',
  416. filename: 'test.vue',
  417. ast: descriptor.template!.ast,
  418. source: descriptor.template!.content,
  419. ssr: true,
  420. }),
  421. ).not.toThrowError()
  422. })
  423. // #10852
  424. test('non-identifier expression in legacy filter syntax', () => {
  425. const src = `
  426. <template>
  427. <div>
  428. Today is
  429. {{ new Date() | formatDate }}
  430. </div>
  431. </template>
  432. `
  433. const { descriptor } = parse(src)
  434. const compilationResult = compileTemplate({
  435. id: 'xxx',
  436. filename: 'test.vue',
  437. ast: descriptor.template!.ast,
  438. source: descriptor.template!.content,
  439. ssr: false,
  440. compilerOptions: {
  441. compatConfig: {
  442. MODE: 2,
  443. },
  444. },
  445. })
  446. expect(() => {
  447. babelParse(compilationResult.code, { sourceType: 'module' })
  448. }).not.toThrow()
  449. })
  450. interface Pos {
  451. line: number
  452. column: number
  453. name?: string
  454. }
  455. function getPositionInCode(
  456. code: string,
  457. token: string,
  458. expectName: string | boolean = false,
  459. ): Pos {
  460. const generatedOffset = code.indexOf(token)
  461. let line = 1
  462. let lastNewLinePos = -1
  463. for (let i = 0; i < generatedOffset; i++) {
  464. if (code.charCodeAt(i) === 10 /* newline char code */) {
  465. line++
  466. lastNewLinePos = i
  467. }
  468. }
  469. const res: Pos = {
  470. line,
  471. column:
  472. lastNewLinePos === -1
  473. ? generatedOffset
  474. : generatedOffset - lastNewLinePos - 1,
  475. }
  476. if (expectName) {
  477. res.name = typeof expectName === 'string' ? expectName : token
  478. }
  479. return res
  480. }