Skip to content

Commit

Permalink
README: Add <br /> between short and long options.
Browse files Browse the repository at this point in the history
  • Loading branch information
raineorshine committed Oct 4, 2023
1 parent 13eea1b commit 0cd9b67
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 17 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e.
<td>Include deprecated packages.</td>
</tr>
<tr>
<td>-d, --doctor</td>
<td>-d<br />--doctor</td>
<td>Iteratively installs upgrades and runs tests to identify breaking upgrades. Requires <code>-u</code> to execute.</td>
</tr>
<tr>
Expand All @@ -223,11 +223,11 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e.
<td>Include only packages that satisfy engines.node as specified in the package file.</td>
</tr>
<tr>
<td>-e, --errorLevel <n></td>
<td>-e<br />--errorLevel <n></td>
<td>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)</td>
</tr>
<tr>
<td>-f, --filter <p></td>
<td>-f<br />--filter <p></td>
<td>Include only package names matching the given string, wildcard, glob, comma-or-space-delimited list, /regex/, or predicate function.</td>
</tr>
<tr>
Expand All @@ -243,7 +243,7 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e.
<td>Modify the output formatting or show additional information. Specify one or more comma-delimited values: group, ownerChanged, repo, time, lines. (default: [])</td>
</tr>
<tr>
<td>-g, --global</td>
<td>-g<br />--global</td>
<td>Check global packages instead of in the current project.</td>
</tr>
<tr>
Expand All @@ -255,11 +255,11 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e.
<td>Control the auto-install behavior: always, never, prompt. (default: "prompt")</td>
</tr>
<tr>
<td>-i, --interactive</td>
<td>-i<br />--interactive</td>
<td>Enable interactive prompts for each dependency; implies <code>-u</code> unless one of the json options are set.</td>
</tr>
<tr>
<td>-j, --jsonAll</td>
<td>-j<br />--jsonAll</td>
<td>Output new package file instead of human-readable message.</td>
</tr>
<tr>
Expand All @@ -271,15 +271,15 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e.
<td>Output upgraded dependencies in json.</td>
</tr>
<tr>
<td>-l, --loglevel <n></td>
<td>-l<br />--loglevel <n></td>
<td>Amount to log: silent, error, minimal, warn, info, verbose, silly. (default: "warn")</td>
</tr>
<tr>
<td>--mergeConfig</td>
<td>Merges nested configs with the root config file for <code>--deep</code> or <code>--packageFile</code> options. (default: false)</td>
</tr>
<tr>
<td>-m, --minimal</td>
<td>-m<br />--minimal</td>
<td>Do not upgrade newer versions that are already satisfied by the version range according to semver.</td>
</tr>
<tr>
Expand All @@ -291,7 +291,7 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e.
<td>Package file(s) location. (default: ./package.json)</td>
</tr>
<tr>
<td>-p, --packageManager <s></td>
<td>-p<br />--packageManager <s></td>
<td>npm, yarn, pnpm, deno, bun, staticRegistry (default: npm).</td>
</tr>
<tr>
Expand All @@ -307,15 +307,15 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e.
<td>Current working directory of npm.</td>
</tr>
<tr>
<td>-r, --registry <uri></td>
<td>-r<br />--registry <uri></td>
<td>Specify the registry to use when looking up package versions.</td>
</tr>
<tr>
<td>--registryType <type></td>
<td>Specify whether --registry refers to a full npm registry or a simple JSON file or url: npm, json. (default: npm)</td>
</tr>
<tr>
<td>-x, --reject <p></td>
<td>-x<br />--reject <p></td>
<td>Exclude packages matching the given string, wildcard, glob, comma-or-space-delimited list, /regex/, or predicate function.</td>
</tr>
<tr>
Expand All @@ -335,35 +335,35 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e.
<td>Runs updates on the root project in addition to specified workspaces. Only allowed with <code>--workspace</code> or <code>--workspaces</code>. (default: false)</td>
</tr>
<tr>
<td>-s, --silent</td>
<td>-s<br />--silent</td>
<td>Don't output anything. Alias for <code>--loglevel</code> silent.</td>
</tr>
<tr>
<td>--stdin</td>
<td>Read package.json from stdin.</td>
</tr>
<tr>
<td>-t, --target <value></td>
<td>-t<br />--target <value></td>
<td>Determines the version to upgrade to: latest, newest, greatest, minor, patch, semver, @[tag], or [function]. (default: latest)</td>
</tr>
<tr>
<td>--timeout <ms></td>
<td>Global timeout in milliseconds. (default: no global timeout and 30 seconds per npm-registry-fetch)</td>
</tr>
<tr>
<td>-u, --upgrade</td>
<td>-u<br />--upgrade</td>
<td>Overwrite package file with upgraded versions instead of just outputting to console.</td>
</tr>
<tr>
<td>--verbose</td>
<td>Log additional information for debugging. Alias for <code>--loglevel</code> verbose.</td>
</tr>
<tr>
<td>-w, --workspace <s></td>
<td>-w<br />--workspace <s></td>
<td>Run on one or more specified workspaces. Add <code>--root</code> to also upgrade the root project. (default: [])</td>
</tr>
<tr>
<td>-ws, --workspaces</td>
<td>-ws<br />--workspaces</td>
<td>Run on all workspaces. Add <code>--root</code> to also upgrade the root project.</td>
</tr>
</table>
Expand Down
2 changes: 1 addition & 1 deletion src/scripts/build-options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const injectReadme = async () => {
const optionRows = cliOptions
.map(option => {
return ` <tr>
<td>${option.short ? `-${option.short}, ` : ''}${option.cli !== false ? '--' : ''}${option.long}${
<td>${option.short ? `-${option.short}<br />` : ''}${option.cli !== false ? '--' : ''}${option.long}${
option.arg ? ` <${option.arg}>` : ''
}</td>
<td>${codeHtml(option.description)}${option.default ? ` (default: ${JSON.stringify(option.default)})` : ''}</td>
Expand Down

0 comments on commit 0cd9b67

Please sign in to comment.