全局安装的CLI应用如何正确加载package.json？

核心问题 #

你遇到的问题是因为执行CLI命令时的工作目录不是包的安装目录，直接用相对路径./package.json会读取当前执行路径的文件，而非包根目录的package.json。

正确解决方案 #

情况1：原生Node.js（未使用打包工具） #

如果你的CLI是原生Node.js编写，未经过打包压缩，以下两种方式都能正确读取：

ES模块写法（你的项目用ES模块时）

import { fileURLToPath } from 'url';
import { dirname, join } from 'path';
import fs from 'fs';

// 获取当前CLI文件（bin/clip.js）的绝对路径
const __filename = fileURLToPath(import.meta.url);
// 获取当前文件所在目录（bin/）的绝对路径
const __dirname = dirname(__filename);
// 拼接上级目录的package.json路径
const packageJsonPath = join(__dirname, '../package.json');

// 读取并解析package.json
const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
console.log(packageJson.version);

CommonJS写法（如果用require而非import）

const path = require('path');
const fs = require('fs');

// 直接用__dirname拼接路径（CommonJS中__dirname默认存在）
const packageJsonPath = path.join(__dirname, '../package.json');
const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
console.log(packageJson.version);

情况2：使用打包工具（如esbuild、pkg、webpack） #

如果你的CLI经过打包工具编译成单个文件，__dirname和import.meta.url会指向临时执行路径而非原包目录，此时需要：

1. 在打包配置中将package.json作为资源嵌入，或者
2. 提前将版本号注入到代码中：
   • 比如在package.json中定义版本号，打包时通过环境变量替换代码中的版本占位符：

     // 代码中写占位符
     const version = process.env.CLI_VERSION || 'unknown';
     

     • 打包时传递环境变量：CLI_VERSION=$(node -p require('./package.json').version) esbuild ...

关键检查点 #

1. 确认包的发布结构：执行npm pack生成tar包，解压后检查是否满足：

   app-name/
   ├── package.json
   └── bin/
       └── clip.js
   

   确保package.json和bin目录在同一层级。
2. 排除npm忽略规则：检查.npmignore文件，确保没有排除package.json；如果用files字段在package.json中声明发布文件，要包含package.json和bin/目录。

内容的提问来源于stack exchange，提问作者iosifv