Automatically mention extended help text in description if it exists.

Author: raineorshine

README.md

@@ -146,8 +146,8 @@ ncu "/^(?!react-).*$/" # windows
                              "prod,dev,bundle,optional")
 --deprecated                 Include deprecated packages.
 --doctor                     Iteratively installs upgrades and runs tests to
-                             identify breaking upgrades. Run "ncu --doctor"
-                             for detailed help. Add "-u" to execute.
+                             identify breaking upgrades. Requires "-u" to
+                             execute. Run "ncu --help --doctor" for details.
 --doctorInstall <command>    Specifies the install script to use in doctor
                              mode. (default: npm install/yarn)
 --doctorTest <command>       Specifies the test script to use in doctor mode.
@@ -198,7 +198,8 @@ ncu "/^(?!react-).*$/" # windows
 --pre <n>                    Include -alpha, -beta, -rc. (default: 0; default
                              with --newest and --greatest: 1)
 --prefix <path>              Current working directory of npm.
--r, --registry <uri>         Third-party npm registry.
+-r, --registry <uri>         Third-party npm registry. Run "ncu --help
+                             --registry" for details.
 -x, --reject <matches>       Exclude packages matching the given string,
                              wildcard, glob, comma-or-space-delimited list,
                              /regex/, or predicate function. (default: [])
@@ -213,8 +214,8 @@ ncu "/^(?!react-).*$/" # windows
 --stdin                      Read package.json from stdin.
 -t, --target <value>         Determines the version to upgrade to: latest,
                              newest, greatest, minor, patch, @[tag], or
-                             [function]. Run "ncu --help --target" for
-                             details. (default: "latest")
+                             [function]. (default: latest). Run "ncu --help
+                             --target" for details.
 --timeout <ms>               Global timeout in milliseconds. (default: no
                              global timeout and 30 seconds per
                              npm-registry-fetch)

src/bin/cli.ts

@@ -50,11 +50,12 @@ program
   .usage('[options] [filter]')
 
 // add cli options
-cliOptions.forEach(({ long, short, arg, description, default: defaultValue, parse }) =>
+cliOptions.forEach(({ long, short, arg, description, default: defaultValue, help, parse }) =>
   // handle 3rd/4th argument polymorphism
   program.option(
     `${short ? `-${short}, ` : ''}--${long}${arg ? ` <${arg}>` : ''}`,
-    description,
+    // point to help in description if extended help text is available
+    `${description}${help ? ` Run "ncu --help --${long}" for details.` : ''}`,
     parse || defaultValue,
     parse ? defaultValue : undefined,
   ),

src/cli-options.ts

@@ -260,7 +260,7 @@ const cliOptions: CLIOption[] = [
   {
     long: 'doctor',
     description:
-      'Iteratively installs upgrades and runs tests to identify breaking upgrades. Requires "-u" to execute. Run "ncu --help --doctor" for details.',
+      'Iteratively installs upgrades and runs tests to identify breaking upgrades. Requires "-u" to execute.',
     type: 'boolean',
     help: extendedHelpDoctor(),
   },
@@ -309,7 +309,7 @@ const cliOptions: CLIOption[] = [
     long: 'format',
     arg: 'value',
     description:
-      'Modify the output formatting or show additional information. Specify one or more comma-delimited values: group, ownerChanged, repo. Run "ncu --help --format" for details.',
+      'Modify the output formatting or show additional information. Specify one or more comma-delimited values: group, ownerChanged, repo.',
     parse: value => (typeof value === 'string' ? value.split(',') : value),
     default: [],
     type: 'string[]',
@@ -382,14 +382,13 @@ const cliOptions: CLIOption[] = [
     short: 'p',
     arg: 'name',
     // manual default to allow overriding auto yarn detection
-    description: 'npm, yarn, staticRegistry (default: npm). Run "ncu --help --packageManager" for details.',
+    description: 'npm, yarn, staticRegistry (default: npm).',
     help: extendedHelpPackageManager(),
     type: 'string',
   },
   {
     long: 'peer',
-    description:
-      'Check peer dependencies of installed packages and filter updates to compatible versions. Run "ncu --help --peer" for details.',
+    description: 'Check peer dependencies of installed packages and filter updates to compatible versions.',
     type: 'boolean',
     help: `Check peer dependencies of installed packages and filter updates to compatible versions.
 
@@ -448,7 +447,7 @@ As a comparison: without using the --peer option, ncu will suggest the latest ve
     description: 'Third-party npm registry.',
     help: wrap(`Specify the registry to use when looking up package version numbers.
 
-When --packageManager staticRegistry is set, --registry must specify a path to a JSON registry file. Run "ncu --help --packageManager" for details.`),
+When --packageManager staticRegistry is set, --registry must specify a path to a JSON registry file.`),
     type: 'string',
   },
   {
@@ -496,7 +495,7 @@ When --packageManager staticRegistry is set, --registry must specify a path to a
     short: 't',
     arg: 'value',
     description:
-      'Determines the version to upgrade to: latest, newest, greatest, minor, patch, @[tag], or [function]. Run "ncu --help --target" for details. (default: "latest")',
+      'Determines the version to upgrade to: latest, newest, greatest, minor, patch, @[tag], or [function]. (default: latest).',
     help: extendedHelpTarget(),
     // eslint-disable-next-line no-template-curly-in-string
     type: `'latest' | 'newest' | 'greatest' | 'minor' | 'patch' | ${'`@${string}`'} | TargetFunction`,

src/scripts/build-options.ts

@@ -47,7 +47,7 @@ const renderOption = (option: CLIOption<unknown>) => {
       : ''
 
   // all options are optional
-  return `  /** ${description}${defaults} */
+  return `  /** ${description}${option.help ? ` Run "ncu --help --${option.long}" for details.` : ''}${defaults} */
   ${option.long}?: ${type}
 `
 }

src/types/RunOptions.ts

@@ -30,7 +30,7 @@ export interface RunOptions {
   /** Include deprecated packages. */
   deprecated?: boolean
 
-  /** Iteratively installs upgrades and runs tests to identify breaking upgrades. Run "ncu --doctor" for detailed help. Add "-u" to execute. */
+  /** Iteratively installs upgrades and runs tests to identify breaking upgrades. Requires "-u" to execute. Run "ncu --help --doctor" for details. */
   doctor?: boolean
 
   /** Specifies the install script to use in doctor mode. (default: npm install/yarn) */
@@ -96,7 +96,7 @@ export interface RunOptions {
   /** Current working directory of npm. */
   prefix?: string
 
-  /** Third-party npm registry. */
+  /** Third-party npm registry. Run "ncu --help --registry" for details. */
   registry?: string
 
   /** Exclude packages matching the given string, wildcard, glob, comma-or-space-delimited list, /regex/, or predicate function. */
@@ -117,7 +117,7 @@ export interface RunOptions {
   /** Read package.json from stdin. */
   stdin?: string
 
-  /** Determines the version to upgrade to: latest, newest, greatest, minor, patch, @[tag], or [function]. Run "ncu --help --target" for details. (default: "latest") */
+  /** Determines the version to upgrade to: latest, newest, greatest, minor, patch, @[tag], or [function]. (default: latest). Run "ncu --help --target" for details. */
   target?: 'latest' | 'newest' | 'greatest' | 'minor' | 'patch' | `@${string}` | TargetFunction
 
   /** Global timeout in milliseconds. (default: no global timeout and 30 seconds per npm-registry-fetch) */