diff --git a/README.md b/README.md index 1317764a..8bf9bdc8 100644 --- a/README.md +++ b/README.md @@ -207,7 +207,7 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e. Include deprecated packages. - -d, --doctor + -d
--doctor Iteratively installs upgrades and runs tests to identify breaking upgrades. Requires -u to execute. @@ -223,11 +223,11 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e. Include only packages that satisfy engines.node as specified in the package file. - -e, --errorLevel + -e
--errorLevel Set the error level. 1: exits with error code 0 if no errors occur. 2: exits with error code 0 if no packages need updating (useful for continuous integration). (default: 1) - -f, --filter

+ -f
--filter

Include only package names matching the given string, wildcard, glob, comma-or-space-delimited list, /regex/, or predicate function. @@ -243,7 +243,7 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e. Modify the output formatting or show additional information. Specify one or more comma-delimited values: group, ownerChanged, repo, time, lines. (default: []) - -g, --global + -g
--global Check global packages instead of in the current project. @@ -255,11 +255,11 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e. Control the auto-install behavior: always, never, prompt. (default: "prompt") - -i, --interactive + -i
--interactive Enable interactive prompts for each dependency; implies -u unless one of the json options are set. - -j, --jsonAll + -j
--jsonAll Output new package file instead of human-readable message. @@ -271,7 +271,7 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e. Output upgraded dependencies in json. - -l, --loglevel + -l
--loglevel Amount to log: silent, error, minimal, warn, info, verbose, silly. (default: "warn") @@ -279,7 +279,7 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e. Merges nested configs with the root config file for --deep or --packageFile options. (default: false) - -m, --minimal + -m
--minimal Do not upgrade newer versions that are already satisfied by the version range according to semver. @@ -291,7 +291,7 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e. Package file(s) location. (default: ./package.json) - -p, --packageManager + -p
--packageManager npm, yarn, pnpm, deno, bun, staticRegistry (default: npm). @@ -307,7 +307,7 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e. Current working directory of npm. - -r, --registry + -r
--registry Specify the registry to use when looking up package versions. @@ -315,7 +315,7 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e. Specify whether --registry refers to a full npm registry or a simple JSON file or url: npm, json. (default: npm) - -x, --reject

+ -x
--reject

Exclude packages matching the given string, wildcard, glob, comma-or-space-delimited list, /regex/, or predicate function. @@ -335,7 +335,7 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e. Runs updates on the root project in addition to specified workspaces. Only allowed with --workspace or --workspaces. (default: false) - -s, --silent + -s
--silent Don't output anything. Alias for --loglevel silent. @@ -343,7 +343,7 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e. Read package.json from stdin. - -t, --target + -t
--target Determines the version to upgrade to: latest, newest, greatest, minor, patch, semver, @[tag], or [function]. (default: latest) @@ -351,7 +351,7 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e. Global timeout in milliseconds. (default: no global timeout and 30 seconds per npm-registry-fetch) - -u, --upgrade + -u
--upgrade Overwrite package file with upgraded versions instead of just outputting to console. @@ -359,11 +359,11 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e. Log additional information for debugging. Alias for --loglevel verbose. - -w, --workspace + -w
--workspace Run on one or more specified workspaces. Add --root to also upgrade the root project. (default: []) - -ws, --workspaces + -ws
--workspaces Run on all workspaces. Add --root to also upgrade the root project. diff --git a/src/scripts/build-options.ts b/src/scripts/build-options.ts index e653a934..73637ef3 100644 --- a/src/scripts/build-options.ts +++ b/src/scripts/build-options.ts @@ -17,7 +17,7 @@ const injectReadme = async () => { const optionRows = cliOptions .map(option => { return ` - ${option.short ? `-${option.short}, ` : ''}${option.cli !== false ? '--' : ''}${option.long}${ + ${option.short ? `-${option.short}
` : ''}${option.cli !== false ? '--' : ''}${option.long}${ option.arg ? ` <${option.arg}>` : '' } ${codeHtml(option.description)}${option.default ? ` (default: ${JSON.stringify(option.default)})` : ''}