Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add ignore-workspace-root-check info #619

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: add ignore-workspace-root-check info #619

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4716466
docs: add `ignore-workspace-root-check` info
happycollision Jan 2, 2025
7b1b28f
Document the `-w` alias for `pnpm add`
happycollision Jan 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/cli/add.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ pnpm's default semver range operator.
Using `--save-peer` will add one or more packages to `peerDependencies` and
install them as dev dependencies.

### --ignore-workspace-root-check
### --ignore-workspace-root-check, -w

Adding a new dependency to the root workspace package fails, unless the
`--ignore-workspace-root-check` or `-w` flag is used.
Expand Down
9 changes: 9 additions & 0 deletions docs/npmrc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1012,6 +1012,15 @@ When executing commands recursively in a workspace, execute them on the root wor

When set to `true`, no workspace cycle warnings will be printed.

### ignore-workspace-root-check

* Default: **false**
* Type: **Boolean**

When set to `true`, you can add dependencies to the workspace root _without_ using the `--ignore-workspace-root-check` or `-w` flag.

For instance, `pnpm add debug` will fail in the workspace root unless this setting is true. (`pnpm add debug -w` will always work.)

### disallow-workspace-cycles

* Default: **false**
Expand Down