Add documentation for Rush Package Manager #1628
Conversation
|
|
||
| ### New features | ||
|
|
||
| * Support for Rush Package Manager has been added under [Rush Detector](packagemgrs/rush.md) |
There was a problem hiding this comment.
Suggested rewording:
- [detect_product_short] now supports Rush Package Manager. For details and configuration information, see: Rush Detector.
|
|
||
| ## Overview | ||
|
|
||
| The Rush Detector will run in the presence of a rush.json file. |
There was a problem hiding this comment.
Suggestion:
When a rush.json file is present in the analyzed code, the Rush Detector will run.
|
|
||
| ## Extracting from pnpm-lock.yaml | ||
|
|
||
| The Rush detector will execute the same code as the [PNPM detector](pnpm.md). |
There was a problem hiding this comment.
Not sure if we need to call out PNPM detector code here? Perhaps a wording tweak for lines 20/22 like such:
When a pnpm-lock.yaml file is located in the analyzed directory, the Rush Detector will take PNPM detector related properties as input.
|
|
||
| Each package has a location within the project structure defined in the `rush.json` file. [detect_product_short] will parse it to find the type of package manager used and all the projects and its location. | ||
|
|
||
| It is expected to find some type of lock file within `common/config/rush` directory. |
There was a problem hiding this comment.
If a lockfile is a requirement for Rush Detector to function, I'd suggest the following text to replace 13/14/16:
Rush Detector requires one of pnpm-lock.yaml, npm-shrinkwrap.json, or yarn.lock be present in the common/config/rush directory of the analyzed project. If no lockfile is present in the common/config/rush directory, Rush Detector will exit.
|
|
||
| The Rush Detector will run in the presence of a rush.json file. | ||
|
|
||
| Each package has a location within the project structure defined in the `rush.json` file. [detect_product_short] will parse it to find the type of package manager used and all the projects and its location. |
There was a problem hiding this comment.
Suggested rewording:
Included packages have a location within the project structure defined in the rush.json file. [detect_product_short] will parse the rush.json file to determine the type of package manager used, included projects, and their locations.
|
|
||
| ### Exclude/Include Subspaces | ||
|
|
||
| Since PNPM package manager supports concept of subspaces in Rush, individual subspaces can be excluded/included in the scan result using properties defined here [Rush Subspaces](../properties/detectors/rush.md) |
There was a problem hiding this comment.
Since we define the subspace inclusion in the Rush properties, I am not sure if we need to mention PNPM package manager here?
Rush Detector supports inclusion and exclusions of individual subspaces in the scan results using properties defined here: Rush Subspaces.
There was a problem hiding this comment.
I am not sure but I think PNPM should be understandable from properties and also that this info belongs to the PNPM subsection.
|
|
||
| ## Extracting from npm-shrinkwrap.json | ||
|
|
||
| The Rush detector will execute the same code as the [NPM shrinkwrap detector](npm.md#npm-shrinkwrap). |
There was a problem hiding this comment.
Similar to PNPM, should we mention that Rush Detector is executing NPM code? OR just mention the NPM properties that are supported?
Same with Yarn Detector below.
There was a problem hiding this comment.
I will match the exact wording which is the PNPM to avoid any confusion for users.
Add docs for newly added Rush support.