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

Fix/dx 4465 upgrade chalk to v5

Author: harshitha-cstk

.talismanrc

@@ -1,4 +1,4 @@
 fileignoreconfig:
-  - filename: pnpm-lock.yaml
-    checksum: 901fcf828dc9d8d85277c767cd468791388a4a3b0cb30525bcdcb86d009be6f4
-version: '1.0'
+- filename: pnpm-lock.yaml
+  checksum: 0a12c6c1e4df121f6a217425ef0bd7b1acccc1cd3f972157f7ca7480281277fd
+version: "1.0"

packages/contentstack-audit/.mocharc.json

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

packages/contentstack-audit/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-audit",
-  "version": "2.0.0-beta.7",
+  "version": "2.0.0-beta.8",
   "description": "Contentstack audit plugin",
   "author": "Contentstack CLI",
   "homepage": "https://github.com/contentstack/cli",
@@ -18,11 +18,11 @@
     "/oclif.manifest.json"
   ],
   "dependencies": {
-    "@contentstack/cli-command": "~2.0.0-beta.3",
-    "@contentstack/cli-utilities": "~2.0.0-beta.3",
+    "@contentstack/cli-command": "~2.0.0-beta.4",
+    "@contentstack/cli-utilities": "~2.0.0-beta.4",
     "@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",

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);
             }
           },
         }));

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 = {

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(' ');

packages/contentstack-audit/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-bootstrap/.mocharc.json

@@ -0,0 +1,5 @@
+{
+  "require": ["test/helpers/mocha-root-hooks.js"],
+  "recursive": true,
+  "timeout": 60000
+}

packages/contentstack-bootstrap/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contentstack/cli-cm-bootstrap",
   "description": "Bootstrap contentstack apps",
-  "version": "2.0.0-beta.12",
+  "version": "2.0.0-beta.13",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "scripts": {
@@ -16,10 +16,10 @@
     "test:report": "nyc --reporter=lcov mocha \"test/**/*.test.js\""
   },
   "dependencies": {
-    "@contentstack/cli-cm-seed": "~2.0.0-beta.11",
-    "@contentstack/cli-command": "~2.0.0-beta.3",
-    "@contentstack/cli-utilities": "~2.0.0-beta.3",
-    "@contentstack/cli-config": "~2.0.0-beta.4",
+    "@contentstack/cli-cm-seed": "~2.0.0-beta.12",
+    "@contentstack/cli-command": "~2.0.0-beta.4",
+    "@contentstack/cli-utilities": "~2.0.0-beta.4",
+    "@contentstack/cli-config": "~2.0.0-beta.5",
     "@oclif/core": "^4.3.0",
     "@oclif/plugin-help": "^6.2.37",
     "inquirer": "12.11.1",

packages/contentstack-bootstrap/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();
+  },
+};