chore: transition from using colors to chalk (#18363)

The stability and long-term prospects of colors is unclear; remove our
dependency and start using chalk instead.


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

Author: njlynch

package.json

@@ -123,8 +123,8 @@
       "aws-cdk-lib/@balena/dockerignore/**",
       "aws-cdk-lib/case",
       "aws-cdk-lib/case/**",
-      "aws-cdk-lib/colors",
-      "aws-cdk-lib/colors/**",
+      "aws-cdk-lib/chalk",
+      "aws-cdk-lib/chalk/**",
       "aws-cdk-lib/diff",
       "aws-cdk-lib/diff/**",
       "aws-cdk-lib/fast-deep-equal",
@@ -151,8 +151,8 @@
       "monocdk/@balena/dockerignore/**",
       "monocdk/case",
       "monocdk/case/**",
-      "monocdk/colors",
-      "monocdk/colors/**",
+      "monocdk/chalk",
+      "monocdk/chalk/**",
       "monocdk/diff",
       "monocdk/diff/**",
       "monocdk/fast-deep-equal",
@@ -180,4 +180,4 @@
   "dependencies": {
     "string-width": "^4.2.3"
   }
-}
+}

packages/@aws-cdk/aws-cloudtrail/package.json

@@ -86,7 +86,6 @@
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^27.4.0",
     "aws-sdk": "^2.848.0",
