pnpm-link
v1.0.3
Published
把全局已 link 的包或本地包写入当前项目依赖,适用于 pnpm 工作流
Maintainers
Readme
pnpm-link
把全局已 pnpm link 的包,或本地相对路径包,写入当前项目的 package.json 依赖中。
功能
- 支持全局已 link 的包名写入依赖
- 支持本地相对路径包写入依赖
- 默认在当前执行目录下查找
package.json - 支持
file:与link:两种协议,默认使用link: - 支持
--save-dev/--save-prod,与 npm install 语义一致
安装
npm i -g pnpm-link
# 或
pnpm add -g pnpm-link用法
pnpm-link <package-name>
pnpm-link <package-name> --save-dev
pnpm-link <package-name> --save-prod
pnpm-link ./packages/my-lib --protocol file
pnpm-link ./packages/my-lib --protocol link说明:
- 不需要手动传
package.json路径,默认会在当前执行目录下寻找./package.json - 不需要写
install子命令 - 默认会写入
dependencies - 使用
--save-dev时写入devDependencies
参数说明
-D, --save-dev:写入devDependencies-P, --save-prod:写入dependencies-p, --protocol <protocol>:协议类型,可选file或link,默认link-h, --help:显示帮助-v, --version:显示版本
示例
# 全局包写入 dependencies
pnpm-link my-package
# 全局包写入 devDependencies
pnpm-link my-package --save-dev
# 本地包写入 dependencies,默认使用 link 协议
pnpm-link ./packages/my-lib
# 本地包写入 dependencies,显式使用 file 协议
pnpm-link ./packages/my-lib --protocol file实现原理
命令会先解析包来源:
- 若参数是本地相对路径,直接解析该目录并其
package.json - 若参数是包名,则通过
pnpm root -g定位全局依赖目录 - 生成
file:或link:依赖值并写回当前工作目录的package.json - 最后执行
pnpm install让锁文件和 node_modules 更新
