chore(jest-reporters): replace chalk with picocolors

pralkarz · pralkarz · commit 1e02600709b0 · 2025-02-03T23:12:33.000+01:00
diff --git a/packages/jest-reporters/src/DefaultReporter.ts b/packages/jest-reporters/src/DefaultReporter.ts
@@ -6,7 +6,7 @@
  */
 
 import type {WriteStream} from 'tty';
-import chalk = require('chalk');
+import * as pc from 'picocolors';
 import {getConsoleOutput} from '@jest/console';
 import type {
   AggregatedResult,
@@ -30,7 +30,7 @@ import type {ReporterOnStartOptions} from './types';
 type write = WriteStream['write'];
 type FlushBufferedOutput = () => void;
 
-const TITLE_BULLET = chalk.bold('\u25CF ');
+const TITLE_BULLET = pc.bold('\u25CF ');
 
 export default class DefaultReporter extends BaseReporter {
   private _clear: string; // ANSI clear sequence for the last printed status
@@ -206,20 +206,20 @@ export default class DefaultReporter extends BaseReporter {
       const testRetryReasons = testResult.retryReasons;
       if (testRetryReasons && testRetryReasons.length > 0) {
         this.log(
-          `${chalk.reset.inverse.bold.yellow(' LOGGING RETRY ERRORS ')} ${chalk.bold(testResult.fullName)}`,
+          `${pc.reset(pc.inverse(pc.bold(pc.yellow(' LOGGING RETRY ERRORS '))))} ${pc.bold(testResult.fullName)}`,
         );
         for (const [index, retryReasons] of testRetryReasons.entries()) {
           let {message, stack} = separateMessageFromStack(retryReasons);
           stack = this._globalConfig.noStackTrace
             ? ''
-            : chalk.dim(
+            : pc.dim(
                 formatStackTrace(stack, config, this._globalConfig, testPath),
               );
 
           message = indentAllLines(message);
 
           this.log(
-            `${chalk.reset.inverse.bold.blueBright(` RETRY ${index + 1} `)}\n`,
+            `${pc.reset(pc.inverse(pc.bold(pc.blueBright(` RETRY ${index + 1} `))))}\n`,
           );
           this.log(`${message}\n${stack}\n`);
         }
diff --git a/packages/jest-reporters/src/GitHubActionsReporter.ts b/packages/jest-reporters/src/GitHubActionsReporter.ts
@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import chalk = require('chalk');
+import * as pc from 'picocolors';
 import stripAnsi = require('strip-ansi');
 import type {
   AggregatedResult,
@@ -314,23 +314,23 @@ export default class GitHubActionsReporter extends BaseReporter {
   private printResultTree(resultTree: ResultTree): void {
     let perfMs;
     if (resultTree.performanceInfo.slow) {
-      perfMs = ` (${chalk.red.inverse(
-        `${resultTree.performanceInfo.runtime} ms`,
+      perfMs = ` (${pc.red(
+        pc.inverse(`${resultTree.performanceInfo.runtime} ms`),
       )})`;
     } else {
       perfMs = ` (${resultTree.performanceInfo.runtime} ms)`;
     }
     if (resultTree.passed) {
       this.startGroup(
-        `${chalk.bold.green.inverse('PASS')} ${resultTree.name}${perfMs}`,
+        `${pc.bold(pc.green(pc.inverse('PASS')))} ${resultTree.name}${perfMs}`,
       );
       for (const child of resultTree.children) {
         this.recursivePrintResultTree(child, true, 1);
       }
       this.endGroup();
     } else {
       this.log(
-        `  ${chalk.bold.red.inverse('FAIL')} ${resultTree.name}${perfMs}`,
+        `  ${pc.bold(pc.red(pc.inverse('FAIL')))} ${resultTree.name}${perfMs}`,
       );
       for (const child of resultTree.children) {
         this.recursivePrintResultTree(child, false, 1);
@@ -355,17 +355,17 @@ export default class GitHubActionsReporter extends BaseReporter {
       let resultSymbol;
       switch (resultTree.status) {
         case 'passed':
-          resultSymbol = chalk.green(ICONS.success);
+          resultSymbol = pc.green(ICONS.success);
           break;
         case 'failed':
-          resultSymbol = chalk.red(ICONS.failed);
+          resultSymbol = pc.red(ICONS.failed);
           break;
         case 'todo':
-          resultSymbol = chalk.magenta(ICONS.todo);
+          resultSymbol = pc.magenta(ICONS.todo);
           break;
         case 'pending':
         case 'skipped':
-          resultSymbol = chalk.yellow(ICONS.pending);
+          resultSymbol = pc.yellow(ICONS.pending);
           break;
       }
       this.log(
diff --git a/packages/jest-reporters/src/Status.ts b/packages/jest-reporters/src/Status.ts
@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import chalk = require('chalk');
+import * as pc from 'picocolors';
 import stringLength = require('string-length');
 import type {
   AggregatedResult,
@@ -21,7 +21,7 @@ import type {ReporterOnStartOptions} from './types';
 import wrapAnsiString from './wrapAnsiString';
 
 const RUNNING_TEXT = ' RUNS ';
-const RUNNING = `${chalk.reset.inverse.yellow.bold(RUNNING_TEXT)} `;
+const RUNNING = `${pc.reset(pc.inverse(pc.yellow(pc.bold(RUNNING_TEXT))))} `;
 
 /**
  * This class is a perf optimization for sorting the list of currently
diff --git a/packages/jest-reporters/src/SummaryReporter.ts b/packages/jest-reporters/src/SummaryReporter.ts
@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import chalk = require('chalk');
+import * as pc from 'picocolors';
 import type {
   AggregatedResult,
   SnapshotSummary,
@@ -131,7 +131,7 @@ export default class SummaryReporter extends BaseReporter {
       if (!this._globalConfig.silent) {
         message += `\n${
           wasInterrupted
-            ? chalk.bold.red('Test run was interrupted.')
+            ? pc.bold(pc.red('Test run was interrupted.'))
             : this._getTestSummary(testContexts, this._globalConfig)
         }`;
       }
@@ -194,7 +194,7 @@ export default class SummaryReporter extends BaseReporter {
       failedTests + runtimeErrors > 0 &&
       aggregatedResults.numTotalTestSuites > this._summaryThreshold
     ) {
-      this.log(chalk.bold('Summary of all failing tests'));
+      this.log(pc.bold('Summary of all failing tests'));
       for (const testResult of aggregatedResults.testResults) {
         const {failureMessage} = testResult;
         if (failureMessage) {
@@ -218,15 +218,15 @@ export default class SummaryReporter extends BaseReporter {
         ? ' related to files matching '
         : ' matching ';
 
-      return chalk.dim(prefix) + testPathPatterns.toPretty();
+      return pc.dim(prefix) + testPathPatterns.toPretty();
     };
 
     let testInfo = '';
 
     if (globalConfig.runTestsByPath) {
-      testInfo = chalk.dim(' within paths');
+      testInfo = pc.dim(' within paths');
     } else if (globalConfig.onlyChanged) {
-      testInfo = chalk.dim(' related to changed files');
+      testInfo = pc.dim(' related to changed files');
     } else if (testPathPatterns.isSet()) {
       testInfo = getMatchingTestsInfo();
     }
@@ -236,22 +236,22 @@ export default class SummaryReporter extends BaseReporter {
     if (globalConfig.runTestsByPath) {
       nameInfo = ` ${globalConfig.nonFlagArgs.map(p => `"${p}"`).join(', ')}`;
     } else if (globalConfig.testNamePattern) {
-      nameInfo = `${chalk.dim(' with tests matching ')}"${
+      nameInfo = `${pc.dim(' with tests matching ')}"${
         globalConfig.testNamePattern
       }"`;
     }
 
     const contextInfo =
       testContexts.size > 1
-        ? chalk.dim(' in ') + testContexts.size + chalk.dim(' projects')
+        ? pc.dim(' in ') + testContexts.size + pc.dim(' projects')
         : '';
 
     return (
-      chalk.dim('Ran all test suites') +
+      pc.dim('Ran all test suites') +
       testInfo +
       nameInfo +
       contextInfo +
-      chalk.dim('.')
+      pc.dim('.')
     );
   }
 }
diff --git a/packages/jest-reporters/src/VerboseReporter.ts b/packages/jest-reporters/src/VerboseReporter.ts
@@ -6,7 +6,7 @@
  */
 
 import type {WriteStream} from 'tty';
-import chalk = require('chalk');
+import * as pc from 'picocolors';
 import type {
   AggregatedResult,
   AssertionResult,
@@ -115,13 +115,13 @@ export default class VerboseReporter extends DefaultReporter {
 
   private _getIcon(status: string) {
     if (status === 'failed') {
-      return chalk.red(ICONS.failed);
+      return pc.red(ICONS.failed);
     } else if (status === 'pending') {
-      return chalk.yellow(ICONS.pending);
+      return pc.yellow(ICONS.pending);
     } else if (status === 'todo') {
-      return chalk.magenta(ICONS.todo);
+      return pc.magenta(ICONS.todo);
     } else {
-      return chalk.green(ICONS.success);
+      return pc.green(ICONS.success);
     }
   }
 
@@ -130,7 +130,7 @@ export default class VerboseReporter extends DefaultReporter {
     const time = test.duration
       ? ` (${formatTime(Math.round(test.duration))})`
       : '';
-    this._logLine(`${status} ${chalk.dim(test.title + time)}`, indentLevel);
+    this._logLine(`${status} ${pc.dim(test.title + time)}`, indentLevel);
   }
 
   private _logTests(tests: Array<AssertionResult>, indentLevel: number) {
@@ -171,7 +171,7 @@ export default class VerboseReporter extends DefaultReporter {
       const printedTestStatus =
         test.status === 'pending' ? 'skipped' : test.status;
       const icon = this._getIcon(test.status);
-      const text = chalk.dim(`${printedTestStatus} ${test.title}`);
+      const text = pc.dim(`${printedTestStatus} ${test.title}`);
       this._logLine(`${icon} ${text}`, indentLevel);
     };
   }
diff --git a/packages/jest-reporters/src/formatTestPath.ts b/packages/jest-reporters/src/formatTestPath.ts
@@ -6,7 +6,7 @@
  */
 
 import * as path from 'path';
-import chalk = require('chalk');
+import * as pc from 'picocolors';
 import slash = require('slash');
 import type {Config} from '@jest/types';
 import relativePath from './relativePath';
@@ -16,5 +16,5 @@ export default function formatTestPath(
   testPath: string,
 ): string {
   const {dirname, basename} = relativePath(config, testPath);
-  return slash(chalk.dim(dirname + path.sep) + chalk.bold(basename));
+  return slash(pc.dim(dirname + path.sep) + pc.bold(basename));
 }
diff --git a/packages/jest-reporters/src/getResultHeader.ts b/packages/jest-reporters/src/getResultHeader.ts
@@ -5,25 +5,25 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import chalk = require('chalk');
+import * as pc from 'picocolors';
 import type {TestResult} from '@jest/test-result';
 import type {Config} from '@jest/types';
 import {formatTime} from 'jest-util';
 import formatTestPath from './formatTestPath';
 import printDisplayName from './printDisplayName';
 
-const LONG_TEST_COLOR = chalk.reset.bold.bgRed;
+const LONG_TEST_COLOR = (str: string) => pc.reset(pc.bold(pc.bgRed(str)));
 // Explicitly reset for these messages since they can get written out in the
 // middle of error logging
 const FAIL_TEXT = 'FAIL';
 const PASS_TEXT = 'PASS';
 
-const FAIL = chalk.supportsColor
-  ? chalk.reset.inverse.bold.red(` ${FAIL_TEXT} `)
+const FAIL = pc.isColorSupported
+  ? pc.reset(pc.inverse(pc.bold(pc.red(` ${FAIL_TEXT} `))))
   : FAIL_TEXT;
 
-const PASS = chalk.supportsColor
-  ? chalk.reset.inverse.bold.green(` ${PASS_TEXT} `)
+const PASS = pc.isColorSupported
+  ? pc.reset(pc.inverse(pc.bold(pc.green(` ${PASS_TEXT} `))))
   : PASS_TEXT;
 
 export default function getResultHeader(
diff --git a/packages/jest-reporters/src/getSnapshotStatus.ts b/packages/jest-reporters/src/getSnapshotStatus.ts
@@ -5,16 +5,16 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import chalk = require('chalk');
+import * as pc from 'picocolors';
 import type {TestResult} from '@jest/test-result';
 import {pluralize} from 'jest-util';
 
 const ARROW = ' \u203A ';
 const DOT = ' \u2022 ';
-const FAIL_COLOR = chalk.bold.red;
-const SNAPSHOT_ADDED = chalk.bold.green;
-const SNAPSHOT_UPDATED = chalk.bold.green;
-const SNAPSHOT_OUTDATED = chalk.bold.yellow;
+const FAIL_COLOR = (str: string) => pc.bold(pc.red(str));
+const SNAPSHOT_ADDED = (str: string) => pc.bold(pc.green(str));
+const SNAPSHOT_UPDATED = (str: string) => pc.bold(pc.green(str));
+const SNAPSHOT_OUTDATED = (str: string) => pc.bold(pc.yellow(str));
 
 export default function getSnapshotStatus(
   snapshot: TestResult['snapshot'],
diff --git a/packages/jest-reporters/src/getSnapshotSummary.ts b/packages/jest-reporters/src/getSnapshotSummary.ts
@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import chalk = require('chalk');
+import * as pc from 'picocolors';
 import type {SnapshotSummary} from '@jest/test-result';
 import type {Config} from '@jest/types';
 import {pluralize} from 'jest-util';
@@ -14,13 +14,13 @@ import formatTestPath from './formatTestPath';
 const ARROW = ' \u203A ';
 const DOWN_ARROW = ' \u21B3 ';
 const DOT = ' \u2022 ';
-const FAIL_COLOR = chalk.bold.red;
-const OBSOLETE_COLOR = chalk.bold.yellow;
-const SNAPSHOT_ADDED = chalk.bold.green;
-const SNAPSHOT_NOTE = chalk.dim;
-const SNAPSHOT_REMOVED = chalk.bold.green;
-const SNAPSHOT_SUMMARY = chalk.bold;
-const SNAPSHOT_UPDATED = chalk.bold.green;
+const FAIL_COLOR = (str: string) => pc.bold(pc.red(str));
+const OBSOLETE_COLOR = (str: string) => pc.bold(pc.yellow(str));
+const SNAPSHOT_ADDED = (str: string) => pc.bold(pc.green(str));
+const SNAPSHOT_NOTE = pc.dim;
+const SNAPSHOT_REMOVED = (str: string) => pc.bold(pc.green(str));
+const SNAPSHOT_SUMMARY = pc.bold;
+const SNAPSHOT_UPDATED = (str: string) => pc.bold(pc.green(str));
 
 export default function getSnapshotSummary(
   snapshots: SnapshotSummary,
diff --git a/packages/jest-reporters/src/getSummary.ts b/packages/jest-reporters/src/getSummary.ts
diff --git a/packages/jest-reporters/src/printDisplayName.ts b/packages/jest-reporters/src/printDisplayName.ts
diff --git a/packages/jest-reporters/src/trimAndFormatPath.ts b/packages/jest-reporters/src/trimAndFormatPath.ts
