cli/e2e/cli-e2e/tests/__snapshots__/help.e2e.test.ts.snap at 612dcb8110ed5c8d004a2b10b2d10aaff2e5ec85 · code-pushup/cli · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html

exports[`CLI help > should print help with help command 1`] = `
"Code PushUp CLI

Commands:
  code-pushup               Shortcut for running collect followed by upload
                                                                       [default]
  code-pushup autorun       Shortcut for running collect followed by upload

  code-pushup collect       Run Plugins and collect results
  code-pushup upload        Upload report results to the portal
  code-pushup history       Collect reports for commit history
  code-pushup compare       Compare 2 report files and create a diff file

  code-pushup print-config  Print config
  code-pushup merge-diffs   Combine many report diffs into a single diff file


Global Options:
      --progress        Show progress bar in stdout.
          [boolean] [default: false in CI environment, otherwise true]
      --verbose         When true creates more verbose output. This is helpful w
                        hen debugging. You may also set CP_VERBOSE env variable
                        instead.       [boolean] [default: false]
      --config          Path to config file. By default it loads code-pushup.con
                        fig.(ts|mjs|js).                 [string]
      --tsconfig        Path to a TypeScript config, to be used when loading con
                        fig file.                        [string]
      --skipCategories  List of categories to skip. If not set all categories ar
                        e run.              [array] [default: []]
      --onlyCategories  List of categories to run. If not set all categories are
                         run.               [array] [default: []]
  -P, --skipPlugins     List of plugins to skip. If not set all plugins are run.
                                                 [array] [default: []]
  -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]
      --persist.filename     Filename for the produced reports.
                                                              [string]
      --persist.format       Format of the report output. e.g. \`md\`, \`json\`
                                                               [array]
      --persist.skipReports  Skip generating report files. (useful in combinatio
                             n with caching)            [boolean]

Upload Options:
      --upload.organization  Organization slug from portal
                                                              [string]
      --upload.project       Project slug from portal[string]
      --upload.server        URL to your portal server
                                                              [string]
      --upload.apiKey        API key for the portal server
                                                              [string]

Options:
      --version  Show version                       [boolean]
  -h, --help     Show help                          [boolean]

Examples:
  code-pushup                               Run collect followed by upload based
                                             on configuration from code-pushup.c
                                            onfig.* file.
  code-pushup collect --tsconfig=tsconfig.  Run collect using custom tsconfig to
  base.json                                  parse code-pushup.config.ts file.
  code-pushup collect --onlyPlugins=covera  Run collect with only coverage plugi
  ge                                        n, other plugins from config file wi
                                            ll be skipped.
  code-pushup collect --skipPlugins=covera  Run collect skipping the coverage pl
  ge                                        ugin, other plugins from config file
                                             will be included.
  code-pushup upload --persist.outputDir=d  Upload dist/report.json to portal us
  ist --upload.apiKey=$CP_API_KEY           ing API key from environment variabl
                                            e
  code-pushup print-config --config code-p  Print resolved config object parsed
  ushup.config.test.js                      from custom config location
"
`;