ES6 Node.js中导入'.json'扩展名会抛出错误

Question

我们正在尝试使用ES6与Node.js的新方式导出和导入模块。从package.json文件中获取版本号对我们很重要。以下代码应该可以实现这一点：

import {name, version} from '../../package.json'

然而，在执行时会抛出以下错误：

TypeError [ERR_UNKNOWN_FILE_EXTENSION]: Unknown file extension ".json" for T:\ICP\package.json imported from T:\ICP\src\controllers\about.js

我们是否遗漏了什么？
扩展名为.json的文件不被支持吗？
在使用Node.js 13+时，是否有其他获取此信息的方法？

- DarkLite1

---

你在那个路径下有一个json文件吗？你尝试过其他导入方式，比如 import pkg from ('../../package.json') 吗？ - palaѕн

是的，.json 文件位置正确。 - DarkLite1

Answer 1

从 Node.js 版本 17.5.0 开始，可以使用 导入断言 来导入 JSON 文件：

import packageFile from "../../package.json" assert { type: "json" };

const {
    name,
    version
  } = packageFile;

• assert { type: "json" } 为必填项。
• 在 import 声明中直接进行解构赋值，如 { name, version } 是不可行的。
• JSON 文件的内容被导出为默认导出，因此需要从 default 中导入。

动态导入的版本如下：

const {
    default: {
      name,
      version
    }
  } = await import("../../package.json", {
    assert: {
      type: "json"
    }
  });

由于导入断言和JSON模块最近才晋升为第三阶段，旧版本的Node.js可能支持旧语法。

根据MDN上有关import声明和动态import的兼容性表，旧版本的Node.js(16.0.0 – 16.14.0 和 17.0.0 – 17.4.0)存在不同程度的支持：

• 这些版本需要使用 --experimental-json-modules 标志：

node --experimental-json-modules about.js

某些版本不支持动态import中的导入断言

某些版本不支持"json"类型，具体而言

某些版本依赖于较旧的建议，该建议尚未指定assert语法

- Idir Hamouch

---

嗨 Idder，加上标记 . yarn run dev --experimental-json-modules 后，我也遇到了同样的错误。这是用于运行我的项目的脚本。 - Hemant

每次都加那个标记很烦人。能不能永久设置呢？ - Kokodoko

@Kokodoko 你可以将该标志添加到 package.json 中的一个启动脚本中。 - jewbix.cube

Answer 2

你仍然可以在 Node.js 的 ES6 模块中导入 require ：

import { createRequire } from "module"; // Bring in the ability to create the 'require' method
const require = createRequire(import.meta.url); // construct the require method
const my_json_file = require("path/to/json/your-json-file.json") // use the require method

- Carter Cobb

---

Node.Js v15最新版本提示错误ReferenceError: require is not defined。 - C Alonso C Ortega

我们正在第二行创建require。如果未定义，那么您必须跳过了前几行。 - Carter Cobb

Answer 3

您可以像在node-js文档中一样使用它：

import { readFile } from 'fs/promises';

const json = JSON.parse(await readFile(new URL('../../package.json', import.meta.url)));

- DevHub

---

如果您正在服务器上执行此操作...我强烈推荐使用更干净的 fs-extra，它承诺一切透明，并支持递归目录复制。 - Ray Foss

eslint 抛出错误，因为 await 关键字只能在 async 函数内部使用。 - Sina

Answer 4

2022

来自Node.js v16 和 v18 官方文档：

import SomeJson from './some.json' assert { type: 'json' }

然后使用相应的实验性标志运行它：

node --experimental-json-modules ./your-file.js

- Ivan Gabriele

Answer 5

尝试使用

process.env.npm_package_version

这可能会对你有所帮助

- Osama Abdullah

---

只有在使用 npm 启动应用程序时才能正常工作，但这并非总是如此。 - DarkLite1

你尝试使用fs加载文件了吗？ - Osama Abdullah

这似乎是一种不好的做法，因为它会加载完整的文件，显示依赖项和其他信息，使应用程序容易受到攻击。 - DarkLite1

由于提到的安全问题以及对Deno和Qbrt的支持不足，这个功能可能会被移除。 - Ray Foss