Skip to content

docs: add reporter setting to settings reference#768

Open
nozomiishii wants to merge 1 commit intopnpm:mainfrom
nozomiishii:docs/add-reporter-setting
Open

docs: add reporter setting to settings reference#768
nozomiishii wants to merge 1 commit intopnpm:mainfrom
nozomiishii:docs/add-reporter-setting

Conversation

@nozomiishii
Copy link
Copy Markdown

Summary

The reporter option is documented as a CLI flag (--reporter) on the install page, and it works correctly when set in either .npmrc or pnpm-workspace.yaml. However, it was missing from the settings reference page.

This omission causes practical issues for users who want to configure reporter at the project level:

  • Setting reporter=append-only in .npmrc triggers an npm warning:

    npm warn Unknown user config "reporter". This will stop working in the next major version of npm. See `npm help npmrc` for supported config options.
    
  • Setting reporter: append-only in pnpm-workspace.yaml triggers an editor/IDE warning from SchemaStore validation:

    Property reporter is not allowed. yaml-schema: pnpm Workspace (pnpm-workspace.yaml)(513)
    

Both configurations work as expected with pnpm, but users have no warning-free way to set this option.

Changes

Added reporter setting documentation between loglevel and useBetaCli in docs/settings.md, following the same format as other enum-type settings like color and loglevel.

Related

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
@bolt-new-by-stackblitz
Copy link
Copy Markdown

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

@vercel
Copy link
Copy Markdown

vercel Bot commented Mar 31, 2026

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

A member of the Team first needs to authorize it.

@nozomiishii
Copy link
Copy Markdown
Author

I've also submitted a PR to add reporter to the SchemaStore schema for pnpm-workspace.yaml: SchemaStore/schemastore#5512

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.

Add reporter config setting to npmrc

1 participant