要在本地调试一个 npm 包(CLI 工具),可以按照以下步骤进行操作:
克隆或下载 npm 包的源代码到本地。
在终端中进入该代码的根目录。
运行
npm install
命令,以安装所有的依赖项。-
在 package.json 文件中查找 "bin" 字段,确定可执行命令的名称(假设为 "myWcf")。
-
在终端中执行以下命令,将可执行命令链接到全局环境:
npm link
这将在全局 npm 目录中创建一个符号链接,使得可以在任何地方使用该命令。
假设
local
是其中一条命令,c
是一个参数,在终端中输入命令myWcf
,即可运行该 CLI 工具
myWcf local -c 0
在调试期间,你可以使用调试器工具(如 VS Code 或 Node.js 自带的调试器)来设置断点、逐行调试和检查变量的值,以便更好地理解代码的执行过程和进行调试。比如,在scripts增加测试命令,在vscode中调试
-
首先创建launch.json文件
点击上面创建luanch.json文件
- 在scripts增加测试命令
"scripts": {
"testPack": "myWcf local -c 0"
}
-
点击图中的debug按钮,调出下面的选择界面
现在,你可以在本地调试该 npm 包,并对其进行修改和测试。任何对源代码的更改都会立即生效,无需重新安装。
当完成调试并对代码进行修改后,可以重新执行 npm link
命令来更新全局链接,并在其他项目中使用更新后的版本。