-    "colors": "1.4.0",
     "jest": "^27.4.7"
   },
   "dependencies": {

packages/@aws-cdk/cloudformation-diff/lib/format-table.ts

@@ -1,4 +1,4 @@
-import * as colors from 'colors/safe';
+import * as chalk from 'chalk';
 import * as stringWidth from 'string-width';
 import * as table from 'table';
 
@@ -93,7 +93,7 @@ function sum(xs: number[]): number {
 }
 
 // What color the table is going to be
-const tableColor = colors.gray;
+const tableColor = chalk.gray;
 
 // Unicode table characters with a color
 const TABLE_BORDER_CHARACTERS = {

packages/@aws-cdk/cloudformation-diff/lib/format.ts

@@ -1,5 +1,5 @@
 import { format } from 'util';
-import * as colors from 'colors/safe';
+import * as chalk from 'chalk';
 import { Difference, isPropertyDifference, ResourceDifference, ResourceImpact } from './diff-template';
 import { DifferenceCollection, TemplateDiff } from './diff/types';
 import { deepEqual } from './diff/util';
@@ -75,10 +75,10 @@ function formatSecurityChangesWithBanner(formatter: Formatter, templateDiff: Tem
   formatter.printSectionFooter();
 }
 
-const ADDITION = colors.green('[+]');
-const CONTEXT = colors.grey('[ ]');
-const UPDATE = colors.yellow('[~]');
-const REMOVAL = colors.red('[-]');
+const ADDITION = chalk.green('[+]');
+const CONTEXT = chalk.grey('[ ]');
+const UPDATE = chalk.yellow('[~]');
+const REMOVAL = chalk.red('[-]');
 
 class Formatter {
   constructor(
@@ -93,11 +93,11 @@ class Formatter {
   }
 
   public print(fmt: string, ...args: any[]) {
-    this.stream.write(colors.white(format(fmt, ...args)) + '\n');
+    this.stream.write(chalk.white(format(fmt, ...args)) + '\n');
   }
 
   public warning(fmt: string, ...args: any[]) {
-    this.stream.write(colors.yellow(format(fmt, ...args)) + '\n');
+    this.stream.write(chalk.yellow(format(fmt, ...args)) + '\n');
   }
 
   public formatSection<V, T extends Difference<V>>(
@@ -116,7 +116,7 @@ class Formatter {
   }
 
   public printSectionHeader(title: string) {
-    this.print(colors.underline(colors.bold(title)));
+    this.print(chalk.underline(chalk.bold(title)));
   }
 
   public printSectionFooter() {
@@ -134,8 +134,8 @@ class Formatter {
 
     let value;
 
-    const oldValue = this.formatValue(diff.oldValue, colors.red);
-    const newValue = this.formatValue(diff.newValue, colors.green);
+    const oldValue = this.formatValue(diff.oldValue, chalk.red);
+    const newValue = this.formatValue(diff.newValue, chalk.green);
     if (diff.isAddition) {
       value = newValue;
     } else if (diff.isUpdate) {
@@ -144,7 +144,7 @@ class Formatter {
       value = oldValue;
     }
 
-    this.print(`${this.formatPrefix(diff)} ${colors.cyan(type)} ${this.formatLogicalId(logicalId)}: ${value}`);
+    this.print(`${this.formatPrefix(diff)} ${chalk.cyan(type)} ${this.formatLogicalId(logicalId)}: ${value}`);
   }
 
   /**
@@ -159,7 +159,7 @@ class Formatter {
     const resourceType = diff.isRemoval ? diff.oldResourceType : diff.newResourceType;
 
     // eslint-disable-next-line max-len
-    this.print(`${this.formatPrefix(diff)} ${this.formatValue(resourceType, colors.cyan)} ${this.formatLogicalId(logicalId)} ${this.formatImpact(diff.changeImpact)}`);
+    this.print(`${this.formatPrefix(diff)} ${this.formatValue(resourceType, chalk.cyan)} ${this.formatLogicalId(logicalId)} ${this.formatImpact(diff.changeImpact)}`);
 
     if (diff.isUpdate) {
       const differenceCount = diff.differenceCount;
@@ -175,7 +175,7 @@ class Formatter {
     if (diff.isAddition) { return ADDITION; }
     if (diff.isUpdate) { return UPDATE; }
     if (diff.isRemoval) { return REMOVAL; }
-    return colors.white('[?]');
+    return chalk.white('[?]');
   }
 
   /**
@@ -197,13 +197,13 @@ class Formatter {
   public formatImpact(impact: ResourceImpact) {
     switch (impact) {
       case ResourceImpact.MAY_REPLACE:
-        return colors.italic(colors.yellow('may be replaced'));
+        return chalk.italic(chalk.yellow('may be replaced'));
       case ResourceImpact.WILL_REPLACE:
-        return colors.italic(colors.bold(colors.red('replace')));
+        return chalk.italic(chalk.bold(chalk.red('replace')));
       case ResourceImpact.WILL_DESTROY:
-        return colors.italic(colors.bold(colors.red('destroy')));
+        return chalk.italic(chalk.bold(chalk.red('destroy')));
       case ResourceImpact.WILL_ORPHAN:
-        return colors.italic(colors.yellow('orphan'));
+        return chalk.italic(chalk.yellow('orphan'));
       case ResourceImpact.WILL_UPDATE:
       case ResourceImpact.WILL_CREATE:
       case ResourceImpact.NO_CHANGE:
@@ -249,13 +249,13 @@ class Formatter {
             this.print('%s   %s %s', linePrefix, i === 0 ? '└─' : '  ', diff[i]);
           }
         } else {
-          this.print('%s   ├─ %s %s', linePrefix, REMOVAL, this.formatValue(oldObject, colors.red));
-          this.print('%s   └─ %s %s', linePrefix, ADDITION, this.formatValue(newObject, colors.green));
+          this.print('%s   ├─ %s %s', linePrefix, REMOVAL, this.formatValue(oldObject, chalk.red));
+          this.print('%s   └─ %s %s', linePrefix, ADDITION, this.formatValue(newObject, chalk.green));
         }
       } else if (oldObject !== undefined /* && newObject === undefined */) {
-        this.print('%s   └─ %s', linePrefix, this.formatValue(oldObject, colors.red));
+        this.print('%s   └─ %s', linePrefix, this.formatValue(oldObject, chalk.red));
       } else /* if (oldObject === undefined && newObject !== undefined) */ {
-        this.print('%s   └─ %s', linePrefix, this.formatValue(newObject, colors.green));
+        this.print('%s   └─ %s', linePrefix, this.formatValue(newObject, chalk.green));
       }
       return;
     }
@@ -268,12 +268,12 @@ class Formatter {
       const newValue = newObject[key];
       const treePrefix = key === lastKey ? '└' : '├';
       if (oldValue !== undefined && newValue !== undefined) {
-        this.print('%s   %s─ %s %s:', linePrefix, treePrefix, this.changeTag(oldValue, newValue), colors.blue(`.${key}`));
+        this.print('%s   %s─ %s %s:', linePrefix, treePrefix, this.changeTag(oldValue, newValue), chalk.blue(`.${key}`));
         this.formatObjectDiff(oldValue, newValue, `${linePrefix}   ${key === lastKey ? ' ' : '│'}`);
       } else if (oldValue !== undefined /* && newValue === undefined */) {
-        this.print('%s   %s─ %s Removed: %s', linePrefix, treePrefix, REMOVAL, colors.blue(`.${key}`));
+        this.print('%s   %s─ %s Removed: %s', linePrefix, treePrefix, REMOVAL, chalk.blue(`.${key}`));
       } else /* if (oldValue === undefined && newValue !== undefined */ {
-        this.print('%s   %s─ %s Added: %s', linePrefix, treePrefix, ADDITION, colors.blue(`.${key}`));
+        this.print('%s   %s─ %s Added: %s', linePrefix, treePrefix, ADDITION, chalk.blue(`.${key}`));
       }
     }
   }
@@ -322,7 +322,7 @@ class Formatter {
     const normalized = this.normalizedLogicalIdPath(logicalId);
 
     if (normalized) {
-      return `${normalized} ${colors.gray(logicalId)}`;
+      return `${normalized} ${chalk.gray(logicalId)}`;
     }
 
     return logicalId;
@@ -430,7 +430,7 @@ function _diffStrings(oldStr: string, newStr: string, context: number): string[]
   const patch: Patch = structuredPatch(null, null, oldStr, newStr, null, null, { context });
   const result = new Array<string>();
   for (const hunk of patch.hunks) {
-    result.push(colors.magenta(`@@ -${hunk.oldStart},${hunk.oldLines} +${hunk.newStart},${hunk.newLines} @@`));
+    result.push(chalk.magenta(`@@ -${hunk.oldStart},${hunk.oldLines} +${hunk.newStart},${hunk.newLines} @@`));
     const baseIndent = _findIndent(hunk.lines);
     for (const line of hunk.lines) {
       // Don't care about termination newline.
@@ -442,10 +442,10 @@ function _diffStrings(oldStr: string, newStr: string, context: number): string[]
           result.push(`${CONTEXT} ${text}`);
           break;
         case '+':
-          result.push(colors.bold(`${ADDITION} ${colors.green(text)}`));
+          result.push(chalk.bold(`${ADDITION} ${chalk.green(text)}`));
           break;
         case '-':
-          result.push(colors.bold(`${REMOVAL} ${colors.red(text)}`));
+          result.push(chalk.bold(`${REMOVAL} ${chalk.red(text)}`));
           break;
         default:
           throw new Error(`Unexpected diff marker: ${marker} (full line: ${line})`);

packages/@aws-cdk/cloudformation-diff/lib/iam/iam-changes.ts

@@ -1,5 +1,5 @@
 import * as cfnspec from '@aws-cdk/cfnspec';
-import * as colors from 'colors/safe';
+import * as chalk from 'chalk';
 import { PropertyChange, PropertyMap, ResourceChange } from '../diff/types';
 import { DiffableCollection } from '../diffable';
 import { renderIntrinsics } from '../render-intrinsics';
@@ -77,18 +77,18 @@ export class IamChanges {
         renderedStatement.action,
         renderedStatement.principal,
         renderedStatement.condition,
-      ].map(s => colors.green(s)));
+      ].map(s => chalk.green(s)));
     }
     for (const statement of this.statements.removals) {
       const renderedStatement = statement.render();
       ret.push([
-        colors.red('-'),
+        chalk.red('-'),
         renderedStatement.resource,
         renderedStatement.effect,
         renderedStatement.action,
         renderedStatement.principal,
         renderedStatement.condition,
-      ].map(s => colors.red(s)));
+      ].map(s => chalk.red(s)));
     }
 
     // Sort by 2nd column
@@ -108,14 +108,14 @@ export class IamChanges {
         '+',
         att.identityArn,
         att.managedPolicyArn,
-      ].map(s => colors.green(s)));
+      ].map(s => chalk.green(s)));
     }
     for (const att of this.managedPolicies.removals) {
       ret.push([
         '-',
         att.identityArn,
         att.managedPolicyArn,
-      ].map(s => colors.red(s)));
+      ].map(s => chalk.red(s)));
     }
 
     // Sort by 2nd column

