pnpm-link 2.0.0 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +11 -4
  2. package/dist/index.js +22 -15
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -10,6 +10,7 @@
10
10
  - 默认在当前执行目录下查找 `package.json`
11
11
  - 支持 `file:` 与 `link:` 两种依赖协议,默认使用 `link:`
12
12
  - 支持 `--save-dev` / `--save-prod`
13
+ - 默认只修改 `package.json`;使用 `--install` 时才运行 `pnpm install`
13
14
 
14
15
  ## 安装
15
16
 
@@ -33,7 +34,7 @@ cd /path/to/project-b
33
34
  pnpm-link link @my-scope/my-lib --save-dev
34
35
  ```
35
36
 
36
- 第一条命令会把 A 包注册到 pnpm 全局包目录;如果包声明了 `bin`,也会在全局 bin 目录创建对应链接。第二条命令会把指向 A 源码目录的 `link:` 依赖写入 B 的 `devDependencies`,并自动运行 `pnpm install`。A 中源码的修改会直接反映在 B 使用的链接包中。
37
+ 第一条命令会把 A 包注册到 pnpm 全局包目录;如果包声明了 `bin`,也会在全局 bin 目录创建对应链接。第二条命令会把指向 A 源码目录的 `link:` 依赖写入 B 的 `devDependencies`,默认不运行 `pnpm install`。如需立即更新安装,可加上 `--install`。A 中源码的修改会直接反映在 B 使用的链接包中。
37
38
 
38
39
  不传 `--save-dev` 时,依赖默认写入 `dependencies`。也可以直接链接本地路径:
39
40
 
@@ -45,9 +46,12 @@ pnpm-link link ./packages/my-lib --protocol file
45
46
  ## 解除链接
46
47
 
47
48
  ```bash
48
- # 项目 B:移除 link: 或 file: 依赖并更新安装
49
+ # 项目 B:移除 link: 或 file: 依赖
49
50
  pnpm-link unlink @my-scope/my-lib
50
51
 
52
+ # 移除依赖后同时更新安装
53
+ pnpm-link unlink @my-scope/my-lib --install
54
+
51
55
  # 项目 A:注销全局包及其命令行 bin 链接
52
56
  pnpm-link unlink --global
