feat(cli): disable progress bar in CI environment

Author: matejchalk

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

@@ -19,7 +19,7 @@ Commands:
 
 Global Options:
       --progress        Show progress bar in stdout.
-                                             [boolean] [default: true]
+          [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]

packages/cli/README.md

@@ -197,7 +197,7 @@ Each example is fully tested to demonstrate best practices for plugin testing as
 
 | Option           | Type      | Default                                      | Description                                                                                                                |
 | ---------------- | --------- | -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
-| **`--progress`** | `boolean` | `true`                                       | Show progress bar in stdout.                                                                                               |
+| **`--progress`** | `boolean` | `false` in CI, otherwise `true`              | Show progress bar in stdout.                                                                                               |
 | **`--verbose`**  | `boolean` | `false`                                      | When true creates more verbose output. This is helpful when debugging. You may also set `CP_VERBOSE` env variable instead. |
 | **`--config`**   | `string`  | looks for `code-pushup.config.{ts\|mjs\|js}` | Path to config file.                                                                                                       |
 | **`--tsconfig`** | `string`  | n/a                                          | Path to a TypeScript config, used to load config file.                                                                     |

packages/cli/src/lib/implementation/global.options.ts

@@ -1,4 +1,5 @@
 import type { Options } from 'yargs';
+import { isCI } from '@code-pushup/utils';
 import type { GeneralCliOptions } from './global.model.js';
 
 export function yargsGlobalOptionsDefinition(): Record<
@@ -9,7 +10,8 @@ export function yargsGlobalOptionsDefinition(): Record<
     progress: {
       describe: 'Show progress bar in stdout.',
       type: 'boolean',
-      default: true,
+      default: !isCI(),
+      defaultDescription: 'false in CI environment, otherwise true',
     },
     verbose: {
       describe:

packages/cli/src/lib/yargs-cli.int.test.ts

@@ -1,5 +1,6 @@
 import { describe, expect, it } from 'vitest';
 import type { CoreConfig, Format } from '@code-pushup/models';
+import { isCI } from '@code-pushup/utils';
 import { yargsHistoryOptionsDefinition } from './history/history.options.js';
 import type { CompareOptions } from './implementation/compare.model.js';
 import { yargsCompareOptionsDefinition } from './implementation/compare.options.js';
@@ -21,7 +22,7 @@ describe('yargsCli', () => {
       options,
     }).parseAsync();
     expect(parsedArgv.verbose).toBe(false);
-    expect(parsedArgv.progress).toBe(true);
+    expect(parsedArgv.progress).toBe(!isCI());
   });
 
   it('should parse an empty array as a default onlyPlugins option', async () => {
@@ -112,7 +113,6 @@ describe('yargsCli', () => {
         FilterOptions
     >(
       [
-        '--verbose',
         '--persist.format=md',
         '--persist.outputDir=code-pushdown/output/dir',
         '--persist.filename=code-pushdown-report',
@@ -130,9 +130,8 @@ describe('yargsCli', () => {
     expect(parsedArgv).toEqual(
       expect.objectContaining({
         // default values
-        progress: true,
+        verbose: false,
         // overridden arguments
-        verbose: true,
         persist: expect.objectContaining({
           outputDir: 'code-pushdown/output/dir',
           filename: 'code-pushdown-report',