docs: add reporter setting to settings reference#768
Open
nozomiishii wants to merge 1 commit intopnpm:mainfrom
Open
docs: add reporter setting to settings reference#768nozomiishii wants to merge 1 commit intopnpm:mainfrom
nozomiishii wants to merge 1 commit intopnpm:mainfrom
Conversation
The `reporter` option is available as a CLI flag (`--reporter`) and works in both `.npmrc` and `pnpm-workspace.yaml`, but it was missing from the settings documentation page. This causes confusion about the proper way to configure it. Closes pnpm/pnpm#7238
|
|
|
@nozomiishii is attempting to deploy a commit to the pnpm Team on Vercel. A member of the Team first needs to authorize it. |
Author
|
I've also submitted a PR to add |
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
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.
Summary
The
reporteroption is documented as a CLI flag (--reporter) on the install page, and it works correctly when set in either.npmrcorpnpm-workspace.yaml. However, it was missing from the settings reference page.This omission causes practical issues for users who want to configure
reporterat the project level:Setting
reporter=append-onlyin.npmrctriggers an npm warning:Setting
reporter: append-onlyinpnpm-workspace.yamltriggers an editor/IDE warning from SchemaStore validation:Both configurations work as expected with pnpm, but users have no warning-free way to set this option.
Changes
Added
reportersetting documentation betweenloglevelanduseBetaCliindocs/settings.md, following the same format as other enum-type settings likecolorandloglevel.Related
reporterconfig setting to npmrc pnpm#7238