53
57
  ```
@@ -57,12 +61,15 @@ pnpm-link unlink --global
57
61
  ## 命令参数
58
62
 
59
63
  - `pnpm-link link <package-name|path>`:将全局包或本地路径包链接到当前项目
64
+ - `pnpm-link link <package-name|path> --install`:链接后运行 `pnpm install`
60
65
  - `pnpm-link link --global`:将当前包注册到 pnpm 全局目录
61
66
  - `pnpm-link unlink <package-name>`:从当前项目移除链接依赖
67
+ - `pnpm-link unlink <package-name> --install`:移除链接后运行 `pnpm install`
62
68
  - `pnpm-link unlink --global`:从 pnpm 全局目录注销当前包
63
69
  - `-D, --save-dev`:写入 `devDependencies`
64
70
  - `-P, --save-prod`:写入 `dependencies`
65
71
  - `-p, --protocol <protocol>`:依赖协议,可选 `file` 或 `link`,默认 `link`
72
+ - `-i, --install`:更新项目依赖后运行 `pnpm install`;默认不运行安装
66
73
  - `-h, --help`:显示帮助
67
74
  - `-v, --version`:显示版本
68
75
 
@@ -71,6 +78,6 @@ pnpm-link unlink --global
71
78
  ## 实现原理
72
79
 
73
80
  - `link --global` 根据当前 `package.json` 的包名,将包目录符号链接到 `pnpm root -g`;声明的 `bin` 命令也会链接到 `pnpm bin -g`
74
- - `link <package-name>` 从全局包目录查找包;`link <path>` 解析本地路径。随后将 `file:` 或 `link:` 依赖写入当前项目的 `package.json`,并运行 `pnpm install`
75
- - `unlink <package-name>` 从项目的依赖字段移除对应的 `link:` / `file:` 依赖,并运行 `pnpm install`
81
+ - `link <package-name>` 从全局包目录查找包;`link <path>` 解析本地路径。随后将 `file:` 或 `link:` 依赖写入当前项目的 `package.json`;只有指定 `--install` 时才运行 `pnpm install`
82
+ - `unlink <package-name>` 从项目的依赖字段移除对应的 `link:` / `file:` 依赖;只有指定 `--install` 时才运行 `pnpm install`
76
83
  - `unlink --global` 只移除指向当前包及其 bin 文件的全局符号链接
package/dist/index.js CHANGED
@@ -31,7 +31,7 @@ var require_package = __commonJS({
31
31
  "package.json"(exports2, module2) {
32
32
  module2.exports = {
33
33
  name: "pnpm-link",
34
- version: "1.1.0",
34
+ version: "2.0.0",
35
35
  description: "\u628A\u5168\u5C40\u5DF2 link \u7684\u5305\u6216\u672C\u5730\u5305\u5199\u5165\u5F53\u524D\u9879\u76EE\u4F9D\u8D56\uFF0C\u9002\u7528\u4E8E pnpm \u5DE5\u4F5C\u6D41",
36
36
  keywords: [
37
37
  "pnpm",
@@ -912,7 +912,8 @@ function linkPackageToProject(options) {
912
912
  packageName,
913
913
  targetPkgPath = "./package.json",
914
914
  depType = "dependencies",
915
- protocol = "link"
915
+ protocol = "link",
916
+ install = false
916
917
  } = options;
917
918
  const targetAbs = import_node_path.default.resolve(targetPkgPath);
918
919
  if (!import_node_fs.default.existsSync(targetAbs)) {
@@ -934,14 +935,16 @@ function linkPackageToProject(options) {
934
935
  if (!pkg[depType]) pkg[depType] = {};
935
936
  pkg[depType][depKey] = depValue;
936
937
  import_node_fs.default.writeFileSync(targetAbs, JSON.stringify(pkg, null, 2) + "\n");
937
- (0, import_node_child_process.execSync)("pnpm install", {
938
- cwd: projectDir,
939
- stdio: "inherit"
940
- });
938
+ if (install) {
939
+ (0, import_node_child_process.execSync)("pnpm install", {
940
+ cwd: projectDir,
941
+ stdio: "inherit"
942
+ });
943
+ }
941
944
  console.log(`\u2705 Updated ${depType}["${depKey}"] = "${depValue}"`);
942
945
  }
943
946
  function unlinkPackageFromProject(options) {
944
- const { packageName, targetPkgPath = "./package.json" } = options;
947
+ const { packageName, targetPkgPath = "./package.json", install = false } = options;
945
948
  assertValidPackageInput(packageName);
946
949
  const targetAbs = import_node_path.default.resolve(targetPkgPath);
947
950
  if (!import_node_fs.default.existsSync(targetAbs)) {
@@ -971,10 +974,12 @@ function unlinkPackageFromProject(options) {
971
974
  delete dependencies[packageName];
972
975
  }
973
976
  import_node_fs.default.writeFileSync(targetAbs, JSON.stringify(pkg, null, 2) + "\n");
974
- (0, import_node_child_process.execSync)("pnpm install", {
975
- cwd: projectDir,
976
- stdio: "inherit"
977
- });
977
+ if (install) {
978
+ (0, import_node_child_process.execSync)("pnpm install", {
979
+ cwd: projectDir,
980
+ stdio: "inherit"
981
+ });
982
+ }
978
983
  console.log(`\u2705 Removed linked dependency "${packageName}" from the project`);
979
984
  }
980
985
 
@@ -1011,7 +1016,8 @@ function runLinkCommand(packageName, options) {
1011
1016
  packageName,
1012
1017
  targetPkgPath: import_node_path2.default.resolve(process.cwd(), "package.json"),
1013
1018
  depType: resolveDepType(options),
1014
- protocol: options.protocol
1019
+ protocol: options.protocol,
1020
+ install: options.install
1015
1021
  });
1016
1022
  } catch (err) {
1017
1023
  console.error(err.message);
@@ -1036,7 +1042,8 @@ function runUnlinkCommand(packageName, options) {
1036
1042
  }
1037
1043
  unlinkPackageFromProject({
1038
1044
  packageName,
1039
- targetPkgPath: import_node_path2.default.resolve(process.cwd(), "package.json")
1045
+ targetPkgPath: import_node_path2.default.resolve(process.cwd(), "package.json"),
1046
+ install: options.install
1040
1047
  });
1041
1048
  } catch (err) {
1042
1049
  console.error(err.message);
@@ -1046,10 +1053,10 @@ function runUnlinkCommand(packageName, options) {
1046
1053
  var cli = cac("pnpm-link");
1047
1054
  cli.command("link [package-name]", "\u94FE\u63A5\u672C\u5730\u5305\u5230\u5F53\u524D\u9879\u76EE\uFF0C\u6216\u6CE8\u518C\u5F53\u524D\u5305\u5230\u5168\u5C40").option("-g, --global", "\u5C06\u5F53\u524D\u5305\u6CE8\u518C\u5230 pnpm \u5168\u5C40\u5305\u76EE\u5F55").option("-D, --save-dev", "\u5199\u5165 devDependencies").option("-P, --save-prod", "\u5199\u5165 dependencies").option("-p, --protocol <protocol>", "\u534F\u8BAE\u7C7B\u578B (file|link)", {
1048
1055
  default: "link"
1049
- }).example("pnpm-link link --global").example("pnpm-link link @scope/my-lib --save-dev").example("pnpm-link link ./packages/my-lib --protocol file").action((packageName, options) => {
1056
+ }).option("-i, --install", "\u66F4\u65B0 package.json \u540E\u8FD0\u884C pnpm install").example("pnpm-link link --global").example("pnpm-link link @scope/my-lib --save-dev").example("pnpm-link link ./packages/my-lib --protocol file").example("pnpm-link link @scope/my-lib --install").action((packageName, options) => {
1050
1057
  runLinkCommand(packageName, options);
1051
1058
  });
1052
- cli.command("unlink [package-name]", "\u89E3\u9664\u9879\u76EE\u4F9D\u8D56\u94FE\u63A5\uFF0C\u6216\u6CE8\u9500\u5F53\u524D\u5305\u7684\u5168\u5C40\u94FE\u63A5").option("-g, --global", "\u4ECE pnpm \u5168\u5C40\u76EE\u5F55\u6CE8\u9500\u5F53\u524D\u5305").example("pnpm-link unlink @scope/my-lib").example("pnpm-link unlink --global").action((packageName, options) => {
1059
+ cli.command("unlink [package-name]", "\u89E3\u9664\u9879\u76EE\u4F9D\u8D56\u94FE\u63A5\uFF0C\u6216\u6CE8\u9500\u5F53\u524D\u5305\u7684\u5168\u5C40\u94FE\u63A5").option("-g, --global", "\u4ECE pnpm \u5168\u5C40\u76EE\u5F55\u6CE8\u9500\u5F53\u524D\u5305").option("-i, --install", "\u66F4\u65B0 package.json \u540E\u8FD0\u884C pnpm install").example("pnpm-link unlink @scope/my-lib").example("pnpm-link unlink @scope/my-lib --install").example("pnpm-link unlink --global").action((packageName, options) => {
1053
1060
  runUnlinkCommand(packageName, options);
1054
1061
  });
1055
1062
  if (require.main === module) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pnpm-link",
3
- "version": "2.0.0",
3
+ "version": "2.1.0",
4
4
  "description": "把全局已 link 的包或本地包写入当前项目依赖,适用于 pnpm 工作流",
5
5
  "keywords": [
6
6
  "pnpm",