
在 node.js 的 es 模块(esm)环境中,无论程序是本地运行还是全局安装,均可通过 `createrequire(import.meta.url)` 动态创建 require 函数,从而同步、安全地加载自身 package.json 文件。
在现代 Node.js(v12.20+,推荐 v14.13+ 或更高)的 ESM 项目中,直接使用相对路径(如 "./package.json")读取自身元数据会因模块解析机制限制而失败——尤其当 CLI 工具被全局安装(npm install -g)或作为依赖被其他项目调用时,当前工作目录(process.cwd())与包实际安装路径往往不一致,导致 fs.readFile('./package.json') 报错。
幸运的是,Node.js 原生提供了两个关键能力来优雅解决该问题:
- import.meta.url:每个 ES 模块内可用的只读对象,其 url 属性返回一个 file:// 协议的绝对 URL(例如 file:///home/user/my-cli/dist/index.js),精确指向该模块文件的物理位置;
- createRequire():来自内置模块 'module' 的工厂函数,接收一个文件 URL 或路径,返回一个行为与 CommonJS require() 一致的函数,支持 JSON 文件自动解析(无需手动 JSON.parse())。
二者结合,即可构建出与模块安装位置无关、稳定可靠的 package.json 加载逻辑:
import { createRequire } from 'module';
// 创建基于当前模块位置的 require 函数
const require = createRequire(import.meta.url);
// 同步加载并解析 package.json(返回普通 JS 对象)
const pkg = require('./package.json');
console.log('Version:', pkg.version);
console.log('Name:', pkg.name);✅ 优势总结:
- 跨环境兼容:无论脚本位于源码根目录、dist/ 构建产物中,还是被全局安装至 /usr/local/lib/node_modules/,均能正确定位 package.json;
- 零依赖:仅使用 Node.js 内置 API,无需第三方库(如 pkg-up 或 find-up);
- 同步高效:避免异步 I/O 开销,适合 CLI 启动阶段快速读取元信息;
- ESM 原生友好:完美适配 .mjs 或 type: "module" 的 package.json 配置。
⚠️ 注意事项:
- 该方法仅适用于 ES 模块环境;若项目仍使用 CommonJS(.cjs 或 type: "commonjs"),应改用 require.resolve('./package.json') 配合 require();
- 确保 package.json 与当前模块处于同一包内(即未被 exports 字段隔离);若需从子包读取父包 JSON,请配合 path.dirname() 和 require.resolve() 进行路径跳转;
- 不要尝试对 import.meta.url 手动拼接路径(如 new URL('./package.json', import.meta.url)),因为 require() 在 ESM 下对 file:// URL 的解析更健壮,且自动处理 JSON 解析。
综上,createRequire(import.meta.url)('./package.json') 是当前 Node.js ESM 生态中读取自身 package.json 的标准实践,简洁、可靠、无副作用,值得在所有现代 CLI 工具和模块化应用中采用。










