vite
vite copied to clipboard
Cannot import external JSON in vite.config.ts on Node v22
Describe the bug
EDIT: I thought I was trying to switch between Node.js versions using Volta, but in fact when I called vite from pnpm it was fixed at Node v22.
I tried again with v20 and found no problem when using import assertions, so I have corrected the title.
Import assertions have been disabled since Node v22.0.0, so we can import JSON up to Node v20 or v21 with no problem if we use the conventional notation: assert { type: "json" }.
I am trying to use @iconify-json/meteocons in my Vite plugin.
I tried the following import methods, but none of them worked:
import data from "@iconify-json/meteocons";
import data from "@iconify-json/meteocons/icons.json";
import data from "@iconify-json/meteocons/icons.json" assert { type: "json" };
import data from "@iconify-json/meteocons/icons.json" with { type: "json" };
Those will fail with one of the following errors:
TypeError [ERR_IMPORT_ATTRIBUTE_MISSING]: Module "file:///.../node_modules/@iconify-json/meteocons/icons.json" needs an import attribute of "type: json"
or
SyntaxError: Unexpected identifier 'assert'
I believe that importing JSON in ESM style config files is no longer possible in Node.js v22 because Node.js v22 only supports import attributes instead of deprecated import assertions, and because esbuild removes import attributes under certain conditions (at least with target: ["node18"]).
I have verified that by patching the following line to target: ["node22"], it works correctly for both Node v20 and Node v22.
https://github.com/vitejs/vite/blob/e7d38ab1c45b9d17f182f89d0c129932e2f994eb/packages/vite/src/node/config.ts#L1077
Reproduction
https://github.com/SegaraRai/vite-config-import-json
Steps to reproduce
Run pnpm i followed by pnpm build with Node.js v22.
An error log is also available in GitHub Actions.
System Info
System:
OS: Windows 11 10.0.22631
CPU: (12) x64 AMD Ryzen 5 2600X Six-Core Processor
Memory: 6.00 GB / 31.93 GB
Binaries:
Node: 22.2.0 - ~\AppData\Local\Volta\tools\image\node\22.2.0\node.EXE
Yarn: 1.22.18 - ~\AppData\Local\Volta\tools\image\yarn\1.22.18\bin\yarn.CMD
npm: 10.5.2 - ~\AppData\Local\Volta\tools\image\node\20.13.1\npm.CMD
pnpm: 9.0.6 - C:\Program Files\Volta\pnpm.EXE
bun: 1.1.8 - ~\.bun\bin\bun.EXE
Browsers:
Edge: Chromium (123.0.2420.97)
Internet Explorer: 11.0.22621.3527
npmPackages:
vite: ^5.2.11 => 5.2.11
Used Package Manager
pnpm
Logs
Click to expand! - ERR_IMPORT_ATTRIBUTE_MISSING version
> vite build "--debug"
failed to load config from ...\vite-config-import-json\vite.config.ts
error during build:
TypeError [ERR_IMPORT_ATTRIBUTE_MISSING]: Module "file:///.../vite-config-import-json/node_modules/.pnpm/@[email protected]/node_modules/@iconify-json/meteocons/icons.json" needs an import attribute of "type: json"
at validateAttributes (node:internal/modules/esm/assert:88:15)
at defaultLoad (node:internal/modules/esm/load:153:3)
at async ModuleLoader.load (node:internal/modules/esm/loader:541:7)
at async ModuleLoader.moduleProvider (node:internal/modules/esm/loader:422:45)
ELIFECYCLE Command failed with exit code 1.
Click to expand! - SyntaxError version
> vite build "--debug"
failed to load config from ...\vite-config-import-json\vite.config.ts
error during build:
SyntaxError: Unexpected identifier 'assert'
at compileSourceTextModule (node:internal/modules/esm/utils:337:16)
at ModuleLoader.moduleStrategy (node:internal/modules/esm/translators:166:18)
at callTranslator (node:internal/modules/esm/loader:416:14)
at ModuleLoader.moduleProvider (node:internal/modules/esm/loader:422:30)
at async link (node:internal/modules/esm/module_job:88:21)
ELIFECYCLE Command failed with exit code 1.
Validations
- [X] Follow our Code of Conduct
- [X] Read the Contributing Guidelines.
- [X] Read the docs.
- [X] Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
- [X] Make sure this is a Vite issue and not a framework-specific issue. For example, if it's a Vue SFC related bug, it should likely be reported to vuejs/core instead.
- [X] Check that this is a concrete bug. For Q&A open a GitHub Discussion or join our Discord Chat Server.
- [X] The provided reproduction is a minimal reproducible example of the bug.
Maybe duplicate of https://github.com/vitejs/vite/issues/14674, at least I noticed the same bug that vite incorrectly strips import assertions during compilation against a node18 target. esbuild alone preserves it fine with a node18 target.
In my case, I feel the problem in processing vite.config.ts, not in the bundling of app itself. Config files are bundled in a different manner than the app itself, and their settings are hard-coded.
BTW, there seems to be no doubt that esbuild is erasing import attributes.
target: ["node18"]: https://esbuild.github.io/try/#dAAwLjIxLjMALS10YXJnZXQ9Im5vZGUxOCIAaW1wb3J0IGRhdGEgZnJvbSAiZXh0ZXJuYWwuanNvbiIgd2l0aCB7IHR5cGU6ICJqc29uIiB9target: ["node22"]: https://esbuild.github.io/try/#dAAwLjIxLjMALS10YXJnZXQ9Im5vZGUyMiIAaW1wb3J0IGRhdGEgZnJvbSAiZXh0ZXJuYWwuanNvbiIgd2l0aCB7IHR5cGU6ICJqc29uIiB9
BTW, there seems to be no doubt that esbuild is erasing import attributes.
That looks like a bug in esbuild. They were initially introduced in node 21 but recently backported into 18 and 20. I opened https://github.com/evanw/esbuild/issues/3778.
For anyone having trouble: dynamic import is not converted by esbuild, so the following code will import JSON in Node v22 as well:
const { default: meteocons } = await import(
"@iconify-json/meteocons/icons.json",
{
with: { type: "json" },
}
);