Merge pull request #2451 from contentstack/fix/dx-4465-upgrade-chalk-to-v5

Fix/dx 4465 upgrade chalk to v5

Author: harshitha-cstk

packages/contentstack-auth/.mocharc.json

@@ -2,7 +2,8 @@
   "require": [
     "test/helpers/init.js",
     "ts-node/register",
-    "source-map-support/register"
+    "source-map-support/register",
+    "test/helpers/mocha-root-hooks.js"
   ],
   "watch-extensions": [
     "ts"

packages/contentstack-auth/test/helpers/mocha-root-hooks.js

@@ -0,0 +1,11 @@
+/**
+ * @contentstack/cli-utilities uses lazy-loaded Chalk 5; preload before tests that hit cliux.
+ */
+const { loadChalk } = require('@contentstack/cli-utilities');
+
+exports.mochaHooks = {
+  beforeAll() {
+    this.timeout(30_000);
+    return loadChalk();
+  },
+};

packages/contentstack-config/.mocharc.json

@@ -1,7 +1,8 @@
 {
     "require": [
       "ts-node/register",
-      "source-map-support/register"
+      "source-map-support/register",
+      "test/helpers/mocha-root-hooks.js"
     ],
     "watch-extensions": [
       "ts"

packages/contentstack-config/test/helpers/mocha-root-hooks.js

@@ -0,0 +1,11 @@
+/**
+ * @contentstack/cli-utilities uses lazy-loaded Chalk 5; preload before tests that hit cliux.success etc.
+ */
+const { loadChalk } = require('@contentstack/cli-utilities');
+
+exports.mochaHooks = {
+  beforeAll() {
+    this.timeout(30_000);
+    return loadChalk();
+  },
+};

packages/contentstack-utilities/.mocharc.json

@@ -2,7 +2,8 @@
     "require": [
       "test/helpers/init.js",
       "ts-node/register",
-      "source-map-support/register"
+      "source-map-support/register",
+      "test/helpers/mocha-root-hooks.js"
     ],
     "watch-extensions": [
       "ts"

packages/contentstack-utilities/package.json

@@ -37,7 +37,7 @@
     "@contentstack/marketplace-sdk": "^1.5.0",
     "@oclif/core": "^4.3.0",
     "axios": "^1.13.5",
-    "chalk": "^4.1.2",
+    "chalk": "^5.6.2",
     "cli-cursor": "^3.1.0",
     "cli-progress": "^3.12.0",
     "cli-table": "^0.3.11",

packages/contentstack-utilities/src/chalk.ts

@@ -0,0 +1,27 @@
+/**
+ * Chalk 5 is ESM-only. We load it via dynamic import and cache for use in CommonJS.
+ */
+let chalkInstance: typeof import('chalk').default | null = null;
+
+export type ChalkInstance = typeof import('chalk').default;
+
+/**
+ * Load chalk (ESM) and cache it. Call this once during CLI init before any chalk usage.
+ */
+export async function loadChalk(): Promise<ChalkInstance> {
+  if (!chalkInstance) {
+    const chalkModule = await import('chalk');
+    chalkInstance = chalkModule.default;
+  }
+  return chalkInstance;
+}
+
+/**
+ * Get the cached chalk instance. Must call loadChalk() first (e.g. in init hook).
+ */
+export function getChalk(): ChalkInstance {
+  if (!chalkInstance) {
+    throw new Error('Chalk not loaded. Ensure loadChalk() is called during init (e.g. in utils-init hook).');
+  }
+  return chalkInstance;
+}

packages/contentstack-utilities/src/cli-ux.ts

@@ -1,4 +1,4 @@
-import chalk, { Chalk } from 'chalk';
+import { getChalk, ChalkInstance } from './chalk';
 import inquirer from 'inquirer';
 import { ux as cliux, Args, Flags, Command } from '@oclif/core';
 import { Ora, default as ora } from 'ora';
@@ -29,10 +29,11 @@ class CLIInterface {
 
   print(message: string, opts?: PrintOptions): void {
     if (opts) {
-      let chalkFn: Chalk = chalk;
+      const chalk = getChalk();
+      let chalkFn: ChalkInstance = chalk;
 
-      if (opts.color) chalkFn = chalkFn[opts.color] as Chalk;
-      if (opts.bold) chalkFn = chalkFn.bold as Chalk;
+      if (opts.color) chalkFn = chalkFn[opts.color] as ChalkInstance;
+      if (opts.bold) chalkFn = chalkFn.bold as ChalkInstance;
 
       cliux.stdout(chalkFn(messageHandler.parse(message)));
       return;
@@ -42,11 +43,11 @@ class CLIInterface {
   }
 
   success(message: string): void {
-    cliux.stdout(chalk.green(messageHandler.parse(message)));
+    cliux.stdout(getChalk().green(messageHandler.parse(message)));
   }
 
   error(message: string, ...params: any): void {
-    cliux.stdout(chalk.red(messageHandler.parse(message) + (params && params.length > 0 ? ': ' : '')), ...params);
+    cliux.stdout(getChalk().red(messageHandler.parse(message) + (params && params.length > 0 ? ': ' : '')), ...params);
   }
 
   loader(message: string = ''): void {

packages/contentstack-utilities/src/config-handler.ts

@@ -2,7 +2,7 @@ import Conf from 'conf';
 import has from 'lodash/has';
 import { v4 as uuid } from 'uuid';
 import { existsSync, unlinkSync, readFileSync } from 'fs';
-import chalk from 'chalk';
+import { getChalk } from './chalk';
 import { cliux } from '.';
 
 const ENC_KEY = process.env.ENC_KEY || 'encryptionKey';
@@ -85,7 +85,7 @@ class Config {
 
   safeDeleteConfigIfInvalid(configFilePath: string) {
     if (existsSync(configFilePath) && !this.isConfigFileValid(configFilePath)) {
-      console.warn(chalk.yellow(`Warning: Detected corrupted config at ${configFilePath}. Removing...`));
+      console.warn(getChalk().yellow(`Warning: Detected corrupted config at ${configFilePath}. Removing...`));
       unlinkSync(configFilePath);
     }
   }
@@ -152,7 +152,7 @@ class Config {
           const oldConfigData = this.getConfigDataAndUnlinkConfigFile(config);
           this.getEncryptedConfig(oldConfigData, true);
         } catch (_error) {
-          cliux.print(chalk.red('Error: Config file is corrupted'));
+          cliux.print(getChalk().red('Error: Config file is corrupted'));
           cliux.print(_error);
           process.exit(1);
         }
@@ -203,7 +203,7 @@ class Config {
           this.getDecryptedConfig(_configData); // NOTE reinitialize the config with old data and new decrypted file
         } catch (__error) {
           // console.trace(error.message)
-          cliux.print(chalk.red('Error: Config file is corrupted'));
+          cliux.print(getChalk().red('Error: Config file is corrupted'));
           cliux.print(_error);
           process.exit(1);
         }

packages/contentstack-utilities/src/content-type-utils.ts

@@ -1,21 +1,24 @@
+import { existsSync, readdirSync, readFileSync } from 'node:fs';
 import { resolve as pResolve } from 'node:path';
-import { FsUtility } from './fs-utility';
 
 /**
  * Reads all content type schema files from a directory
  * @param dirPath - Path to content types directory
  * @param ignoredFiles - Files to ignore (defaults to schema.json, .DS_Store, __master.json, __priority.json)
- * @returns Array of content type schemas
+ * @returns Array of content type schemas (empty if the path is missing or has no eligible files)
  */
 export function readContentTypeSchemas(
   dirPath: string,
   ignoredFiles: string[] = ['schema.json', '.DS_Store', '__master.json', '__priority.json', 'field_rules_uid.json'],
-): Record<string, unknown>[] | null {
-  const fsUtil = new FsUtility();
-  const files = fsUtil.readdir(dirPath);
+): Record<string, unknown>[] {
+  if (!existsSync(dirPath)) {
+    return [];
+  }
+
+  const files = readdirSync(dirPath);
 
   if (!files || files.length === 0) {
-    return null;
+    return [];
   }
 
   const contentTypes: Record<string, unknown>[] = [];
@@ -33,7 +36,8 @@ export function readContentTypeSchemas(
 
     try {
       const filePath = pResolve(dirPath, file);
-      const contentType = fsUtil.readFile(filePath);
+      const raw = readFileSync(filePath, 'utf8');
+      const contentType = JSON.parse(raw) as Record<string, unknown>;
       if (contentType) {
         contentTypes.push(contentType as Record<string, unknown>);
       }