[rush] Customize default installation #4976
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Provide a solution for package maintainers to configure how their project should be installed: as a local package or as an external module.
This PR proposes 2 new parameters on rush.json:
Details
In some cases, developers prefer their dependents to consume their packages using a fixed NPM version, even though the package source is part of the same monorepo. While they continue iterating on their code, they think it is not their responsibility to keep all the dependent projects updated and verified.
rush add
will always update the current package.json with "workspace:*" if this module exists in the current workspace. This should be configured by the package maintainer.Package maintainers should be able to flag their project, as a local or remote project (new parameter: installRemotely). Optionally, it should be possible to explicitly specify the version number, using version range (new parameter: versionRange).
"versionRange" will be ignored if the package is locally installed, i.e. "installRemotely" is false.
How it was tested
Tested manually in a local demo repository: https://github.com/pedro-gomes-92/rushstack-playground
Impacted documentation
https://api.rushstack.io/pages/rush-lib.rushconfiguration/#rushconfiguration-class