Clarify --cache* and --format repo options.

Author: raineorshine

README.md

@@ -134,13 +134,14 @@ ncu "/^(?!react-).*$/" # windows
 <!-- Do not edit this section by hand. It is auto-generated in build-options.ts. Run "npm run build" or "npm run build:options" to build. -->
 
 ```text
---cache                    Cache versions to the cache file
+--cache                    Cache versions to the cache file.
 --cacheClear               Clear the default cache, or the cache file
-                           specified by --cacheFile
---cacheExpiration <min>    Cache expiration in minutes (default: 10)
---cacheFile <path>         Filepath for the cache file (default:
-                           "~/.ncu-cache.json")
---color                    Force color in terminal
+                           specified by --cacheFile.
+--cacheExpiration <min>    Cache expiration in minutes. Only works with
+                           --cache. (default: 10)
+--cacheFile <path>         Filepath for the cache file. Only works with
+                           --cache. (default: "~/.ncu-cache.json")
+--color                    Force color in terminal.
 --concurrency <n>          Max number of concurrent HTTP requests to
                            registry. (default: 8)
 --configFileName <s>       Config file name. (default: .ncurc.{json,yml,js})
@@ -324,15 +325,16 @@ Usage:
 
 Modify the output formatting or show additional information. Specify one or more comma-delimited values.
 
-    ┌──────────────┬─────────────────────────────────────────────────────────────────────────┐
-    │        group │ Groups packages by major, minor, patch, and major version zero updates. │
-    ├──────────────┼─────────────────────────────────────────────────────────────────────────┤
-    │ ownerChanged │ Shows if the package owner has changed.                                 │
-    ├──────────────┼─────────────────────────────────────────────────────────────────────────┤
-    │         repo │ Infers and displays links to the package's source code repository.      │
-    ├──────────────┼─────────────────────────────────────────────────────────────────────────┤
-    │         time │ Shows the publish time of each upgrade.                                 │
-    └──────────────┴─────────────────────────────────────────────────────────────────────────┘
+    ┌──────────────┬────────────────────────────────────────────────────────────────────────────────────────────┐
+    │        group │ Groups packages by major, minor, patch, and major version zero updates.                    │
+    ├──────────────┼────────────────────────────────────────────────────────────────────────────────────────────┤
+    │ ownerChanged │ Shows if the package owner has changed.                                                    │
+    ├──────────────┼────────────────────────────────────────────────────────────────────────────────────────────┤
+    │         repo │ Infers and displays links to the package's source code repository. Requires packages to be │
+    │              │ installed.                                                                                 │
+    ├──────────────┼────────────────────────────────────────────────────────────────────────────────────────────┤
+    │         time │ Shows the publish time of each upgrade.                                                    │
+    └──────────────┴────────────────────────────────────────────────────────────────────────────────────────────┘
 
 ## groupFunction
 

src/cli-options.ts

@@ -155,7 +155,7 @@ const extendedHelpFormat = (): string => {
     rows: wrapRows([
       ['group', `Groups packages by major, minor, patch, and major version zero updates.`],
       ['ownerChanged', `Shows if the package owner has changed.`],
-      ['repo', `Infers and displays links to the package's source code repository.`],
+      ['repo', `Infers and displays links to the package's source code repository. Requires packages to be installed.`],
       ['time', 'Shows the publish time of each upgrade.'],
     ]),
     // coerce type until rows is added @types/cli-table
@@ -311,33 +311,33 @@ As a comparison: without using the --peer option, ncu will suggest the latest ve
 const cliOptions: CLIOption[] = [
   {
     long: 'cache',
-    description: 'Cache versions to the cache file',
+    description: 'Cache versions to the cache file.',
     type: 'boolean',
   },
   {
     long: 'cacheClear',
-    description: 'Clear the default cache, or the cache file specified by --cacheFile',
+    description: 'Clear the default cache, or the cache file specified by --cacheFile.',
     type: 'boolean',
   },
   {
     long: 'cacheExpiration',
     arg: 'min',
-    description: 'Cache expiration in minutes',
+    description: 'Cache expiration in minutes. Only works with --cache.',
     parse: s => parseInt(s, 10),
     default: 10,
     type: 'number',
   },
   {
     long: 'cacheFile',
     arg: 'path',
-    description: 'Filepath for the cache file',
+    description: 'Filepath for the cache file. Only works with --cache.',
     parse: s => (path.isAbsolute(s) ? s : path.join(process.cwd(), s)),
     default: defaultCacheFile,
     type: 'string',
   },
   {
     long: 'color',
-    description: 'Force color in terminal',
+    description: 'Force color in terminal.',
     type: 'boolean',
   },
   {

src/types/RunOptions.ts

@@ -6,19 +6,19 @@ import { TargetFunction } from './TargetFunction'
 
 /** Options that can be given on the CLI or passed to the ncu module to control all behavior. */
 export interface RunOptions {
-  /** Cache versions to the cache file */
+  /** Cache versions to the cache file. */
   cache?: boolean
 
-  /** Clear the default cache, or the cache file specified by --cacheFile */
+  /** Clear the default cache, or the cache file specified by --cacheFile. */
   cacheClear?: boolean
 
-  /** Cache expiration in minutes (default: 10) */
+  /** Cache expiration in minutes. Only works with --cache. (default: 10) */
   cacheExpiration?: number
 
-  /** Filepath for the cache file (default: "~/.ncu-cache.json") */
+  /** Filepath for the cache file. Only works with --cache. (default: "~/.ncu-cache.json") */
   cacheFile?: string
 
-  /** Force color in terminal */
+  /** Force color in terminal. */
   color?: boolean
 
   /** Max number of concurrent HTTP requests to registry. (default: 8) */