fix(resolve): handle package.json with UTF-8 BOM (#19000)

sapenlei · web-flow · commit 902567ac5327 · 2024-12-24T17:17:44.000+09:00
diff --git a/packages/vite/src/node/packages.ts b/packages/vite/src/node/packages.ts
@@ -6,6 +6,7 @@ import {
   isInNodeModules,
   normalizePath,
   safeRealpathSync,
+  stripBomTag,
   tryStatSync,
 } from './utils'
 import type { Plugin } from './plugin'
@@ -175,7 +176,7 @@ export function findNearestMainPackageData(
 }
 
 export function loadPackageData(pkgPath: string): PackageData {
-  const data = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'))
+  const data = JSON.parse(stripBomTag(fs.readFileSync(pkgPath, 'utf-8')))
   const pkgDir = normalizePath(path.dirname(pkgPath))
   const { sideEffects } = data
   let hasSideEffects: (id: string) => boolean | null
diff --git a/playground/resolve/__tests__/resolve.spec.ts b/playground/resolve/__tests__/resolve.spec.ts
@@ -248,3 +248,7 @@ test.runIf(isBuild)('public dir is not copied', async () => {
     fs.existsSync(path.resolve(testDir, 'dist/should-not-be-copied')),
   ).toBe(false)
 })
+
+test('import utf8-bom package', async () => {
+  expect(await page.textContent('.utf8-bom-package')).toMatch('[success]')
+})
diff --git a/playground/resolve/index.html b/playground/resolve/index.html
@@ -176,6 +176,9 @@ <h2>resolve package that contains # in path</h2>
 <h2>resolve non normalized absolute path</h2>
 <p class="non-normalized"></p>
 
+<h2>utf8-bom-package</h2>
+<p class="utf8-bom-package">fail</p>
+
 <script type="module">
   import '@generated-content-virtual-file'
   function text(selector, text) {
@@ -399,6 +402,9 @@ <h2>resolve non normalized absolute path</h2>
 
   import nonNormalizedAbsolute from '@non-normalized'
   text('.non-normalized', nonNormalizedAbsolute)
+
+  import { msg as utf8BomPackage } from '@vitejs/test-utf8-bom-package'
+  text('.utf8-bom-package', utf8BomPackage)
 </script>
 
 <style>
diff --git a/playground/resolve/package.json b/playground/resolve/package.json
@@ -40,6 +40,7 @@
     "@vitejs/test-resolve-exports-with-module-condition-required": "link:./exports-with-module-condition-required",
     "@vitejs/test-resolve-linked": "workspace:*",
     "@vitejs/test-resolve-imports-pkg": "link:./imports-path/other-pkg",
-    "@vitejs/test-resolve-sharp-dir": "link:./sharp-dir"
+    "@vitejs/test-resolve-sharp-dir": "link:./sharp-dir",
+    "@vitejs/test-utf8-bom-package": "link:./utf8-bom-package"
   }
 }
diff --git a/playground/resolve/utf8-bom-package/index.mjs b/playground/resolve/utf8-bom-package/index.mjs
@@ -0,0 +1 @@
+﻿export const msg = '[success]'
diff --git a/playground/resolve/utf8-bom-package/package.json b/playground/resolve/utf8-bom-package/package.json
@@ -0,0 +1,8 @@
+﻿{
+  "name": "@vitejs/test-utf8-bom-package",
+  "private": true,
+  "version": "1.0.0",
+  "exports": {
+    ".": "./index.mjs"
+  }
+}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,7 @@`
`40`	`40`	`"@vitejs/test-resolve-exports-with-module-condition-required": "link:./exports-with-module-condition-required",`
`41`	`41`	`"@vitejs/test-resolve-linked": "workspace:*",`
`42`	`42`	`"@vitejs/test-resolve-imports-pkg": "link:./imports-path/other-pkg",`
`43`		`- "@vitejs/test-resolve-sharp-dir": "link:./sharp-dir"`
	`43`	`+ "@vitejs/test-resolve-sharp-dir": "link:./sharp-dir",`
	`44`	`+ "@vitejs/test-utf8-bom-package": "link:./utf8-bom-package"`
`44`	`45`	`}`
`45`	`46`	`}`