[rushjs.io] Document "rush-pnpm" and "rushx" and Rush's folder tree #119
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…t explains the entire folder tree. Add docs for rush-pnpm and rushx.
stekycz
reviewed
Jan 13, 2023
| | common/temp/npm-local/... | Based on the **npmVersion** setting, Rush will install NPM in your home directory and create a symlink to it for each repo that requests it. | | ||
| | common/temp/npm-tmp/... | Temporary files created by NPM during installation. | | ||
| | common/temp/projects/... | Synthetic projects referenced by **common/temp/package.json**. | | ||
| | common/temp/rush-recycler/... | Used to speed up recursive deletes. | |
There was a problem hiding this comment.
Would it make sense to mention common/temp/telemetry/... directory here?
There was a problem hiding this comment.
Yes, good suggestion!
| | common/temp/node_modules/... | The installed packages. This is a plain old `npm install` output, with no symlinks in this tree. | | ||
| | common/temp/npm-cache/... | A local NPM cache will be created here. Rush does not use the global NPM cache due to its concurrency problems. | | ||
| | common/temp/npm-local/... | Based on the **npmVersion** setting, Rush will install NPM in your home directory and create a symlink to it for each repo that requests it. | | ||
| | common/temp/npm-tmp/... | Temporary files created by NPM during installation. | |
There was a problem hiding this comment.
Would it make sense to mention common/temp/pnpm-local/... and common/temp/pnpm-store/... as well? What about Yarn specific directories?
|
|
||
| | Folder path | What it does | | ||
| | :---------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | common/temp/build-cache/... | Default storage location for Rush's [Build cache](../maintainer/build_cache.md) | |
There was a problem hiding this comment.
Would it make sense to mention common/deploy/... directory here?
There was a problem hiding this comment.
I added it in the Configuration files section
| | :-------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | common/autoinstallers/... | [Autoinstaller projects](../maintainer/autoinstallers.md) are created under this folder | | ||
| | common/changes/... | Stores change files created by the [rush change](../commands/rush_change.md) command and consumed by the [rush version](../commands/rush_version.md) command. | | ||
| | common/git-hooks/... | Rush's [git hook scripts](../maintainer/git_hooks.md) are defined here | |
There was a problem hiding this comment.
Would it make sense to mention common/pnpm-patches/... directory here?
| | common/temp/npm-cache/... | A local NPM cache will be created here. Rush does not use the global NPM cache due to its concurrency problems. | | ||
| | common/temp/npm-local/... | Based on the **npmVersion** setting, Rush will install NPM in your home directory and create a symlink to it for each repo that requests it. | | ||
| | common/temp/npm-tmp/... | Temporary files created by NPM during installation. | | ||
| | common/temp/projects/... | Synthetic projects referenced by **common/temp/package.json**. | |
There was a problem hiding this comment.
Would it make sense to mention common/temp/patches/... directory here?
There was a problem hiding this comment.
I wasn't aware of this one -- had to read about how rush-pnpm commit-patch works 😆
| | [common/config/rush/experiments.json](../configs/experiments_json.md) | Enables experimental features of Rush | | ||
| | common/config/rush/npm-shrinkwrap.json | The shrinkwrap file when your package manager is NPM. This is the common shrinkwrap file that applies to all projects in the Rush repo. For more information, see **"What is this "shrinkwrap file"** in the [Everyday commands](../developer/everyday_commands.md) section. | | ||
| | common/config/rush/pnpm-lock.yaml | The shrinkwrap file when your package manager is PNPM. | | ||
| | common/config/rush/yarn.lock | The shrinkwrap file when your package manager is Yarn. | |
There was a problem hiding this comment.
Would it make sense to mention common/config/rush/repo-state.json file here?
| | common/config/rush/browser-approved-packages.json | Used by the **approvedPackagesPolicy** setting from [rush.json](../configs/rush_json.md) | | ||
| | common/config/rush/nonbrowser-approved-packages.json | Used by the **approvedPackagesPolicy** setting from rush.json | | ||
| | [common/config/rush/pnpm-config.json](../configs/pnpm-config_json.md) | Configuration specific to the PNPM package manager | | ||
| | [common/config/rush/version-policies.json](../configs/version-policies_json.md) | Defines the [rush version](../commands/rush_version.md) and [rush publish](../commands/rush_publish.md) workflows. | |
There was a problem hiding this comment.
Would it make sense to mention common/config/rush/rush-plugins.json file here?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This also includes docs for the microsoft/rushstack#3872 feature