Add cli:false for options that can only be provided in ncurc.

Author: raineorshine

README.md

@@ -174,7 +174,7 @@ ncu "/^(?!react-).*$/" # windows
 -f, --filter <p>           Include only package names matching the given
                            string, wildcard, glob, comma-or-space-delimited
                            list, /regex/, or predicate function.
---filterResults <fn>       Filters out upgrades based on a user provided
+filterResults*             Filters out upgrades based on a user provided
                            function. Run "ncu --help --filterResults" for
                            details.
 --filterVersion <p>        Filter on package version using
@@ -187,7 +187,7 @@ ncu "/^(?!react-).*$/" # windows
                            [])
 -g, --global               Check global packages instead of in the current
                            project.
---groupFunction <fn>       Customize how packages are divided into groups
+groupFunction*             Customize how packages are divided into groups
                            when using '--format group'. Run "ncu --help
                            --groupFunction" for details.
 -i, --interactive          Enable interactive prompts for each dependency;
@@ -254,8 +254,8 @@ ncu "/^(?!react-).*$/" # windows
                            [])
 -ws, --workspaces          Run on all workspaces. Add --root to also upgrade
                            the root project.
--V, --version              output the version number
--h, --help                 display help
+-V, --version              Output the version number.
+-h, --help                 You're lookin' at it.
 ```
 
 <!-- END Options -->
@@ -328,16 +328,12 @@ Example:
 
 ## filterResults
 
-Usage:
-
-    ncu --filterResults [fn]
-
-Filters out upgrades based on a user provided function. Only available in .ncurc.js or when importing npm-check-updates as a module.
+Filters out upgrades based on a user provided function.
 
-For the SemVer type, see: https://git.coolaj86.com/coolaj86/semver-utils.js#semverutils-parse-semverstring
+Only available in .ncurc.js or when importing npm-check-updates as a module.
 
 ```js
-/**
+/** Filter out non-major version updates.
   @param {string} packageName               The name of the dependency.
   @param {string} currentVersion            Current version declaration (may be range).
   @param {SemVer[]} currentVersionSemver    Current version declaration in semantic versioning format (may be range).
@@ -355,7 +351,7 @@ filterResults: (packageName, {currentVersion, currentVersionSemver, upgradedVers
 }
 ```
 
-The above example filters out non-major version updates.
+For the SemVer type definition, see: https://git.coolaj86.com/coolaj86/semver-utils.js#semverutils-parse-semverstring
 
 ## format
 
@@ -375,11 +371,9 @@ Modify the output formatting or show additional information. Specify one or more
 
 ## groupFunction
 
-Usage:
-
-    ncu --groupFunction [fn]
+Customize how packages are divided into groups when using `--format group`.
 
-Customize how packages are divided into groups when using `--format group`. Only available in .ncurc.js or when importing npm-check-updates as a module:
+Only available in .ncurc.js or when importing npm-check-updates as a module.
 
 ```js
 /**
@@ -504,7 +498,7 @@ Determines the version to upgrade to. (default: "latest")
 You can also specify a custom function in your .ncurc.js file, or when importing npm-check-updates as a module:
 
 ```js
-/** Custom target.
+/** Upgrade major version zero to the next minor version, and everything else to latest.
   @param dependencyName The name of the dependency.
   @param parsedVersion A parsed Semver object from semver-utils.
     (See https://git.coolaj86.com/coolaj86/semver-utils.js#semverutils-parse-semverstring)

src/bin/cli.ts

@@ -84,15 +84,25 @@ ${chalk.dim.underline(
     process.exit(0)
   }
 
+  // a set of options that only work in an rc config file, not on the command line
+  const noCli = new Set(cliOptions.filter(option => option.cli === false).map(option => `--${option.long}`))
+
   // start commander program
   program
     .description('[filter] is a list or regex of package names to check (all others will be ignored).')
     .usage('[options] [filter]')
     // See: boolean optional arg below
     .configureHelp({
-      optionTerm: option => option.flags.replace('[bool]', ''),
+      optionTerm: option =>
+        option.long && noCli.has(option.long)
+          ? option.long.replace('--', '') + '*'
+          : option.flags.replace('[bool]', ''),
       optionDescription: option =>
-        option.long === '--help' ? 'display help' : Help.prototype.optionDescription(option),
+        option.long === '--version'
+          ? 'Output the version number.'
+          : option.long === '--help'
+          ? `You're lookin' at it.`
+          : Help.prototype.optionDescription(option),
     })
 
   // add cli options

src/cli-options.ts

@@ -12,6 +12,8 @@ type ExtendedHelp = string | ((options: { markdown?: boolean }) => string)
 export interface CLIOption<T = any> {
   arg?: string
   choices?: T[]
+  /** If false, the option is only usable in the ncurc file, or when using npm-check-updates as a module, not on the command line. */
+  cli?: boolean
   default?: T
   deprecated?: boolean
   description: string