packages/@aws-cdk/cloudformation-diff/lib/network/security-group-changes.ts

@@ -1,4 +1,4 @@
-import * as colors from 'colors/safe';
+import * as chalk from 'chalk';
 import { PropertyChange, ResourceChange } from '../diff/types';
 import { DiffableCollection } from '../diffable';
 import { renderIntrinsics } from '../render-intrinsics';
@@ -66,7 +66,7 @@ export class SecurityGroupChanges {
       inOut,
       rule.describeProtocol(),
       rule.describePeer(),
-    ].map(s => plusMin === '+' ? colors.green(s) : colors.red(s));
+    ].map(s => plusMin === '+' ? chalk.green(s) : chalk.red(s));
 
     // First generate all lines, sort later
     ret.push(...this.ingress.additions.map(renderRule('+', inWord)));

packages/@aws-cdk/cloudformation-diff/package.json

@@ -25,7 +25,7 @@
   "dependencies": {
     "@aws-cdk/cfnspec": "0.0.0",
     "@types/node": "^10.17.60",
-    "colors": "1.4.0",
+    "chalk": "^4",
     "diff": "^5.0.0",
     "fast-deep-equal": "^3.1.3",
     "string-width": "^4.2.3",
@@ -58,4 +58,4 @@
   "publishConfig": {
     "tag": "latest-1"
   }
-}
+}

