feat(utils): truncate group/spinner inline errors to one-liner

Author: matejchalk

packages/models/src/lib/core-config.ts

@@ -20,7 +20,9 @@ export const unrefinedCoreConfigSchema = z.object({
   categories: categoriesSchema.optional(),
 });
 
-export const coreConfigSchema = refineCoreConfig(unrefinedCoreConfigSchema);
+export const coreConfigSchema = refineCoreConfig(
+  unrefinedCoreConfigSchema,
+).meta({ title: 'CoreConfig' });
 
 /**
  * Add refinements to coreConfigSchema

packages/utils/mocks/logger-demo.ts

@@ -1,4 +1,5 @@
 import ansis from 'ansis';
+import { coreConfigSchema, validate } from '../../models/src/index.js';
 import { logger } from '../src/index.js';
 
 async function sleep(delay: number) {
@@ -20,6 +21,10 @@ try {
   await logger.task('Importing code-pushup.config.ts', async () => {
     await sleep(500);
 
+    if (errorStage === 'config') {
+      validate(coreConfigSchema, {}, { filePath: 'code-pushup.config.ts' });
+    }
+
     return 'Loaded configuration from code-pushup.config.ts';
   });
   logger.debug('2 plugins:');
@@ -76,7 +81,7 @@ try {
       'Sent GraphQL mutation to https://api.code-pushup.example.com/graphql (organization: "example", project: "website")',
     );
     await sleep(2000);
-    if (errorStage === 'core') {
+    if (errorStage === 'upload') {
       throw new Error('GraphQL error');
     }
     return ansis.bold('Uploaded report to portal');

packages/utils/project.json

@@ -35,11 +35,14 @@
         "verbose": {
           "args": ["--verbose"]
         },
-        "error-core": {
-          "args": ["--error=core"]
+        "error-config": {
+          "args": ["--error=config"]
         },
         "error-plugin": {
           "args": ["--error=plugin"]
+        },
+        "error-upload": {
+          "args": ["--error=upload"]
         }
       }
     }

packages/utils/src/lib/logger.int.test.ts

@@ -166,7 +166,7 @@ ${ansis.red('Failed to load config')}
         `
 ${ansis.bold.cyan('❯ Running plugin "ESLint"')}
 ${ansis.cyan('│')} $ npx eslint . --format=json --output-file=.code-pushup/eslint/results.json
-${ansis.cyan('└')} ${ansis.red("Error: ENOENT: no such file or directory, open '.code-pushup/eslint/results.json'")}
+${ansis.cyan('└')} ${ansis.red("ENOENT: no such file or directory, open '.code-pushup/eslint/results.json'")}
 
 `,
       );
@@ -333,7 +333,7 @@ ${ansis.magenta('└')} ${ansis.green(`Total line coverage is ${ansis.bold('82%'
       await expect(task).rejects.toThrow('GraphQL error: Invalid API key');
 
       expect(output).toBe(
-        `${ansis.red('✖')} Uploading report to portal → ${ansis.red('Error: GraphQL error: Invalid API key')}\n`,
+        `${ansis.red('✖')} Uploading report to portal → ${ansis.red('GraphQL error: Invalid API key')}\n`,
       );
     });
 
@@ -428,7 +428,7 @@ ${ansis.green('✔')} Uploaded report to portal ${ansis.gray('(42 ms)')}
 
       expect(output).toBe(
         `
-${ansis.red('✖')} Uploading report to portal → ${ansis.red('Error: GraphQL error: Invalid API key')}
+${ansis.red('✖')} Uploading report to portal → ${ansis.red('GraphQL error: Invalid API key')}
   ${ansis.gray('Sent request to Portal API')}
   ${ansis.gray('Received response from Portal API')}
 `.trimStart(),
@@ -689,7 +689,7 @@ ${ansis.cyan('-')} ${ansis.blue('$')} npx eslint . --format=json`,
         `
 ${ansis.bold.cyan('❯ Running plugin "ESLint"')}
 ${ansis.cyan('│')} ${ansis.red('$')} npx eslint . --format=json
-${ansis.cyan('└')} ${ansis.red('Error: Process failed with exit code 1')}
+${ansis.cyan('└')} ${ansis.red('Process failed with exit code 1')}
 
 `,
       );
@@ -786,7 +786,7 @@ ${ansis.red.bold('Cancelled by SIGINT')}
 │   ESLint couldn't find a configuration file.
 │   
 │ $ npx eslint . --format=json
-└ Error: Process failed with exit code 2
+└ Process failed with exit code 2
 
 `,
       );

packages/utils/src/lib/logger.ts

@@ -3,6 +3,7 @@ import os from 'node:os';
 import ora, { type Ora } from 'ora';
 import { dateToUnixTimestamp } from './dates.js';
 import { isEnvVarEnabled } from './env.js';
+import { stringifyError } from './errors.js';
 import { formatDuration, indentLines, transformLines } from './formatting.js';
 import { settlePromise } from './promises.js';
 
@@ -19,12 +20,11 @@ const GROUP_COLOR_ENV_VAR_NAME = 'CP_LOGGER_GROUP_COLOR';
 export class Logger {
   #isVerbose = isEnvVarEnabled('CP_VERBOSE');
   #isCI = isEnvVarEnabled('CI');
-  #ciPlatform: CiPlatform | undefined =
-    process.env['GITHUB_ACTIONS'] === 'true'
-      ? 'GitHub Actions'
-      : process.env['GITLAB_CI'] === 'true'
-        ? 'GitLab CI/CD'
-        : undefined;
+  #ciPlatform: CiPlatform | undefined = isEnvVarEnabled('GITHUB_ACTIONS')
+    ? 'GitHub Actions'
+    : isEnvVarEnabled('GITLAB_CI')
+      ? 'GitLab CI/CD'
+      : undefined;
   #groupColor: GroupColor | undefined =
     process.env[GROUP_COLOR_ENV_VAR_NAME] === 'cyan' ||
     process.env[GROUP_COLOR_ENV_VAR_NAME] === 'magenta'
@@ -275,7 +275,10 @@ export class Logger {
       console.log(
         [
           this.#colorize(this.#groupSymbols.end, this.#groupColor),
-          this.#colorize(`${result.reason}`, 'red'),
+          this.#colorize(
+            `${stringifyError(result.reason, { oneline: true })}`,
+            'red',
+          ),
         ].join(' '),
       );
     }
@@ -391,7 +394,7 @@ export class Logger {
             messages.success(result.value),
             this.#formatDurationSuffix({ start, end }),
           ].join(' ')
-        : messages.failure(result.reason);
+        : messages.failure(stringifyError(result.reason, { oneline: true }));
 
     if (this.#activeSpinner) {
       if (this.#groupColor) {