From 87ecce5008190b0e53d50cd86612a8125ab7b30a Mon Sep 17 00:00:00 2001
From: Rom <git@brillout.com>
Date: Tue, 8 Mar 2022 09:12:55 +0100
Subject: [PATCH] fix: deprecate `{ assert: { type: raw }}` in favor of `{ as:
 raw }` (fix #7017) (#7215)

---
 docs/guide/features.md                        |  4 +-
 packages/playground/glob-import/index.html    |  2 +-
 packages/vite/src/node/importGlob.ts          | 37 ++++++++++++++-----
 packages/vite/src/node/optimizer/scan.ts      | 12 ++++--
 .../vite/src/node/plugins/importAnalysis.ts   |  1 +
 .../src/node/plugins/importAnalysisBuild.ts   |  1 +
 packages/vite/types/importMeta.d.ts           | 16 +++++---
 7 files changed, 51 insertions(+), 22 deletions(-)

diff --git a/docs/guide/features.md b/docs/guide/features.md
index a892182678fc1b..7bf870646da909 100644
--- a/docs/guide/features.md
+++ b/docs/guide/features.md
@@ -298,10 +298,10 @@ const modules = {
 }
 ```
 
-`import.meta.glob` and `import.meta.globEager` also support importing files as strings, similar to [Importing Asset as String](https://vitejs.dev/guide/assets.html#importing-asset-as-string). Here, we use the [Import Assertions](https://github.com/tc39/proposal-import-assertions#synopsis) syntax to import.
+`import.meta.glob` and `import.meta.globEager` also support importing files as strings (similar to [Importing Asset as String](https://vitejs.dev/guide/assets.html#importing-asset-as-string)) with the [Import Reflection](https://github.com/tc39/proposal-import-reflection) syntax:
 
 ```js
-const modules = import.meta.glob('./dir/*.js', { assert: { type: 'raw' } })
+const modules = import.meta.glob('./dir/*.js', { as: 'raw' })
 ```
 
 The above will be transformed into the following:
diff --git a/packages/playground/glob-import/index.html b/packages/playground/glob-import/index.html
index bb5e2f3c18f752..52d41b817a169c 100644
--- a/packages/playground/glob-import/index.html
+++ b/packages/playground/glob-import/index.html
@@ -40,7 +40,7 @@
 
 <script type="module">
   const rawModules = import.meta.globEager('/dir/*.json', {
-    assert: { type: 'raw' }
+    as: 'raw'
   })
   const globraw = {}
   Object.keys(rawModules).forEach((key) => {
diff --git a/packages/vite/src/node/importGlob.ts b/packages/vite/src/node/importGlob.ts
index 1247d60f1284d9..8ed3ba66d09744 100644
--- a/packages/vite/src/node/importGlob.ts
+++ b/packages/vite/src/node/importGlob.ts
@@ -16,6 +16,8 @@ import {
   normalizePath
 } from './utils'
 import type { RollupError } from 'rollup'
+import type { Logger } from '.'
+import colors from 'picocolors'
 
 interface GlobParams {
   base: string
@@ -24,7 +26,11 @@ interface GlobParams {
   isAbsolute: boolean
 }
 
-export interface AssertOptions {
+interface GlobOptions {
+  as?: string
+  /**
+   * @deprecated
+   */
   assert?: {
     type: string
   }
@@ -50,6 +56,7 @@ export async function transformImportGlob(
   importer: string,
   importIndex: number,
   root: string,
+  logger: Logger,
   normalizeUrl?: (url: string, pos: number) => Promise<[string, string]>,
   resolve?: (url: string, importer?: string) => Promise<string | undefined>,
   preload = true
@@ -75,7 +82,7 @@ export async function transformImportGlob(
   importer = cleanUrl(importer)
   const importerBasename = path.basename(importer)
 
-  const [userPattern, assertion, endIndex] = lexGlobPattern(source, pos)
+  const [userPattern, options, endIndex] = lexGlobPattern(source, pos)
 
   let globParams: GlobParams | null = null
   if (userPattern.startsWith('/')) {
@@ -126,7 +133,19 @@ export async function transformImportGlob(
       ;[importee] = await normalizeUrl(file, pos)
     }
     imports.push(importee)
-    if (assertion?.assert?.type === 'raw') {
+    // TODO remove assert syntax for the Vite 3.0 release.
+    const isRawAssert = options?.assert?.type === 'raw'
+    const isRawType = options?.as === 'raw'
+    if (isRawType || isRawAssert) {
+      if (isRawAssert) {
+        logger.warn(
+          colors.yellow(
+            colors.bold(
+              "(!) import.meta.glob('...', { assert: { type: 'raw' }}) is deprecated. Use import.meta.glob('...', { as: 'raw' }) instead."
+            )
+          )
+        )
+      }
       entries += ` ${JSON.stringify(file)}: ${JSON.stringify(
         await fsp.readFile(path.join(base, file), 'utf-8')
       )},`
@@ -173,7 +192,7 @@ const enum LexerState {
 function lexGlobPattern(
   code: string,
   pos: number
-): [string, AssertOptions, number] {
+): [string, GlobOptions, number] {
   let state = LexerState.inCall
   let pattern = ''
 
@@ -225,14 +244,14 @@ function lexGlobPattern(
     .replace(multilineCommentsRE, blankReplacer)
 
   const endIndex = noCommentCode.indexOf(')')
-  const options = noCommentCode.substring(0, endIndex)
-  const commaIndex = options.indexOf(',')
+  const optionString = noCommentCode.substring(0, endIndex)
+  const commaIndex = optionString.indexOf(',')
 
-  let assert = {}
+  let options = {}
   if (commaIndex > -1) {
-    assert = JSON5.parse(options.substring(commaIndex + 1))
+    options = JSON5.parse(optionString.substring(commaIndex + 1))
   }
-  return [pattern, assert, endIndex + i + 2]
+  return [pattern, options, endIndex + i + 2]
 }
 
 function error(pos: number) {
diff --git a/packages/vite/src/node/optimizer/scan.ts b/packages/vite/src/node/optimizer/scan.ts
index dfffbc5cfdcd2b..ec936534ba644a 100644
--- a/packages/vite/src/node/optimizer/scan.ts
+++ b/packages/vite/src/node/optimizer/scan.ts
@@ -1,7 +1,7 @@
 import fs from 'fs'
 import path from 'path'
 import glob from 'fast-glob'
-import type { ResolvedConfig } from '..'
+import type { ResolvedConfig, Logger } from '..'
 import type { Loader, Plugin, OnLoadResult } from 'esbuild'
 import { build, transform } from 'esbuild'
 import {
@@ -296,7 +296,8 @@ function esbuildScanPlugin(
                     path,
                     config.root,
                     loader,
-                    resolve
+                    resolve,
+                    config.logger
                   )
                 }
               } else {
@@ -454,7 +455,8 @@ function esbuildScanPlugin(
             id,
             config.root,
             ext as Loader,
-            resolve
+            resolve,
+            config.logger
           ).then((contents) => ({
             loader: ext as Loader,
             contents
@@ -474,7 +476,8 @@ async function transformGlob(
   importer: string,
   root: string,
   loader: Loader,
-  resolve: (url: string, importer?: string) => Promise<string | undefined>
+  resolve: (url: string, importer?: string) => Promise<string | undefined>,
+  logger: Logger
 ) {
   // transform the content first since es-module-lexer can't handle non-js
   if (loader !== 'js') {
@@ -495,6 +498,7 @@ async function transformGlob(
       normalizePath(importer),
       index,
       root,
+      logger,
       undefined,
       resolve
     )
diff --git a/packages/vite/src/node/plugins/importAnalysis.ts b/packages/vite/src/node/plugins/importAnalysis.ts
index 939764c7a7a53c..121b5e61714171 100644
--- a/packages/vite/src/node/plugins/importAnalysis.ts
+++ b/packages/vite/src/node/plugins/importAnalysis.ts
@@ -355,6 +355,7 @@ export function importAnalysisPlugin(config: ResolvedConfig): Plugin {
               importer,
               index,
               root,
+              config.logger,
               normalizeUrl,
               resolve
             )
diff --git a/packages/vite/src/node/plugins/importAnalysisBuild.ts b/packages/vite/src/node/plugins/importAnalysisBuild.ts
index 2e2b116572752e..87afd8e1f12b00 100644
--- a/packages/vite/src/node/plugins/importAnalysisBuild.ts
+++ b/packages/vite/src/node/plugins/importAnalysisBuild.ts
@@ -158,6 +158,7 @@ export function buildImportAnalysisPlugin(config: ResolvedConfig): Plugin {
               importer,
               index,
               config.root,
+              config.logger,
               undefined,
               resolve,
               insertPreload
diff --git a/packages/vite/types/importMeta.d.ts b/packages/vite/types/importMeta.d.ts
index 732310490350eb..56b82125381e20 100644
--- a/packages/vite/types/importMeta.d.ts
+++ b/packages/vite/types/importMeta.d.ts
@@ -4,10 +4,14 @@
 
 /* eslint-disable @typescript-eslint/consistent-type-imports */
 
-// Duplicate import('../src/node/importGlob').AssertOptions
-// Avoid breaking the production client type because this file is referenced
-// in vite/client.d.ts and in production src/node/importGlob.ts doesn't exist
-interface AssertOptions {
+// Duplicate of import('../src/node/importGlob').GlobOptions in order to
+// avoid breaking the production client type. Because this file is referenced
+// in vite/client.d.ts and in production src/node/importGlob.ts doesn't exist.
+interface GlobOptions {
+  as?: string
+  /**
+   * @deprecated
+   */
   assert?: {
     type: string
   }
@@ -61,12 +65,12 @@ interface ImportMeta {
 
   glob<Module = { [key: string]: any }>(
     pattern: string,
-    options?: AssertOptions
+    options?: GlobOptions
   ): Record<string, () => Promise<Module>>
 
   globEager<Module = { [key: string]: any }>(
     pattern: string,
-    options?: AssertOptions
+    options?: GlobOptions
   ): Record<string, Module>
 }