packages/aws-cdk/bin/cdk.ts

@@ -2,7 +2,7 @@
 import 'source-map-support/register';
 import * as cxapi from '@aws-cdk/cx-api';
 import '@jsii/check-node/run';
-import * as colors from 'colors/safe';
+import * as chalk from 'chalk';
 import * as yargs from 'yargs';
 
 import { SdkProvider } from '../lib/api/aws-auth';
@@ -190,7 +190,8 @@ async function parseCommandLineArguments() {
 }
 
 if (!process.stdout.isTTY) {
-  colors.disable();
+  // Disable chalk color highlighting
+  process.env.FORCE_COLOR = '0';
 }
 
 async function initCommandLine() {
@@ -234,7 +235,7 @@ async function initCommandLine() {
       for (const plugin of plugins) {
         const resolved = tryResolve(plugin);
         if (loaded.has(resolved)) { continue; }
-        debug(`Loading plug-in: ${colors.green(plugin)} from ${colors.blue(resolved)}`);
+        debug(`Loading plug-in: ${chalk.green(plugin)} from ${chalk.blue(resolved)}`);
         PluginHost.instance.load(plugin);
         loaded.add(resolved);
       }
@@ -244,7 +245,7 @@ async function initCommandLine() {
       try {
         return require.resolve(plugin);
       } catch (e) {
-        error(`Unable to resolve plugin ${colors.green(plugin)}: ${e.stack}`);
+        error(`Unable to resolve plugin ${chalk.green(plugin)}: ${e.stack}`);
         throw new Error(`Unable to resolve plug-in: ${plugin}`);
       }
     }
@@ -278,7 +279,7 @@ async function initCommandLine() {
 
   async function main(command: string, args: any): Promise<number | string | {} | void> {
     const toolkitStackName: string = ToolkitInfo.determineName(configuration.settings.get(['toolkitStackName']));
-    debug(`Toolkit stack: ${colors.bold(toolkitStackName)}`);
+    debug(`Toolkit stack: ${chalk.bold(toolkitStackName)}`);
 
     if (args.all && args.STACKS) {
       throw new Error('You must either specify a list of Stacks or the `--all` argument');

packages/aws-cdk/lib/api/cxapp/cloud-assembly.ts

@@ -1,5 +1,5 @@
 import * as cxapi from '@aws-cdk/cx-api';
-import * as colors from 'colors/safe';
+import * as chalk from 'chalk';
 import * as minimatch from 'minimatch';
 import * as semver from 'semver';
 import { error, print, warning } from '../../logging';
@@ -134,7 +134,7 @@ export class CloudAssembly {
       if (minimatch(stack.hierarchicalId, pattern)) {
         return true;
       } else if (!disableLegacy && stack.id === pattern && semver.major(versionNumber()) < 2) {
-        warning('Selecting stack by identifier "%s". This identifier is deprecated and will be removed in v2. Please use "%s" instead.', colors.bold(stack.id), colors.bold(stack.hierarchicalId));
+        warning('Selecting stack by identifier "%s". This identifier is deprecated and will be removed in v2. Please use "%s" instead.', chalk.bold(stack.id), chalk.bold(stack.hierarchicalId));
         warning('Run "cdk ls" to see a list of all stack identifiers');
         return true;
       }
@@ -342,7 +342,7 @@ function includeDownstreamStacks(
   } while (madeProgress);
 
   if (added.length > 0) {
-    print('Including depending stacks: %s', colors.bold(added.join(', ')));
+    print('Including depending stacks: %s', chalk.bold(added.join(', ')));
   }
 }
 
@@ -372,12 +372,12 @@ function includeUpstreamStacks(
   }
 
   if (added.length > 0) {
-    print('Including dependency stacks: %s', colors.bold(added.join(', ')));
+    print('Including dependency stacks: %s', chalk.bold(added.join(', ')));
   }
 }
 
 function sanitizePatterns(patterns: string[]): string[] {
   let sanitized = patterns.filter(s => s != null); // filter null/undefined
   sanitized = [...new Set(sanitized)]; // make them unique
   return sanitized;
-}
+}