feat: support ignore option for glob import

docs/guide/features.md

@@ -248,6 +248,21 @@ const modules = {
 }
 ```
 
+You can also pass the second argument to ignore some files:
+
+```js
+const modules = import.meta.glob('./dir/*.js', '**/b*.*')
+```
+
+That will ignore all files whose name starts with `b`, the file `./dir/bar.js` will be ignored, the above will be transformed into the following:
+
+```js
+// code produced by vite
+const modules = {
+  './dir/foo.js': () => import('./dir/foo.js')
+}
+```
+
 Note that:
 
 - This is a Vite-only feature and is not a web or ES standard.

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

@@ -3,7 +3,8 @@ import {
   editFile,
   isBuild,
   removeFile,
-  untilUpdated
+  untilUpdated,
+  sortObjectDeep
 } from '../../testUtils'
 
 const filteredResult = {
@@ -14,21 +15,17 @@ const filteredResult = {
 
 // json exports key order is altered during build, but it doesn't matter in
 // terms of behavior since module exports are not ordered anyway
-const json = isBuild
-  ? {
-      msg: 'baz',
-      default: {
-        msg: 'baz'
-      }
-    }
-  : {
-      default: {
-        msg: 'baz'
-      },
-      msg: 'baz'
-    }
+const json = {
+  msg: 'baz',
+  default: {
+    msg: 'baz'
+  }
+}
 
-const allResult = {
+const allResult = sortObjectDeep({
+  '/dir/_ignored.js': {
+    msg: 'ignored'
+  },
   // JSON file should be properly transformed
   '/dir/baz.json': json,
   '/dir/foo.js': {
@@ -43,7 +40,7 @@ const allResult = {
     },
     msg: 'bar'
   }
-}
+})
 
 test('should work', async () => {
   expect(await page.textContent('.result')).toBe(
@@ -53,36 +50,72 @@ test('should work', async () => {
 
 if (!isBuild) {
   test('hmr for adding/removing files', async () => {
-    addFile('dir/a.js', '')
+    addFile('dir/+a.js', '')
+    await untilUpdated(
+      () => page.textContent('.result'),
+      JSON.stringify(
+        sortObjectDeep({
+          '/dir/+a.js': {},
+          ...allResult
+        }),
+        null,
+        2
+      )
+    )
+
+    // edit the added file
+    editFile('dir/+a.js', () => 'export const msg ="a"')
+    await untilUpdated(
+      () => page.textContent('.result'),
+      JSON.stringify(
+        sortObjectDeep({
+          '/dir/+a.js': {
+            msg: 'a'
+          },
+          ...allResult
+        }),
+        null,
+        2
+      )
+    )
+
+    removeFile('dir/+a.js')
+    await untilUpdated(
+      () => page.textContent('.result'),
+      JSON.stringify(allResult, null, 2)
+    )
+  })
+  test('hmr for adding/removing files with ignore option', async () => {
+    addFile('dir/_a.js', '')
     await untilUpdated(
       () => page.textContent('.result'),
       JSON.stringify(
-        {
-          '/dir/a.js': {},
+        sortObjectDeep({
+          '/dir/_a.js': {},
           ...allResult
-        },
+        }),
         null,
         2
       )
     )
 
     // edit the added file
-    editFile('dir/a.js', () => 'export const msg ="a"')
+    editFile('dir/_a.js', () => 'export const msg ="a"')
     await untilUpdated(
       () => page.textContent('.result'),
       JSON.stringify(
-        {
-          '/dir/a.js': {
+        sortObjectDeep({
+          '/dir/_a.js': {
             msg: 'a'
           },
           ...allResult
-        },
+        }),
         null,
         2
       )
     )
 
-    removeFile('dir/a.js')
+    removeFile('dir/_a.js')
     await untilUpdated(
       () => page.textContent('.result'),
       JSON.stringify(allResult, null, 2)

packages/playground/glob-import/dir/_ignored.js

@@ -0,0 +1 @@
+export const msg = 'ignored'

packages/playground/glob-import/dir/index.js

@@ -1,3 +1,3 @@
-const modules = import.meta.globEager('./*.js')
+const modules = import.meta.globEager('./*.js', './_*.js')
 
 export { modules }

packages/playground/glob-import/index.html

@@ -2,7 +2,8 @@
 
 <script type="module" src="./dir/index.js"></script>
 <script type="module">
-  const modules = import.meta.glob('/dir/**')
+  import sortObjectDeep from './sortObjectDeep'
+  const modules = sortObjectDeep(import.meta.glob('/dir/**'))
 
   for (const path in modules) {
     modules[path]().then((mod) => {
@@ -14,7 +15,7 @@
   Promise.all(keys.map((key) => modules[key]())).then((mods) => {
     const res = {}
     mods.forEach((m, i) => {
-      res[keys[i]] = m
+      res[keys[i]] = typeof m === 'object' ? sortObjectDeep(m) : m
     })
     document.querySelector('.result').textContent = JSON.stringify(res, null, 2)
   })

packages/playground/glob-import/sortObjectDeep.js

@@ -0,0 +1,15 @@
+export default function sortObjectDeep(target) {
+  if (!target || typeof target !== 'object') return target
+  return Object.keys(target)
+    .sort()
+    .reduce(
+      (acc, item) => ({
+        ...acc,
+        [item]:
+          typeof target[item] === 'object'
+            ? sortObjectDeep(target[item])
+            : target[item]
+      }),
+      {}
+    )
+}

packages/playground/testUtils.ts

@@ -114,3 +114,49 @@ export async function untilUpdated(
     }
   }
 }
+
+/**
+ * Sort an object by key, { c: 1, b: 3, a: 2, e: 4 } => { a: 2, b: 3, c: 1, e: 4 }
+ * @param target
+ */
+export function sortObjectDeep<T extends object = object>(target: T): T {
+  if (!target || typeof target !== 'object') return target
+  return Object.keys(target)
+    .sort()
+    .reduce<T>(
+      (acc, item) => ({
+        ...acc,
+        [item]:
+          typeof target[item] === 'object'
+            ? sortObjectDeep(target[item])
+            : target[item]
+      }),
+      {} as T
+    )
+}
+
+export function stringifyObjectWithSort(
+  value: any,
+  replacer?: (this: any, key: string, value: any) => any,
+  space?: string | number
+): string
+export function stringifyObjectWithSort(
+  value: any,
+  replacer?: (number | string)[] | null,
+  space?: string | number
+): string
+export function stringifyObjectWithSort(
+  value: any,
+  replacer?:
+    | ((this: any, key: string, value: any) => any)
+    | (number | string)[]
+    | null,
+  space?: string | number
+): string {
+  const finalValue = typeof value === 'object' ? sortObjectDeep(value) : value
+  // Must check to fix overload of JSON.stringify
+  if (typeof replacer === 'function') {
+    return JSON.stringify(finalValue, replacer, space)
+  }
+  return JSON.stringify(finalValue, replacer, space)
+}

packages/vite/client.d.ts

@@ -26,7 +26,8 @@ interface ImportMeta {
   readonly env: ImportMetaEnv
 
   glob(
-    pattern: string
+    pattern: string,
+    ignore?: string
   ): Record<
     string,
     () => Promise<{
@@ -35,7 +36,8 @@ interface ImportMeta {
   >
 
   globEager(
-    pattern: string
+    pattern: string,
+    ignore?: string
   ): Record<
     string,
     {

packages/vite/src/node/importGlob.ts

@@ -23,6 +23,7 @@ export async function transformImportGlob(
   endIndex: number
   isEager: boolean
   pattern: string
+  ignore?: string
   base: string
 }> {
   const isEager = source.slice(pos, pos + 21) === 'import.meta.globEager'
@@ -36,7 +37,7 @@ export async function transformImportGlob(
   importer = cleanUrl(importer)
   const importerBasename = path.basename(importer)
 
-  let [pattern, endIndex] = lexGlobPattern(source, pos)
+  let [pattern, ignore, endIndex] = lexGlobPattern(source, pos)
   if (!pattern.startsWith('.') && !pattern.startsWith('/')) {
     throw err(`pattern must start with "." or "/" (relative to project root)`)
   }
@@ -59,7 +60,7 @@ export async function transformImportGlob(
   }
   const files = glob.sync(pattern, {
     cwd: base,
-    ignore: ['**/node_modules/**']
+    ignore: ['**/node_modules/**', ...(ignore ? [ignore] : [])]
   })
   const imports: string[] = []
   let importsString = ``
@@ -102,6 +103,7 @@ export async function transformImportGlob(
     endIndex,
     isEager,
     pattern,
+    ignore,
     base
   }
 }
@@ -110,14 +112,30 @@ const enum LexerState {
   inCall,
   inSingleQuoteString,
   inDoubleQuoteString,
-  inTemplateString
+  inTemplateString,
+  inComma
 }
 
-function lexGlobPattern(code: string, pos: number): [string, number] {
+function lexGlobPattern(
+  code: string,
+  pos: number
+): [string, string | undefined, number] {
+  const startPos = code.indexOf(`(`, pos) + 1
+  const [pattern, endIndexOfPattern] = lexString(code, startPos)
+  const posOfIgnorePattern = findNextArgumentPos(code, endIndexOfPattern)
+  const [ignore, endIndex] =
+    posOfIgnorePattern === -1
+      ? [undefined, endIndexOfPattern]
+      : lexString(code, posOfIgnorePattern)
+
+  return [pattern, ignore, code.indexOf(`)`, endIndex) + 1]
+}
+
+function lexString(code: string, pos: number): [string, number] {
   let state = LexerState.inCall
   let pattern = ''
 
-  let i = code.indexOf(`(`, pos) + 1
+  let i = pos
   outer: for (; i < code.length; i++) {
     const char = code.charAt(i)
     switch (state) {
@@ -159,12 +177,51 @@ function lexGlobPattern(code: string, pos: number): [string, number] {
         throw new Error('unknown import.meta.glob lexer state')
     }
   }
-  return [pattern, code.indexOf(`)`, i) + 1]
+  return [pattern, i + 1]
+}
+
+// it will return -1 if not found next argument
+function findNextArgumentPos(code: string, pos: number): number {
+  let state: LexerState.inComma | undefined = undefined
+  let i = pos
+  outer: for (; i < code.length; i++) {
+    const char = code.charAt(i)
+    switch (state) {
+      case undefined:
+        if (char === ',') {
+          state = LexerState.inComma
+        } else if (char === ')') {
+          i = -1
+          break outer
+        } else if (/\s/.test(char)) {
+          continue
+        } else {
+          error(i)
+        }
+        break
+      case LexerState.inComma:
+        if (char === `'`) {
+          break outer
+        } else if (char === `"`) {
+          break outer
+        } else if (char === '`') {
+          break outer
+        } else if (/\s/.test(char)) {
+          continue
+        } else {
+          error(i)
+        }
+        break
+      default:
+        throw new Error('unknown import.meta.glob lexer state')
+    }
+  }
+  return i
 }
 
 function error(pos: number) {
   const err = new Error(
-    `import.meta.glob() can only accept string literals.`
+    `import.meta.glob() can only accept one or two string literals.`
   ) as RollupError
   err.pos = pos
   throw err