@@ -36,9 +38,12 @@ const codeBlock = (code: string, { markdown }: { markdown?: boolean } = {}) => {
 
 /** Renders the extended help for an option with usage information. */
 export const renderExtendedHelp = (option: CLIOption, { markdown }: { markdown?: boolean } = {}) => {
-  let output = `Usage:
+  let output = ''
+  if (option.cli !== false) {
+    output = `Usage:
 
     ncu --${option.long}${option.arg ? ` [${option.arg}]` : ''}\n`
+  }
   if (option.short) {
     output += `    ncu -${option.short}${option.arg ? ` [${option.arg}]` : ''}\n`
   }
@@ -119,12 +124,12 @@ Example:
 
 /** Extended help for the filterResults option. */
 const extendedHelpFilterResults: ExtendedHelp = ({ markdown }) => {
-  return `Filters out upgrades based on a user provided function. Only available in .ncurc.js or when importing npm-check-updates as a module.
+  return `Filters out upgrades based on a user provided function.
 
-For the SemVer type, see: https://git.coolaj86.com/coolaj86/semver-utils.js#semverutils-parse-semverstring
+Only available in .ncurc.js or when importing npm-check-updates as a module.
 
 ${codeBlock(
-  `${chalk.gray(`/**
+  `${chalk.gray(`/** Filter out non-major version updates.
   @param {string} packageName               The name of the dependency.
   @param {string} currentVersion            Current version declaration (may be range).
   @param {SemVer[]} currentVersionSemver    Current version declaration in semantic versioning format (may be range).
@@ -145,7 +150,7 @@ ${chalk.cyan(
   { markdown },
 )}
 
-The above example filters out non-major version updates.
+For the SemVer type definition, see: https://git.coolaj86.com/coolaj86/semver-utils.js#semverutils-parse-semverstring
 
 `
 }
@@ -172,7 +177,9 @@ const extendedHelpFormat: ExtendedHelp = ({ markdown }) => {
 
 /** Extended help for the --group option. */
 const extendedHelpGroupFunction: ExtendedHelp = ({ markdown }) => {
-  return `Customize how packages are divided into groups when using \`--format group\`. Only available in .ncurc.js or when importing npm-check-updates as a module:
+  return `Customize how packages are divided into groups when using \`--format group\`.
+
+Only available in .ncurc.js or when importing npm-check-updates as a module.
 
 ${codeBlock(
   `${chalk.gray(`/**
@@ -227,7 +234,7 @@ ${padLeft(tableString, markdown ? 0 : 4)}
 You can also specify a custom function in your .ncurc.js file, or when importing npm-check-updates as a module:
 
 ${codeBlock(
-  `${chalk.gray(`/** Custom target.
+  `${chalk.gray(`/** Upgrade major version zero to the next minor version, and everything else to latest.
   @param dependencyName The name of the dependency.
   @param parsedVersion A parsed Semver object from semver-utils.
     (See https://git.coolaj86.com/coolaj86/semver-utils.js#semverutils-parse-semverstring)
@@ -444,6 +451,7 @@ const cliOptions: CLIOption[] = [
   {
     long: 'filterResults',
     arg: 'fn',
+    cli: false,
     description: `Filters out upgrades based on a user provided function.`,
     type: 'FilterResultsFunction',
     help: extendedHelpFilterResults,
@@ -475,6 +483,7 @@ const cliOptions: CLIOption[] = [
   {
     long: 'groupFunction',
     arg: 'fn',
+    cli: false,
     description: `Customize how packages are divided into groups when using '--format group'.`,
     type: 'GroupFunction',
     help: extendedHelpGroupFunction,