feat: import.meta.glob support ?raw (vitejs#5545)

Author: ygj6

packages/playground/glob-import/__tests__/glob-import.spec.ts

@@ -45,12 +45,24 @@ const allResult = {
   }
 }
 
+const rawResult = {
+  '/dir/baz.json': {
+    msg: 'baz'
+  }
+}
+
 test('should work', async () => {
   expect(await page.textContent('.result')).toBe(
     JSON.stringify(allResult, null, 2)
   )
 })
 
+test('import glob raw', async () => {
+  expect(await page.textContent('.globraw')).toBe(
+    JSON.stringify(rawResult, null, 2)
+  )
+})
+
 if (!isBuild) {
   test('hmr for adding/removing files', async () => {
     addFile('dir/a.js', '')

packages/playground/glob-import/index.html

@@ -1,4 +1,5 @@
 <pre class="result"></pre>
+<pre class="globraw"></pre>
 
 <script type="module" src="./dir/index.js"></script>
 <script type="module">
@@ -25,3 +26,18 @@
     document.querySelector('.result').textContent = JSON.stringify(res, null, 2)
   })
 </script>
+
+<script type="module">
+  const rawModules = import.meta.globEager('/dir/*.json', {
+    assert: { type: 'raw' }
+  })
+  const globraw = {}
+  Object.keys(rawModules).forEach((key) => {
+    globraw[key] = JSON.parse(rawModules[key])
+  })
+  document.querySelector('.globraw').textContent = JSON.stringify(
+    globraw,
+    null,
+    2
+  )
+</script>

packages/vite/package.json

@@ -45,6 +45,7 @@
   "//": "READ CONTRIBUTING.md to understand what to put under deps vs. devDeps!",
   "dependencies": {
     "esbuild": "^0.13.12",
+    "json5": "^2.2.0",
     "postcss": "^8.4.5",
     "resolve": "^1.20.0",
     "rollup": "^2.59.0"

packages/vite/src/node/importGlob.ts

@@ -1,5 +1,7 @@
 import path from 'path'
+import { promises as fsp } from 'fs'
 import glob from 'fast-glob'
+import * as JSON5 from 'json5'
 import {
   isModernFlag,
   preloadMethod,
@@ -8,6 +10,12 @@ import {
 import { cleanUrl } from './utils'
 import type { RollupError } from 'rollup'
 
+export interface AssertOptions {
+  assert?: {
+    type: string
+  }
+}
+
 export async function transformImportGlob(
   source: string,
   pos: number,
@@ -38,7 +46,7 @@ export async function transformImportGlob(
   importer = cleanUrl(importer)
   const importerBasename = path.basename(importer)
 
-  let [pattern, endIndex] = lexGlobPattern(source, pos)
+  let [pattern, assertion, endIndex] = lexGlobPattern(source, pos)
   if (!pattern.startsWith('.') && !pattern.startsWith('/')) {
     throw err(`pattern must start with "." or "/" (relative to project root)`)
   }
@@ -79,8 +87,12 @@ export async function transformImportGlob(
       ;[importee] = await normalizeUrl(file, pos)
     }
     imports.push(importee)
-    const identifier = `__glob_${importIndex}_${i}`
-    if (isEager) {
+    if (assertion?.assert?.type === 'raw') {
+      entries += ` ${JSON.stringify(file)}: ${JSON.stringify(
+        await fsp.readFile(path.join(base, file), 'utf-8')
+      )},`
+    } else if (isEager) {
+      const identifier = `__glob_${importIndex}_${i}`
       importsString += `import ${
         isEagerDefault ? `` : `* as `
       }${identifier} from ${JSON.stringify(importee)};`
@@ -115,7 +127,10 @@ const enum LexerState {
   inTemplateString
 }
 
-function lexGlobPattern(code: string, pos: number): [string, number] {
+function lexGlobPattern(
+  code: string,
+  pos: number
+): [string, AssertOptions, number] {
   let state = LexerState.inCall
   let pattern = ''
 
@@ -163,7 +178,13 @@ function lexGlobPattern(code: string, pos: number): [string, number] {
   }
 
   const endIndex = getEndIndex(code, i)
-  return [pattern, endIndex + 1]
+  const options = code.substring(i + 1, endIndex)
+  const commaIndex = options.indexOf(`,`)
+  let assert = {}
+  if (commaIndex > -1) {
+    assert = JSON5.parse(options.substr(commaIndex + 1))
+  }
+  return [pattern, assert, endIndex + 1]
 }
 
 // reg without the 'g' option, only matches the first match