Skip to content

docs(settings): add reporter as a valid CLI and config file option #658

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(settings): add reporter as a valid CLI and config file option #658

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 20 additions & 7 deletions docs/settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -488,10 +488,10 @@ Add the full URL to the package's tarball to every entry in `pnpm-lock.yaml`.
* Default: **false**
* Type: **Boolean**

When set to `true`, the generated lockfile name after installation will be named
When set to `true`, the generated lockfile name after installation will be named
based on the current branch name to completely avoid merge conflicts. For example,
if the current branch name is `feature-foo`, the corresponding lockfile name will
be `pnpm-lock.feature-foo.yaml` instead of `pnpm-lock.yaml`. It is typically used
be `pnpm-lock.feature-foo.yaml` instead of `pnpm-lock.yaml`. It is typically used
in conjunction with the command line argument `--merge-git-branch-lockfiles` or by
setting `mergeGitBranchLockfilesBranchPattern` in the `pnpm-workspace.yaml` file.

Expand All @@ -500,9 +500,9 @@ setting `mergeGitBranchLockfilesBranchPattern` in the `pnpm-workspace.yaml` file
* Default: **null**
* Type: **Array or null**

This configuration matches the current branch name to determine whether to merge
all git branch lockfile files. By default, you need to manually pass the
`--merge-git-branch-lockfiles` command line parameter. This configuration allows
This configuration matches the current branch name to determine whether to merge
all git branch lockfile files. By default, you need to manually pass the
`--merge-git-branch-lockfiles` command line parameter. This configuration allows
this process to be automatically completed.

For instance:
Expand Down Expand Up @@ -545,7 +545,7 @@ Define the authentication bearer token to use when accessing the specified
registry. For example:

```ini
//registry.npmjs.org/:_authToken=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
//registry.npmjs.org/:_authToken=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
```

You may also use an environment variable. For example:
Expand All @@ -557,7 +557,7 @@ You may also use an environment variable. For example:
Or you may just use an environment variable directly, without changing `.npmrc` at all:

```
npm_config_//registry.npmjs.org/:_authToken=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
npm_config_//registry.npmjs.org/:_authToken=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
```

### <URL>:tokenHelper
Expand Down Expand Up @@ -956,6 +956,19 @@ Controls colors in the output.
Any logs at or higher than the given level will be shown.
You can instead pass `--silent` to turn off all output logs.

### reporter

* Default: **default**
* Type: **silent**, **default**, **append-only**, **ndjson**

Controls the output of npm scripts.

* **silent** - No output is logged to the console, except fatal errors.
* **default** - The default reporter when the stdout is TTY.
* **append-only** - The output is always appended to the end. No cursor
manipulations are performed.
* **ndjson** - The most verbose reporter. Prints all logs in ndjson format

### useBetaCli

* Default: **false**
Expand Down