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.

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: document the --ignore-workspace cli option #7804

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions cli/common-cli-options-help/src/index.ts
Expand Up @@ -7,6 +7,10 @@ export const OPTIONS = {
description: "Don't run lifecycle scripts",
name: '--ignore-scripts',
},
ignoreWorkspace: {
description: 'Ignore pnpm-workspace.yaml if exists in the parent directory, and treat the command as normal non-workspace command.',
name: '--ignore-workspace',
},
offline: {
description: 'Trigger an error if any required dependencies are not available in local store',
name: '--offline',
Expand Down
1 change: 1 addition & 0 deletions pkg-manager/plugin-commands-installation/src/add.ts
Expand Up @@ -136,6 +136,7 @@ For options that may be used with `-r`, see "pnpm help recursive"',
name: '--workspace',
},
OPTIONS.ignoreScripts,
OPTIONS.ignoreWorkspace,
OPTIONS.offline,
OPTIONS.preferOffline,
OPTIONS.storeDir,
Expand Down
1 change: 1 addition & 0 deletions pkg-manager/plugin-commands-installation/src/dedupe.ts
Expand Up @@ -34,6 +34,7 @@ export function help () {
name: '--check',
},
OPTIONS.ignoreScripts,
OPTIONS.ignoreWorkspace,
OPTIONS.offline,
OPTIONS.preferOffline,
OPTIONS.storeDir,
Expand Down
5 changes: 1 addition & 4 deletions pkg-manager/plugin-commands-installation/src/install.ts
Expand Up @@ -183,10 +183,7 @@ by any dependencies, so it is an emulation of a flat node_modules',
description: 'Disable pnpm hooks defined in .pnpmfile.cjs',
name: '--ignore-pnpmfile',
},
{
description: 'Ignore pnpm-workspace.yaml if exists in the parent directory, and treat the installation as normal non-workspace installation.',
name: '--ignore-workspace',
},
OPTIONS.ignoreWorkspace,
{
description: "If false, doesn't check whether packages in the store were mutated",
name: '--[no-]verify-store-integrity',
Expand Down
1 change: 1 addition & 0 deletions pkg-manager/plugin-commands-installation/src/remove.ts
Expand Up @@ -104,6 +104,7 @@ For options that may be used with `-r`, see "pnpm help recursive"',
name: '--save-prod',
shortAlias: '-P',
},
OPTIONS.ignoreWorkspace,
OPTIONS.globalDir,
...UNIVERSAL_OPTIONS,
],
Expand Down
Expand Up @@ -150,6 +150,7 @@ dependencies is not found inside the workspace',
name: '--interactive',
shortAlias: '-i',
},
OPTIONS.ignoreWorkspace,
OPTIONS.globalDir,
...UNIVERSAL_OPTIONS,
],
Expand Down