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

--ignore-workspace option undocumented #7802

Open
2 of 4 tasks
laesse opened this issue Mar 16, 2024 · 1 comment · May be fixed by #7804
Open
2 of 4 tasks

--ignore-workspace option undocumented #7802

laesse opened this issue Mar 16, 2024 · 1 comment · May be fixed by #7804

Comments

@laesse
Copy link

laesse commented Mar 16, 2024

Verify latest release

  • I verified that the issue exists in the latest pnpm release

pnpm version

No response

Which area(s) of pnpm are affected? (leave empty if unsure)

CLI

Link to the code that reproduces this issue or a replay of the bug

No response

Reproduction steps

Our team is currently migrating a ~50 package monorepo into a pnpm workspace. (each package is a self-contained node microservice)
We are doing an incremental migration where we would migrate service by service into the workspace.

Describe the Bug

The big problem we ran into was that as soon we had the pnpm-workspace.yml in a parent directory, the package management commands would affect the workspace even if the current directory was not in the workspace.

This was a big problem because this put the incremental migration approach at risk.
After some googling, we found this discussion post and it solved our problem exactly.
But we could not find a reference to this in the pnpm documentation. Neither the docs nor in the help reference this command.

Expected Behavior

A mention of the --ignore-workspace option in the help of

  • add
  • remove
  • update

proposed documentation:
stolen from: https://github.com/pnpm/pnpm/releases/tag/v6.25.0

--ignore-workspace         When used, pnpm ignores any workspace configuration found in the current or parent directories.

Which Node.js version are you using?

v20.11.0

Which operating systems have you used?

  • macOS
  • Windows
  • Linux

If your OS is a Linux based, which one it is? (Include the version if relevant)

No response

@laesse laesse linked a pull request Mar 16, 2024 that will close this issue
@zkochan
Copy link
Member

zkochan commented Mar 17, 2024

It is probably best to add it to the docs. Maybe here: https://pnpm.io/pnpm-cli#options

We can't add all options to the CLI help, just the most frequently used ones.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants