fix: update help output with caching options

Author: BioPhoton

e2e/cli-e2e/tests/__snapshots__/help.e2e.test.ts.snap

@@ -36,6 +36,14 @@ Global Options:
   -p, --onlyPlugins     List of plugins to run. If not set all plugins are run.
                                                  [array] [default: []]
 
+Cache Options:
+      --cache        Cache runner outputs (both read and write)
+                                                             [boolean]
+      --cache.read   Read runner-output.json from file system
+                                                             [boolean]
+      --cache.write  Write runner-output.json to file system
+                                                             [boolean]
+
 Persist Options:
       --persist.outputDir    Directory for the produced reports
                                                               [string]
@@ -56,14 +64,8 @@ Upload Options:
                                                               [string]
 
 Options:
-      --version      Show version                   [boolean]
-      --cache        Cache runner outputs (both read and write)
-                                                             [boolean]
-      --cache.read   Read runner-output.json to file system
-                                                             [boolean]
-      --cache.write  Write runner-output.json to file system
-                                                             [boolean]
-  -h, --help         Show help                      [boolean]
+      --version  Show version                       [boolean]
+  -h, --help     Show help                          [boolean]
 
 Examples:
   code-pushup                               Run collect followed by upload based

packages/cli/src/lib/options.ts

@@ -1,4 +1,5 @@
 import {
+  yargsCacheConfigOptionsDefinition,
   yargsCoreConfigOptionsDefinition,
   yargsPersistConfigOptionsDefinition,
   yargsUploadConfigOptionsDefinition,
@@ -17,6 +18,7 @@ export const groups = {
     ...Object.keys(yargsGlobalOptionsDefinition()),
     ...Object.keys(yargsFilterOptionsDefinition()),
   ],
+  'Cache Options:': Object.keys(yargsCacheConfigOptionsDefinition()),
   'Persist Options:': Object.keys(yargsPersistConfigOptionsDefinition()),
   'Upload Options:': Object.keys(yargsUploadConfigOptionsDefinition()),
 };

packages/models/docs/models-reference.md

@@ -1258,11 +1258,12 @@ _Enum, one of the following possible values:_
 
 _Object containing the following properties:_
 
-| Property    | Description                             | Type                               |
-| :---------- | :-------------------------------------- | :--------------------------------- |
-| `outputDir` | Artifacts folder                        | [FilePath](#filepath)              |
-| `filename`  | Artifacts file name (without extension) | [FileName](#filename)              |
-| `format`    |                                         | _Array of [Format](#format) items_ |
+| Property      | Description                             | Type                               |
+| :------------ | :-------------------------------------- | :--------------------------------- |
+| `outputDir`   | Artifacts folder                        | [FilePath](#filepath)              |
+| `filename`    | Artifacts file name (without extension) | [FileName](#filename)              |
+| `format`      |                                         | _Array of [Format](#format) items_ |
+| `skipReports` |                                         | `boolean`                          |
 
 _All properties are optional._