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: improve explanation of --prod flag #500

Merged
merged 2 commits into from
Jan 17, 2024

Conversation

CakeWithDivinity
Copy link
Contributor

The --prod flag for the pnpm install command is not well displayed as a boolean value.
It is unclear that one can use the flag like this pnpm install --prod=false to use a "development" install in a production environment. This has already happened to some people: pnpm/pnpm#6254

This PR tries to explain the option a bit better, so its use-case is a bit more clear, and aims to make the docs page more consistent.

I took inspiration from how the --frozen-lockfile option works: https://pnpm.io/cli/install#--frozen-lockfile

Copy link

stackblitz bot commented Jan 16, 2024

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

vercel bot commented Jan 16, 2024

@CakeWithDivinity is attempting to deploy a commit to the pnpm Team on Vercel.

A member of the Team first needs to authorize it.

docs/cli/install.md Outdated Show resolved Hide resolved
@zkochan zkochan merged commit 9c3f418 into pnpm:main Jan 17, 2024
1 of 2 checks passed
@CakeWithDivinity CakeWithDivinity deleted the install-prod-flag branch January 18, 2024 18:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants