From c05c239e8b23e02355eb1e9c121c5c7f351c6b12 Mon Sep 17 00:00:00 2001 From: Raine Revere Date: Wed, 4 Oct 2023 21:49:41 +0000 Subject: [PATCH] README: Link options table to advanced options. --- README.md | 26 +++++++++++++------------- src/scripts/build-options.ts | 6 +++--- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 1317764a..8c8230e3 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](doctor) Iteratively installs upgrades and runs tests to identify breaking upgrades. Requires -u to execute. @@ -227,19 +227,19 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e. 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](filter)

Include only package names matching the given string, wildcard, glob, comma-or-space-delimited list, /regex/, or predicate function. - filterResults + [filterResults](filterresults) Filters out upgrades based on a user provided function. - --filterVersion

+ [--filterVersion](filterversion)

Filter on package version using comma-or-space-delimited list, /regex/, or predicate function. - --format + [--format](format) Modify the output formatting or show additional information. Specify one or more comma-delimited values: group, ownerChanged, repo, time, lines. (default: []) @@ -247,11 +247,11 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e. Check global packages instead of in the current project. - groupFunction + [groupFunction](groupfunction) Customize how packages are divided into groups when using --format group. - --install + [--install](install) Control the auto-install behavior: always, never, prompt. (default: "prompt") @@ -291,11 +291,11 @@ 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](packagemanager) npm, yarn, pnpm, deno, bun, staticRegistry (default: npm). - --peer + [--peer](peer) Check peer dependencies of installed packages and filter updates to compatible versions. @@ -311,15 +311,15 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e. Specify the registry to use when looking up package versions. - --registryType + [--registryType](registrytype) Specify whether --registry refers to a full npm registry or a simple JSON file or url: npm, json. (default: npm) - -x, --reject

+ -x, [--reject](reject)

Exclude packages matching the given string, wildcard, glob, comma-or-space-delimited list, /regex/, or predicate function. - --rejectVersion

+ [--rejectVersion](rejectversion)

Exclude package.json versions using comma-or-space-delimited list, /regex/, or predicate function. @@ -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](target) Determines the version to upgrade to: latest, newest, greatest, minor, patch, semver, @[tag], or [function]. (default: latest) diff --git a/src/scripts/build-options.ts b/src/scripts/build-options.ts index e653a934..eead2ce3 100644 --- a/src/scripts/build-options.ts +++ b/src/scripts/build-options.ts @@ -17,9 +17,9 @@ const injectReadme = async () => { const optionRows = cliOptions .map(option => { return ` - ${option.short ? `-${option.short}, ` : ''}${option.cli !== false ? '--' : ''}${option.long}${ - option.arg ? ` <${option.arg}>` : '' - } + ${option.short ? `-${option.short}, ` : ''}${option.help ? `` : ''}${ + option.cli !== false ? '--' : '' + }${option.long}${option.help ? '' : ''}${option.arg ? ` <${option.arg}>` : ''} ${codeHtml(option.description)}${option.default ? ` (default: ${JSON.stringify(option.default)})` : ''} ` })