Upgrade chalk dependency to version 5.6.2 and refactor code to use getChalk() from @contentstack/cli-utilities for consistent color handling across multiple packages.

harshitha-cstk · harshitha-cstk · commit 7e3b82fa06bb · 2026-03-10T12:23:13.000+05:30
diff --git a/packages/contentstack-audit/package.json b/packages/contentstack-audit/package.json
@@ -22,7 +22,7 @@
     "@contentstack/cli-utilities": "~2.0.0-beta.2",
     "@oclif/core": "^4.3.0",
     "@oclif/plugin-help": "^6.2.28",
-    "chalk": "^4.1.2",
+    "chalk": "^5.6.2",
     "fast-csv": "^4.3.6",
     "fs-extra": "^11.3.0",
     "lodash": "^4.17.23",
diff --git a/packages/contentstack-audit/src/audit-base-command.ts b/packages/contentstack-audit/src/audit-base-command.ts
@@ -1,4 +1,4 @@
-import chalk from 'chalk';
+import { getChalk } from '@contentstack/cli-utilities';
 import * as csv from 'fast-csv';
 import { copy } from 'fs-extra';
 import { v4 as uuid } from 'uuid';
@@ -55,7 +55,7 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
         minWidth: 7,
         header: 'Fix Status',
         get: (row: any) => {
-          return row.fixStatus === 'Fixed' ? chalk.greenBright(row.fixStatus) : chalk.redBright(row.fixStatus);
+          return row.fixStatus === 'Fixed' ? getChalk().greenBright(row.fixStatus) : getChalk().redBright(row.fixStatus);
         },
       },
     };
@@ -548,7 +548,7 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
               value: 'missingRefs',
               alias: 'Missing references',
               formatter: (cellValue: any) => {
-                return chalk.red(typeof cellValue === 'object' ? JSON.stringify(cellValue) : cellValue);
+                return getChalk().red(typeof cellValue === 'object' ? JSON.stringify(cellValue) : cellValue);
               },
             },
             {
@@ -588,7 +588,7 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
           value: key,
           formatter: (cellValue: any) => {
             if (key === 'fixStatus' || key === 'Fixable' || key === 'Fixed') {
-              return chalk.green(typeof cellValue === 'object' ? JSON.stringify(cellValue) : cellValue);
+              return getChalk().green(typeof cellValue === 'object' ? JSON.stringify(cellValue) : cellValue);
             } else if (
               key === 'content_types' ||
               key === 'branches' ||
@@ -598,9 +598,9 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
               key === 'Non-Fixable' ||
               key === 'Not-Fixed'
             ) {
-              return chalk.red(typeof cellValue === 'object' ? JSON.stringify(cellValue) : cellValue);
+              return getChalk().red(typeof cellValue === 'object' ? JSON.stringify(cellValue) : cellValue);
             } else {
-              return chalk.white(typeof cellValue === 'object' ? JSON.stringify(cellValue) : cellValue);
+              return getChalk().white(typeof cellValue === 'object' ? JSON.stringify(cellValue) : cellValue);
             }
           },
         }));
diff --git a/packages/contentstack-audit/src/types/utils.ts b/packages/contentstack-audit/src/types/utils.ts
@@ -1,4 +1,4 @@
-import { Color } from "chalk";
+import type { ForegroundColorName } from 'chalk';
 import { PrintOptions } from "@contentstack/cli-utilities";
 
 import config from "../config";
