[rush] New commands "rush link-package" and "rush bridge-package"

[L-Qun]

Summary

Since the relevant background has already been introduced in the Design Proposal, this section will mainly focus on some implementation details.

Details

rush link-package

rush link-package will create a symbolic link of the target package to the node_modules directory of the current package.

Usage:

rush link-package --path /path/to/repo/target-library
rush link-package --path /path/to/repo/target-library --project my-project --project framework

rush bridge-package

Since rush link-package cannot resolve issues caused by peerDependencies, we provide rush bridge-package to address this problem, which is based on hard links and symbolic links.

It is based on pnpm-sync behind the scenes, which means it will automatically help me with synchronization during the build.

At the same time, we should have the concept that we cannot fully equate this with installing third-party dependencies, nor should we attempt to implement this capability.

Let's say the target-package includes react as a peerDependency, the current dependency model is:

Usage:

rush bridge-package --path /path/to/repo/target-library
rush bridge-package --path /path/to/repo/target-library --project my-project --project framework

We also offer a way to directly replace the artifacts, backed by pnpm-sync behind the scenes.

Usage:

rush bridge-package --path /path/to/repo/target-library --replace
rush bridge-package --path /path/to/repo/target-library --project my-project --project framework --replace

rush-link-state.json

rush-link-state.json used to store information about packages connected via rush link-package and rush bridge-package commands.

common/temp/rush-link-state.json

Thus, it can be avoided from being skipped when running rush install.

How it was tested

The target package can be correctly accessed under the current package.