@@ -26,7 +26,7 @@ export type LoggerType = "info" | "warn" | "error" | "debug" | 'hidden';
 export type PrintType = {
   message: string;
   bold?: boolean;
-  color?: typeof Color;
+  color?: ForegroundColorName;
 };
 
 export type JSONFlagOptions = {
diff --git a/packages/contentstack-audit/src/util/log.ts b/packages/contentstack-audit/src/util/log.ts
@@ -1,6 +1,6 @@
 import map from 'lodash/map';
 import winston from 'winston';
-import chalk, { Chalk } from 'chalk';
+import { getChalk, ChalkInstance } from '@contentstack/cli-utilities';
 import replace from 'lodash/replace';
 import isObject from 'lodash/isObject';
 import { normalize, resolve } from 'path';
@@ -170,10 +170,11 @@ export default class Logger {
  * @param printInput - An array of objects with the following properties:
  */
 export function print(printInput: Array<PrintType>): void {
+  const chalk = getChalk();
   const str = map(printInput, ({ message, bold, color }: PrintType) => {
-    let chalkFn: Chalk = chalk;
-    if (color) chalkFn = chalkFn[color];
-    if (bold) chalkFn = chalkFn.bold;
+    let chalkFn: ChalkInstance = chalk;
+    if (color) chalkFn = chalkFn[color] as ChalkInstance;
+    if (bold) chalkFn = chalkFn.bold as ChalkInstance;
 
     return chalkFn(message);
   }).join(' ');
diff --git a/packages/contentstack-branches/package.json b/packages/contentstack-branches/package.json
@@ -9,7 +9,7 @@
     "@oclif/core": "^4.3.0",
     "@oclif/plugin-help": "^6.2.28",
     "@contentstack/cli-utilities": "~2.0.0-beta.2",
-    "chalk": "^4.1.2",
+    "chalk": "^5.6.2",
     "just-diff": "^6.0.2",
     "lodash": "^4.17.23"
   },
diff --git a/packages/contentstack-branches/src/branch/merge-handler.ts b/packages/contentstack-branches/src/branch/merge-handler.ts
@@ -2,7 +2,7 @@ import os from 'os';
 import path from 'path';
 import forEach from 'lodash/forEach';
 import { cliux } from '@contentstack/cli-utilities';
-import chalk from 'chalk';
+import { getChalk } from '@contentstack/cli-utilities';
 import { MergeInputOptions, MergeSummary } from '../interfaces';
 import {
   selectMergeStrategy,
@@ -140,15 +140,15 @@ export default class MergeHandler {
     const strategyName = this.mergeSettings.strategy;
     
     if (allEmpty) {
-      cliux.print(chalk.red(`No items selected according to the '${strategyName}' strategy.`));
+      cliux.print(getChalk().red(`No items selected according to the '${strategyName}' strategy.`));
       process.exit(1);
     }
     
     for (const [type, { exists, empty }] of Object.entries(moduleStatus)) {
       if (exists && empty) {
         const readable = type === 'contentType' ? 'Content Types' : 'Global fields';
         cliux.print('\n')
-        cliux.print(chalk.yellow(`Note: No ${readable} selected according to the '${strategyName}' strategy.`));
+        cliux.print(getChalk().yellow(`Note: No ${readable} selected according to the '${strategyName}' strategy.`));
       }
     }
     
diff --git a/packages/contentstack-branches/src/commands/cm/branches/index.ts b/packages/contentstack-branches/src/commands/cm/branches/index.ts
@@ -8,7 +8,7 @@ import {
   TableHeader,
 } from '@contentstack/cli-utilities';
 import { getbranchesList, getbranchConfig, interactive, handleErrorMsg } from '../../../utils/index';
-import chalk from 'chalk';
+import { getChalk } from '@contentstack/cli-utilities';
 export default class BranchListCommand extends Command {
   static description: string = messageHandler.parse('List the branches'); // Note: Update the description
 
@@ -54,10 +54,10 @@ export default class BranchListCommand extends Command {
 
         if (!verbose) {
           currentBranch[0]?.Source
-            ? cliux.print(`* ${chalk.bold(currentBranch[0].Branch)} (source: ${currentBranch[0].Source})`, {
+            ? cliux.print(`* ${getChalk().bold(currentBranch[0].Branch)} (source: ${currentBranch[0].Source})`, {
                 color: 'blue',
               })
-            : cliux.print(`* ${chalk.bold(currentBranch[0].Branch)}`, {
+            : cliux.print(`* ${getChalk().bold(currentBranch[0].Branch)}`, {
                 color: 'blue',
               });
 
diff --git a/packages/contentstack-branches/src/utils/branch-diff-utility.ts b/packages/contentstack-branches/src/utils/branch-diff-utility.ts
@@ -1,4 +1,4 @@
-import chalk from 'chalk';
+import { getChalk } from '@contentstack/cli-utilities';
 import forEach from 'lodash/forEach';
 import padStart from 'lodash/padStart';
 import startCase from 'lodash/startCase';
@@ -196,19 +196,19 @@ function printCompactTextView(branchTextRes: BranchCompactTextRes): void {
     cliux.print(' ');
     forEach(branchTextRes.added, (diff: BranchDiffRes) => {
       if (diff.merge_strategy !== 'ignore') {
-        cliux.print(chalk.green(`+ '${diff.title}' ${startCase(camelCase(diff.type))}`));
+        cliux.print(getChalk().green(`+ '${diff.title}' ${startCase(camelCase(diff.type))}`));
       }
     });
 
     forEach(branchTextRes.modified, (diff: BranchDiffRes) => {
       if (diff.merge_strategy !== 'ignore') {
-        cliux.print(chalk.blue(`± '${diff.title}' ${startCase(camelCase(diff.type))}`));
+        cliux.print(getChalk().blue(`± '${diff.title}' ${startCase(camelCase(diff.type))}`));
       }
     });
 
     forEach(branchTextRes.deleted, (diff: BranchDiffRes) => {
       if (diff.merge_strategy !== 'ignore') {
-        cliux.print(chalk.red(`- '${diff.title}' ${startCase(camelCase(diff.type))}`));
+        cliux.print(getChalk().red(`- '${diff.title}' ${startCase(camelCase(diff.type))}`));
       }
     });
   }
@@ -442,16 +442,16 @@ function printVerboseTextView(branchTextRes: BranchDiffVerboseRes): void {
   if (branchTextRes.modified?.length || branchTextRes.added?.length || branchTextRes.deleted?.length) {
     cliux.print(' ');
     forEach(branchTextRes.added, (diff: BranchDiffRes) => {
-      cliux.print(chalk.green(`+ '${diff.title}' ${startCase(camelCase(diff.type))}`));
+      cliux.print(getChalk().green(`+ '${diff.title}' ${startCase(camelCase(diff.type))}`));
     });
 
     forEach(branchTextRes.modified, (diff: BranchModifiedDetails) => {
-      cliux.print(chalk.blue(`± '${diff.moduleDetails.title}' ${startCase(camelCase(diff.moduleDetails.type))}`));
+      cliux.print(getChalk().blue(`± '${diff.moduleDetails.title}' ${startCase(camelCase(diff.moduleDetails.type))}`));
       printModifiedFields(diff.modifiedFields);
     });
 
     forEach(branchTextRes.deleted, (diff: BranchDiffRes) => {
-      cliux.print(chalk.red(`- '${diff.title}' ${startCase(camelCase(diff.type))}`));
+      cliux.print(getChalk().red(`- '${diff.title}' ${startCase(camelCase(diff.type))}`));
     });
   }
 }
@@ -466,17 +466,17 @@ function printModifiedFields(modfiedFields: ModifiedFieldsInput): void {
     forEach(modfiedFields.modified, (diff: ModifiedFieldsType) => {
       const field: string = diff.field ? `${diff.field}` : 'field';
       const fieldDetail = diff.path ? `(${diff.path}) ${field}`: `${field}`;
-      cliux.print(`   ${chalk.blue(`± "${diff.displayName}" ${fieldDetail}`)}`);
+      cliux.print(`   ${getChalk().blue(`± "${diff.displayName}" ${fieldDetail}`)}`);
     });
 
     forEach(modfiedFields.added, (diff: ModifiedFieldsType) => {
       const field: string = diff.field ? `${diff.field} field` : 'field';
-      cliux.print(`   ${chalk.green(`+ "${diff.displayName}" (${diff.path}) ${field}`)}`);
+      cliux.print(`   ${getChalk().green(`+ "${diff.displayName}" (${diff.path}) ${field}`)}`);
     });
 
     forEach(modfiedFields.deleted, (diff: ModifiedFieldsType) => {
       const field: string = diff.field ? `${diff.field} field` : 'field';
-      cliux.print(`   ${chalk.red(`- "${diff.displayName}" (${diff.path}) ${field}`)}`);
+      cliux.print(`   ${getChalk().red(`- "${diff.displayName}" (${diff.path}) ${field}`)}`);
     });
   }
 }
diff --git a/packages/contentstack-clone/package.json b/packages/contentstack-clone/package.json
@@ -12,7 +12,7 @@
     "@contentstack/cli-utilities": "~2.0.0-beta.2",
     "@oclif/core": "^4.3.0",
     "@oclif/plugin-help": "^6.2.28",
-    "chalk": "^4.1.2",
+    "chalk": "^5.6.2",
     "inquirer": "12.11.1",
     "lodash": "^4.17.23",
     "merge": "^2.1.1",
diff --git a/packages/contentstack-clone/src/core/util/clone-handler.ts b/packages/contentstack-clone/src/core/util/clone-handler.ts
@@ -1,7 +1,7 @@
 import { Ora, default as ora } from 'ora';
 import * as path from 'path';
 import inquirer from 'inquirer';
-import chalk from 'chalk';
+import { getChalk } from '@contentstack/cli-utilities';
 import * as fs from 'fs';
 import { rimraf } from 'rimraf';
 import { CustomAbortController } from './abort-controller';
@@ -170,7 +170,7 @@ export class CloneHandler {
   }
 
   displayBackOptionMessage(): void {
-    process.stdout.write(chalk.cyan('\nPress shift & left arrow together to undo the operation\n'));
+    process.stdout.write(getChalk().cyan('\nPress shift & left arrow together to undo the operation\n'));
   }
 
   setBackKeyPressHandler(backKeyPressHandler: (...args: any[]) => void): void {
diff --git a/packages/contentstack-export/package.json b/packages/contentstack-export/package.json
@@ -12,7 +12,7 @@
     "async": "^3.2.6",
     "big-json": "^3.2.0",
     "bluebird": "^3.7.2",
-    "chalk": "^4.1.2",
+    "chalk": "^5.6.2",
     "lodash": "^4.17.23",
     "merge": "^2.1.1",
     "mkdirp": "^1.0.4",
diff --git a/packages/contentstack-export/src/export/modules/assets.ts b/packages/contentstack-export/src/export/modules/assets.ts
@@ -1,5 +1,5 @@
 import map from 'lodash/map';
-import chalk from 'chalk';
+import { getChalk } from '@contentstack/cli-utilities';
 import chunk from 'lodash/chunk';
 import first from 'lodash/first';
 import merge from 'lodash/merge';
@@ -57,7 +57,7 @@ export default class ExportAssets extends BaseClass {
     log.debug('Fetching assets and folders count...', this.exportConfig.context);
     // NOTE step 1: Get assets and it's folder count in parallel
     const [assetsCount, assetsFolderCount] = await this.withLoadingSpinner(
-      `${chalk.bold('ASSETS')}: Analyzing stack content...`,
+      `${getChalk().bold('ASSETS')}: Analyzing stack content...`,
       () => Promise.all([this.getAssetsCount(), this.getAssetsCount(true)]),
     );
 
diff --git a/packages/contentstack-import-setup/package.json b/packages/contentstack-import-setup/package.json
@@ -9,7 +9,7 @@
     "@contentstack/cli-utilities": "~2.0.0-beta.2",
     "@oclif/core": "^4.3.0",
     "big-json": "^3.2.0",
-    "chalk": "^4.1.2",
+    "chalk": "^5.6.2",
     "fs-extra": "^11.3.0",
     "lodash": "^4.17.23",
     "merge": "^2.1.1",
diff --git a/packages/contentstack-import-setup/src/import/modules/assets.ts b/packages/contentstack-import-setup/src/import/modules/assets.ts
@@ -1,4 +1,3 @@
-import * as chalk from 'chalk';
 import { log, fsUtil } from '../../utils';
 import { join } from 'path';
 import { AssetRecord, ImportConfig, ModuleClassParams } from '../../types';
diff --git a/packages/contentstack-import-setup/src/import/modules/content-types.ts b/packages/contentstack-import-setup/src/import/modules/content-types.ts
@@ -1,4 +1,3 @@
-import * as chalk from 'chalk';
 import { log, fsUtil } from '../../utils';
 import { join } from 'path';
 import { ImportConfig, ModuleClassParams } from '../../types';
diff --git a/packages/contentstack-import-setup/src/import/modules/extensions.ts b/packages/contentstack-import-setup/src/import/modules/extensions.ts
@@ -1,4 +1,3 @@
-import * as chalk from 'chalk';
 import { log, fsUtil } from '../../utils';
 import { join } from 'path';
 import { ImportConfig, ModuleClassParams } from '../../types';
diff --git a/packages/contentstack-import-setup/src/import/modules/global-fields.ts b/packages/contentstack-import-setup/src/import/modules/global-fields.ts
@@ -1,4 +1,3 @@
-import * as chalk from 'chalk';
 import { log, fsUtil } from '../../utils';
 import { join } from 'path';
 import { ImportConfig, ModuleClassParams } from '../../types';
diff --git a/packages/contentstack-import-setup/src/utils/common-helper.ts b/packages/contentstack-import-setup/src/utils/common-helper.ts
@@ -1,4 +1,4 @@
-import chalk from 'chalk';
+import { getChalk } from '@contentstack/cli-utilities';
 import { log as defaultLog } from '@contentstack/cli-utilities';
 import { ImportConfig } from 'src/types';
 
@@ -22,8 +22,8 @@ export const validateBranch = async (
       const data = await stackAPIClient.branch(branch).fetch();
       if (data && typeof data === 'object') {
         if (data.error_message) {
-          log.error(chalk.red(data.error_message), { error: data.error_message });
-          log.error(chalk.red('No branch found with the name ' + branch), { branch });
+          log.error(getChalk().red(data.error_message), { error: data.error_message });
+          log.error(getChalk().red('No branch found with the name ' + branch), { branch });
           reject({ message: 'No branch found with the name ' + branch, error: data.error_message });
         } else {
           resolve(data);
@@ -32,7 +32,7 @@ export const validateBranch = async (
         reject({ message: 'No branch found with the name ' + branch, error: {} });
       }
     } catch (error) {
-      log.error(chalk.red('No branch found with the name ' + branch), { error, branch });
+      log.error(getChalk().red('No branch found with the name ' + branch), { error, branch });
       reject({ message: 'No branch found with the name ' + branch, error });
     }
   });
diff --git a/packages/contentstack-import/package.json b/packages/contentstack-import/package.json
@@ -12,7 +12,7 @@
     "@oclif/core": "^4.3.0",
     "big-json": "^3.2.0",
     "bluebird": "^3.7.2",
-    "chalk": "^4.1.2",
+    "chalk": "^5.6.2",
     "debug": "^4.4.3",
     "fs-extra": "^11.3.3",
     "lodash": "^4.17.23",
diff --git a/packages/contentstack-import/src/import/modules/marketplace-apps.ts b/packages/contentstack-import/src/import/modules/marketplace-apps.ts
@@ -1,4 +1,4 @@
-import chalk from 'chalk';
+import { getChalk } from '@contentstack/cli-utilities';
 import map from 'lodash/map';
 import omit from 'lodash/omit';
 import find from 'lodash/find';
@@ -551,7 +551,7 @@ export default class ImportMarketplaceApps extends BaseClass {
 
         if (
           await cliux.confirm(
-            chalk.yellow(
+            getChalk().yellow(
               'WARNING!!! The above error may have an impact if the failed app is referenced in entries/content type. Would you like to proceed? (y/n)',
             ),
           )
diff --git a/packages/contentstack-import/src/import/modules/workflows.ts b/packages/contentstack-import/src/import/modules/workflows.ts
@@ -1,4 +1,4 @@
-import chalk from 'chalk';
+import { getChalk } from '@contentstack/cli-utilities';
 import map from 'lodash/map';
 import find from 'lodash/find';
 import { join } from 'node:path';
@@ -290,7 +290,7 @@ export default class ImportWorkflows extends BaseClass {
     } else {
       if (workflow.admin_users !== undefined) {
         log.info(
-          chalk.yellow('We are skipping import of `Workflow superuser(s)` from workflow'),
+          getChalk().yellow('We are skipping import of `Workflow superuser(s)` from workflow'),
           this.importConfig.context,
         );
         delete workflow.admin_users;
diff --git a/packages/contentstack-import/src/utils/common-helper.ts b/packages/contentstack-import/src/utils/common-helper.ts
@@ -18,7 +18,6 @@ import {
 import { PATH_CONSTANTS } from '../constants';
 import { readFileSync, readdirSync, readFile, fileExistsSync } from './file-helper';
 
-import chalk from 'chalk';
 import defaultConfig from '../config';
 import promiseLimit from 'promise-limit';
 import { ImportConfig } from '../types';
diff --git a/packages/contentstack-import/src/utils/marketplace-app-helper.ts b/packages/contentstack-import/src/utils/marketplace-app-helper.ts
diff --git a/packages/contentstack-migration/package.json b/packages/contentstack-migration/package.json
diff --git a/packages/contentstack-migration/src/utils/error-helper.ts b/packages/contentstack-migration/src/utils/error-helper.ts
