@contentstack/cli-audit 1.17.0 → 2.0.0-beta.1

package/lib/audit-base-command.js

@@ -33,6 +33,19 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
             },
         };
     }
+    /**
+     * Create audit context object similar to export command
+     */
+    createAuditContext(moduleName) {
+        var _a, _b, _c;
+        return {
+            command: ((_b = (_a = this.context) === null || _a === void 0 ? void 0 : _a.info) === null || _b === void 0 ? void 0 : _b.command) || 'cm:stacks:audit',
+            module: moduleName || 'audit',
+            email: cli_utilities_1.configHandler.get('email') || '',
+            sessionId: ((_c = this.context) === null || _c === void 0 ? void 0 : _c.sessionId) || '',
+            authenticationMethod: cli_utilities_1.configHandler.get('authenticationMethod') || '',
+        };
+    }
     /**
      * The `start` function performs an audit on content types, global fields, entries, and workflows and displays
      * any missing references.
@@ -40,19 +53,27 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
      * being executed.
      */
     async start(command) {
-        var _a, _b;
         this.currentCommand = command;
-        // Initialize audit context (reused, no need to call again in scanAndFix)
-        (0, cli_utilities_1.createLogContext)((_b = (_a = this.context) === null || _a === void 0 ? void 0 : _a.info) === null || _b === void 0 ? void 0 : _b.command, '', cli_utilities_1.configHandler.get('authenticationMethod'));
-        this.auditContext = { module: 'audit' };
+        // Set progress supported module and console logs setting BEFORE any log calls
+        // This ensures the logger respects the setting when it's initialized
+        const logConfig = cli_utilities_1.configHandler.get('log') || {};
+        // Default to false so progress bars are shown instead of console logs
+        if (logConfig.showConsoleLogs === undefined) {
+            cli_utilities_1.configHandler.set('log.showConsoleLogs', false);
+        }
+        cli_utilities_1.configHandler.set('log.progressSupportedModule', 'audit');
+        // Initialize audit context
+        this.auditContext = this.createAuditContext();
         cli_utilities_1.log.debug(`Starting audit command: ${command}`, this.auditContext);
         cli_utilities_1.log.info(`Starting audit command: ${command}`, this.auditContext);
+        // Initialize global summary for progress tracking
+        cli_utilities_1.CLIProgressManager.initializeGlobalSummary('AUDIT', '', 'Auditing content...');
         await this.promptQueue();
         await this.createBackUp();
         this.sharedConfig.reportPath = (0, path_1.resolve)(this.flags['report-path'] || process.cwd(), 'audit-report');
         cli_utilities_1.log.debug(`Data directory: ${this.flags['data-dir']}`, this.auditContext);
         cli_utilities_1.log.debug(`Report path: ${this.flags['report-path'] || process.cwd()}`, this.auditContext);
-        const { missingCtRefs, missingGfRefs, missingEntryRefs, missingCtRefsInExtensions, missingCtRefsInWorkflow, missingSelectFeild, missingMandatoryFields, missingTitleFields, missingRefInCustomRoles, missingEnvLocalesInAssets, missingEnvLocalesInEntries, missingFieldRules, missingMultipleFields, missingRefsInComposableStudio, } = await this.scanAndFix();
+        const { missingCtRefs, missingGfRefs, missingEntryRefs, missingCtRefsInExtensions, missingCtRefsInWorkflow, missingSelectFeild, missingMandatoryFields, missingTitleFields, missingRefInCustomRoles, missingEnvLocalesInAssets, missingEnvLocalesInEntries, missingFieldRules, missingMultipleFields, } = await this.scanAndFix();
         if (this.flags['show-console-output']) {
             this.showOutputOnScreen([
                 { module: 'Content types', missingRefs: missingCtRefs },
@@ -79,7 +100,6 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
             this.showOutputOnScreenWorkflowsAndExtension([
                 { module: 'Entries Changed Multiple Fields', missingRefs: missingMultipleFields },
             ]);
-            this.showOutputOnScreenWorkflowsAndExtension([{ module: 'Studio', missingRefs: missingRefsInComposableStudio }]);
         }
         this.showOutputOnScreenWorkflowsAndExtension([{ module: 'Summary', missingRefs: this.summaryDataToPrint }]);
         if (!(0, isEmpty_1.default)(missingCtRefs) ||
@@ -93,8 +113,7 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
             !(0, isEmpty_1.default)(missingEnvLocalesInAssets) ||
             !(0, isEmpty_1.default)(missingEnvLocalesInEntries) ||
             !(0, isEmpty_1.default)(missingFieldRules) ||
-            !(0, isEmpty_1.default)(missingMultipleFields) ||
-            !(0, isEmpty_1.default)(missingRefsInComposableStudio)) {
+            !(0, isEmpty_1.default)(missingMultipleFields)) {
             if (this.currentCommand === 'cm:stacks:audit') {
                 cli_utilities_1.log.warn(this.$t(messages_1.auditMsg.FINAL_REPORT_PATH, { path: this.sharedConfig.reportPath }), this.auditContext);
             }
@@ -112,6 +131,10 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
                 (0, fs_1.rmSync)(this.sharedConfig.basePath, { recursive: true });
             }
         }
+        // Print comprehensive summary at the end
+        cli_utilities_1.CLIProgressManager.printGlobalSummary();
+        // Clear progress module setting now that audit is complete
+        (0, cli_utilities_1.clearProgressModuleSetting)();
         return (!(0, isEmpty_1.default)(missingCtRefs) ||
             !(0, isEmpty_1.default)(missingGfRefs) ||
             !(0, isEmpty_1.default)(missingEntryRefs) ||
@@ -121,8 +144,7 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
             !(0, isEmpty_1.default)(missingRefInCustomRoles) ||
             !(0, isEmpty_1.default)(missingEnvLocalesInAssets) ||
             !(0, isEmpty_1.default)(missingEnvLocalesInEntries) ||
-            !(0, isEmpty_1.default)(missingFieldRules) ||
-            !(0, isEmpty_1.default)(missingRefsInComposableStudio));
+            !(0, isEmpty_1.default)(missingFieldRules));
     }
     /**
      * The `scan` function performs an audit on different modules (content-types, global-fields, and
@@ -131,11 +153,11 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
      * and `missingEntryRefs`.
      */
     async scanAndFix() {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
         cli_utilities_1.log.debug('Starting scan and fix process', this.auditContext);
         let { ctSchema, gfSchema } = this.getCtAndGfSchema();
         cli_utilities_1.log.info(`Retrieved ${(ctSchema === null || ctSchema === void 0 ? void 0 : ctSchema.length) || 0} content types and ${(gfSchema === null || gfSchema === void 0 ? void 0 : gfSchema.length) || 0} global fields`, this.auditContext);
-        let missingCtRefs, missingGfRefs, missingEntryRefs, missingCtRefsInExtensions, missingCtRefsInWorkflow, missingSelectFeild, missingEntry = {}, missingMandatoryFields, missingTitleFields, missingRefInCustomRoles, missingEnvLocalesInAssets, missingEnvLocalesInEntries, missingFieldRules, missingMultipleFields, missingRefsInComposableStudio;
+        let missingCtRefs, missingGfRefs, missingEntryRefs, missingCtRefsInExtensions, missingCtRefsInWorkflow, missingSelectFeild, missingEntry = {}, missingMandatoryFields, missingTitleFields, missingRefInCustomRoles, missingEnvLocalesInAssets, missingEnvLocalesInEntries, missingFieldRules, missingMultipleFields;
         const constructorParam = {
             ctSchema,
             gfSchema,
@@ -144,50 +166,60 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
         };
         let dataModuleWise = await new modules_1.ModuleDataReader((0, cloneDeep_1.default)(constructorParam)).run();
         cli_utilities_1.log.debug(`Data module wise: ${JSON.stringify(dataModuleWise)}`, this.auditContext);
+        // Extract logConfig and showConsoleLogs once before the loop to reuse throughout
+        const logConfig = cli_utilities_1.configHandler.get('log') || {};
+        const showConsoleLogs = (_a = logConfig.showConsoleLogs) !== null && _a !== void 0 ? _a : true;
         for (const module of this.sharedConfig.flags.modules || this.sharedConfig.modules) {
             // Update audit context with current module
-            this.auditContext = { module: module };
+            this.auditContext = this.createAuditContext(module);
             cli_utilities_1.log.debug(`Starting audit for module: ${module}`, this.auditContext);
             cli_utilities_1.log.info(`Starting audit for module: ${module}`, this.auditContext);
-            (0, log_1.print)([
-                {
-                    bold: true,
-                    color: 'whiteBright',
-                    message: this.$t(this.messages.AUDIT_START_SPINNER, { module }),
-                },
-            ]);
+            // Only show spinner message if console logs are enabled (compatible with line-by-line logs)
+            if (showConsoleLogs) {
+                (0, log_1.print)([
+                    {
+                        bold: true,
+                        color: 'whiteBright',
+                        message: this.$t(this.messages.AUDIT_START_SPINNER, { module }),
+                    },
+                ]);
+            }
             constructorParam['moduleName'] = module;
             switch (module) {
                 case 'assets':
                     cli_utilities_1.log.info('Executing assets audit', this.auditContext);
-                    missingEnvLocalesInAssets = await new modules_1.Assets((0, cloneDeep_1.default)(constructorParam)).run();
+                    const assetsTotalCount = ((_b = dataModuleWise['assets']) === null || _b === void 0 ? void 0 : _b.Total) || 0;
+                    missingEnvLocalesInAssets = await new modules_1.Assets((0, cloneDeep_1.default)(constructorParam)).run(false, assetsTotalCount);
                     await this.prepareReport(module, missingEnvLocalesInAssets);
                     this.getAffectedData('assets', dataModuleWise['assets'], missingEnvLocalesInAssets);
                     cli_utilities_1.log.success(`Assets audit completed. Found ${Object.keys(missingEnvLocalesInAssets || {}).length} issues`, this.auditContext);
                     break;
                 case 'content-types':
                     cli_utilities_1.log.info('Executing content-types audit', this.auditContext);
-                    missingCtRefs = await new modules_1.ContentType((0, cloneDeep_1.default)(constructorParam)).run();
+                    const contentTypesTotalCount = ((_c = dataModuleWise['content-types']) === null || _c === void 0 ? void 0 : _c.Total) || 0;
+                    missingCtRefs = await new modules_1.ContentType((0, cloneDeep_1.default)(constructorParam)).run(false, contentTypesTotalCount);
                     await this.prepareReport(module, missingCtRefs);
                     this.getAffectedData('content-types', dataModuleWise['content-types'], missingCtRefs);
                     cli_utilities_1.log.success(`Content-types audit completed. Found ${Object.keys(missingCtRefs || {}).length} issues`, this.auditContext);
                     break;
                 case 'global-fields':
                     cli_utilities_1.log.info('Executing global-fields audit', this.auditContext);
-                    missingGfRefs = await new modules_1.GlobalField((0, cloneDeep_1.default)(constructorParam)).run();
+                    const globalFieldsTotalCount = ((_d = dataModuleWise['global-fields']) === null || _d === void 0 ? void 0 : _d.Total) || 0;
+                    missingGfRefs = await new modules_1.GlobalField((0, cloneDeep_1.default)(constructorParam)).run(false, globalFieldsTotalCount);
                     await this.prepareReport(module, missingGfRefs);
                     this.getAffectedData('global-fields', dataModuleWise['global-fields'], missingGfRefs);
                     cli_utilities_1.log.success(`Global-fields audit completed. Found ${Object.keys(missingGfRefs || {}).length} issues`, this.auditContext);
                     break;
                 case 'entries':
                     cli_utilities_1.log.info('Executing entries audit', this.auditContext);
-                    missingEntry = await new modules_1.Entries((0, cloneDeep_1.default)(constructorParam)).run();
-                    missingEntryRefs = (_a = missingEntry.missingEntryRefs) !== null && _a !== void 0 ? _a : {};
-                    missingSelectFeild = (_b = missingEntry.missingSelectFeild) !== null && _b !== void 0 ? _b : {};
-                    missingMandatoryFields = (_c = missingEntry.missingMandatoryFields) !== null && _c !== void 0 ? _c : {};
-                    missingTitleFields = (_d = missingEntry.missingTitleFields) !== null && _d !== void 0 ? _d : {};
-                    missingEnvLocalesInEntries = (_e = missingEntry.missingEnvLocale) !== null && _e !== void 0 ? _e : {};
-                    missingMultipleFields = (_f = missingEntry.missingMultipleFields) !== null && _f !== void 0 ? _f : {};
+                    const entriesTotalCount = ((_e = dataModuleWise['entries']) === null || _e === void 0 ? void 0 : _e.Total) || 0;
+                    missingEntry = await new modules_1.Entries((0, cloneDeep_1.default)(constructorParam)).run(entriesTotalCount);
+                    missingEntryRefs = (_f = missingEntry.missingEntryRefs) !== null && _f !== void 0 ? _f : {};
+                    missingSelectFeild = (_g = missingEntry.missingSelectFeild) !== null && _g !== void 0 ? _g : {};
+                    missingMandatoryFields = (_h = missingEntry.missingMandatoryFields) !== null && _h !== void 0 ? _h : {};
+                    missingTitleFields = (_j = missingEntry.missingTitleFields) !== null && _j !== void 0 ? _j : {};
+                    missingEnvLocalesInEntries = (_k = missingEntry.missingEnvLocale) !== null && _k !== void 0 ? _k : {};
+                    missingMultipleFields = (_l = missingEntry.missingMultipleFields) !== null && _l !== void 0 ? _l : {};
                     await this.prepareReport(module, missingEntryRefs);
                     await this.prepareReport(`Entries_Select_field`, missingSelectFeild);
                     await this.prepareReport('Entries_Mandatory_field', missingMandatoryFields);
@@ -199,26 +231,29 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
                     break;
                 case 'workflows':
                     cli_utilities_1.log.info('Executing workflows audit', this.auditContext);
+                    const workflowsTotalCount = ((_m = dataModuleWise['workflows']) === null || _m === void 0 ? void 0 : _m.Total) || 0;
                     missingCtRefsInWorkflow = await new modules_1.Workflows({
                         ctSchema,
                         moduleName: module,
                         config: this.sharedConfig,
                         fix: this.currentCommand === 'cm:stacks:audit:fix',
-                    }).run();
+                    }).run(workflowsTotalCount);
                     await this.prepareReport(module, missingCtRefsInWorkflow);
                     this.getAffectedData('workflows', dataModuleWise['workflows'], missingCtRefsInWorkflow);
                     cli_utilities_1.log.success(`Workflows audit completed. Found ${Object.keys(missingCtRefsInWorkflow || {}).length} issues`, this.auditContext);
                     break;
                 case 'extensions':
                     cli_utilities_1.log.info('Executing extensions audit', this.auditContext);
-                    missingCtRefsInExtensions = await new modules_1.Extensions((0, cloneDeep_1.default)(constructorParam)).run();
+                    const extensionsTotalCount = ((_o = dataModuleWise['extensions']) === null || _o === void 0 ? void 0 : _o.Total) || 0;
+                    missingCtRefsInExtensions = await new modules_1.Extensions((0, cloneDeep_1.default)(constructorParam)).run(extensionsTotalCount);
                     await this.prepareReport(module, missingCtRefsInExtensions);
                     this.getAffectedData('extensions', dataModuleWise['extensions'], missingCtRefsInExtensions);
                     cli_utilities_1.log.success(`Extensions audit completed. Found ${Object.keys(missingCtRefsInExtensions || {}).length} issues`, this.auditContext);
                     break;
                 case 'custom-roles':
                     cli_utilities_1.log.info('Executing custom-roles audit', this.auditContext);
-                    missingRefInCustomRoles = await new modules_1.CustomRoles((0, cloneDeep_1.default)(constructorParam)).run();
+                    const customRolesTotalCount = ((_p = dataModuleWise['custom-roles']) === null || _p === void 0 ? void 0 : _p.Total) || 0;
+                    missingRefInCustomRoles = await new modules_1.CustomRoles((0, cloneDeep_1.default)(constructorParam)).run(customRolesTotalCount);
                     await this.prepareReport(module, missingRefInCustomRoles);
                     this.getAffectedData('custom-roles', dataModuleWise['custom-roles'], missingRefInCustomRoles);
                     cli_utilities_1.log.success(`Custom-roles audit completed. Found ${Object.keys(missingRefInCustomRoles || {}).length} issues`, this.auditContext);
@@ -229,31 +264,28 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
                     const data = this.getCtAndGfSchema();
                     constructorParam.ctSchema = data.ctSchema;
                     constructorParam.gfSchema = data.gfSchema;
-                    missingFieldRules = await new modules_1.FieldRule((0, cloneDeep_1.default)(constructorParam)).run();
+                    const fieldRulesTotalCount = ((_q = dataModuleWise['content-types']) === null || _q === void 0 ? void 0 : _q.Total) || 0;
+                    missingFieldRules = await new modules_1.FieldRule((0, cloneDeep_1.default)(constructorParam)).run(fieldRulesTotalCount);
                     await this.prepareReport(module, missingFieldRules);
                     this.getAffectedData('field-rules', dataModuleWise['content-types'], missingFieldRules);
                     cli_utilities_1.log.success(`Field-rules audit completed. Found ${Object.keys(missingFieldRules || {}).length} issues`, this.auditContext);
                     break;
-                case 'composable-studio':
-                    cli_utilities_1.log.info('Executing composable-studio audit', this.auditContext);
-                    missingRefsInComposableStudio = await new modules_1.ComposableStudio((0, cloneDeep_1.default)(constructorParam)).run();
-                    await this.prepareReport(module, missingRefsInComposableStudio);
-                    this.getAffectedData('composable-studio', dataModuleWise['composable-studio'] || { Total: Object.keys(missingRefsInComposableStudio || {}).length }, missingRefsInComposableStudio);
-                    cli_utilities_1.log.success(`Composable-studio audit completed. Found ${Object.keys(missingRefsInComposableStudio || {}).length} issues`, this.auditContext);
-                    break;
             }
-            (0, log_1.print)([
-                {
-                    bold: true,
-                    color: 'whiteBright',
-                    message: this.$t(this.messages.AUDIT_START_SPINNER, { module }),
-                },
-                {
-                    bold: true,
-                    message: ' done',
-                    color: 'whiteBright',
-                },
-            ]);
+            // Only show completion message if console logs are enabled
+            if (showConsoleLogs) {
+                (0, log_1.print)([
+                    {
+                        bold: true,
+                        color: 'whiteBright',
+                        message: this.$t(this.messages.AUDIT_START_SPINNER, { module }),
+                    },
+                    {
+                        bold: true,
+                        message: ' done',
+                        color: 'whiteBright',
+                    },
+                ]);
+            }
         }
         cli_utilities_1.log.debug('Scan and fix process completed', this.auditContext);
         this.prepareReport('Summary', this.summaryDataToPrint);
@@ -272,7 +304,6 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
             missingEnvLocalesInEntries,
             missingFieldRules,
             missingMultipleFields,
-            missingRefsInComposableStudio,
         };
     }
     /**

package/lib/commands/cm/stacks/audit/fix.d.ts

@@ -2,7 +2,6 @@ import { FlagInput } from '@contentstack/cli-utilities';
 import { ConfigType } from '../../../../types';
 import { AuditBaseCommand } from '../../../../audit-base-command';
 export default class AuditFix extends AuditBaseCommand {
-    static aliases: string[];
     static description: string;
     static examples: string[];
     static flags: FlagInput;

package/lib/commands/cm/stacks/audit/fix.js

@@ -27,7 +27,6 @@ class AuditFix extends audit_base_command_1.AuditBaseCommand {
         }
     }
 }
-AuditFix.aliases = ['audit:fix', 'cm:stacks:audit:fix'];
 AuditFix.description = messages_1.auditFixMsg.AUDIT_FIX_CMD_DESCRIPTION;
 AuditFix.examples = [
     '$ <%= config.bin %> <%= command.id %> --copy-dir',

package/lib/commands/cm/stacks/audit/index.d.ts

@@ -1,7 +1,6 @@
 import { FlagInput } from '@contentstack/cli-utilities';
 import { AuditBaseCommand } from '../../../../audit-base-command';
 export default class Audit extends AuditBaseCommand {
-    static aliases: string[];
     static description: string;
     static examples: string[];
     static flags: FlagInput;

package/lib/commands/cm/stacks/audit/index.js

@@ -22,7 +22,6 @@ class Audit extends audit_base_command_1.AuditBaseCommand {
         }
     }
 }
-Audit.aliases = ['audit', 'cm:stacks:audit'];
 Audit.description = messages_1.auditMsg.AUDIT_CMD_DESCRIPTION;
 Audit.examples = [
     '$ <%= config.bin %> <%= command.id %>',

package/lib/config/index.d.ts

@@ -51,11 +51,6 @@ declare const config: {
             dirName: string;
             fileName: string;
         };
-        'composable-studio': {
-            name: string;
-            dirName: string;
-            fileName: string;
-        };
     };
     entries: {
         systemKeys: string[];

package/lib/config/index.js

@@ -13,7 +13,6 @@ const config = {
         'custom-roles',
         'assets',
         'field-rules',
-        'composable-studio',
     ],
     'fix-fields': ['reference', 'global_field', 'json:rte', 'json:extension', 'blocks', 'group', 'content_types'],
     'schema-fields-data-type': ['blocks', 'group', 'global_field'],
@@ -63,11 +62,6 @@ const config = {
             dirName: 'environments',
             fileName: 'environments.json',
         },
-        'composable-studio': {
-            name: 'composable-studio',
-            dirName: 'composable_studio',
-            fileName: 'composable_studio.json',
-        },
     },
     entries: {
         systemKeys: [
@@ -115,14 +109,13 @@ const config = {
         'selectedValue',
         'ct_uid',
         'action',
-        'Module',
-        'Total',
-        'Fixable',
-        'Non-Fixable',
-        'Fixed',
-        'Not-Fixed',
-        'Passed',
-        'issues',
+        "Module",
+        "Total",
+        "Fixable",
+        "Non-Fixable",
+        "Fixed",
+        "Not-Fixed",
+        "Passed",
     ],
     ReportTitleForEntries: {
         Entries_Select_field: 'Entries_Select_field',
@@ -130,7 +123,7 @@ const config = {
         Entries_Title_field: 'Entries_Title_field',
         Entry_Missing_Locale_and_Env: 'Entry_Missing_Locale_and_Env',
         Entry_Missing_Locale_and_Env_in_Publish_Details: 'Entry_Missing_Locale_and_Env_in_Publish_Details',
-        Entry_Multiple_Fields: 'Entry_Multiple_Fields',
+        Entry_Multiple_Fields: "Entry_Multiple_Fields"
     },
     feild_level_modules: [
         'Entries_Title_field',
@@ -139,7 +132,7 @@ const config = {
         'Entry_Missing_Locale_and_Env_in_Publish_Details',
         'field-rules',
         'Entry_Multiple_Fields',
-        'Summary',
+        'Summary'
     ],
     fixSelectField: false,
 };

package/lib/messages/index.d.ts

@@ -33,7 +33,6 @@ declare const auditMsg: {
     AUDIT_CMD_DESCRIPTION: string;
     SCAN_WF_SUCCESS_MSG: string;
     SCAN_CR_SUCCESS_MSG: string;
-    SCAN_CS_SUCCESS_MSG: string;
     SCAN_ASSET_SUCCESS_MSG: string;
     SCAN_ASSET_WARN_MSG: string;
     ENTRY_PUBLISH_DETAILS: string;

package/lib/messages/index.js

@@ -42,7 +42,6 @@ const auditMsg = {
     AUDIT_CMD_DESCRIPTION: 'Perform audits and find possible errors in the exported Contentstack data',
     SCAN_WF_SUCCESS_MSG: 'Successfully completed the scanning of workflow with UID {uid} and name {name}.',
     SCAN_CR_SUCCESS_MSG: 'Successfully completed the scanning of custom role with UID {uid} and name {name}.',
-    SCAN_CS_SUCCESS_MSG: 'Successfully completed the scanning of studio project with UID {uid} and name {name}.',
     SCAN_ASSET_SUCCESS_MSG: `Successfully completed the scanning of Asset with UID '{uid}'.`,
     SCAN_ASSET_WARN_MSG: `The locale '{locale}' or environment '{environment}' are not present for asset with uid '{uid}'`,
     ENTRY_PUBLISH_DETAILS: `Removing the publish detials for entry '{uid}' of ct '{ctuid}' in locale '{locale}' as locale '{publocale}' or environment '{environment}' does not exist`,
@@ -52,7 +51,7 @@ const auditMsg = {
     FIELD_RULE_CONDITION_ABSENT: `The operand field '{condition_field}' is not present in the schema of the content-type {ctUid}`,
     FIELD_RULE_TARGET_ABSENT: `The target field '{target_field}' is not present in the schema of the content-type {ctUid}`,
     FIELD_RULE_CONDITION_SCAN_MESSAGE: `Completed Scanning of Field Rule '{num}' condition of Content-type '{ctUid}'`,
-    FIELD_RULE_TARGET_SCAN_MESSAGE: `Completed Scanning of Field Rule '{num}' target of Content-type '{ctUid}'`,
+    FIELD_RULE_TARGET_SCAN_MESSAGE: `Completed Scanning of Field Rule '{num}' target of Content-type '{ctUid}'`
 };
 exports.auditMsg = auditMsg;
 const auditFixMsg = {

package/lib/modules/assets.d.ts

@@ -1,9 +1,9 @@
-import { ConfigType, ContentTypeStruct, CtConstructorParam, ModuleConstructorParam, EntryStruct } from '../types';
+import { ContentTypeStruct, CtConstructorParam, ModuleConstructorParam, EntryStruct } from '../types';
 import auditConfig from '../config';
-export default class Assets {
+import BaseClass from './base-class';
+export default class Assets extends BaseClass {
     protected fix: boolean;
     fileName: string;
-    config: ConfigType;
     folderPath: string;
     currentUid: string;
     currentTitle: string;
@@ -18,9 +18,11 @@ export default class Assets {
     /**
      * The `run` function checks if a folder path exists, sets the schema based on the module name,
      * iterates over the schema and looks for references, and returns a list of missing references.
+     * @param returnFixSchema - If true, returns the fixed schema instead of missing references
+     * @param totalCount - Total number of assets to process (for progress tracking)
      * @returns the `missingEnvLocales` object.
      */
-    run(returnFixSchema?: boolean): Promise<Record<string, any> | ContentTypeStruct[]>;
+    run(returnFixSchema?: boolean, totalCount?: number): Promise<Record<string, any> | ContentTypeStruct[]>;
     /**
      * @method prerequisiteData
      * The `prerequisiteData` function reads and parses JSON files to retrieve extension and marketplace

package/lib/modules/assets.js

@@ -7,15 +7,16 @@ const cli_utilities_1 = require("@contentstack/cli-utilities");
 const messages_1 = require("../messages");
 const values_1 = tslib_1.__importDefault(require("lodash/values"));
 const lodash_1 = require("lodash");
-/* The `ContentType` class is responsible for scanning content types, looking for references, and
-generating a report in JSON and CSV formats. */
-class Assets {
+const base_class_1 = tslib_1.__importDefault(require("./base-class"));
+/* The `Assets` class is responsible for scanning assets, looking for missing environment/locale references,
+and generating a report in JSON and CSV formats. */
+class Assets extends base_class_1.default {
     constructor({ fix, config, moduleName }) {
+        super({ config });
         this.locales = [];
         this.environments = [];
         this.schema = [];
         this.missingEnvLocales = {};
-        this.config = config;
         this.fix = fix !== null && fix !== void 0 ? fix : false;
         this.moduleName = this.validateModules(moduleName, this.config.moduleConfig);
         this.fileName = config.moduleConfig[this.moduleName].fileName;
@@ -30,38 +31,54 @@ class Assets {
     /**
      * The `run` function checks if a folder path exists, sets the schema based on the module name,
      * iterates over the schema and looks for references, and returns a list of missing references.
+     * @param returnFixSchema - If true, returns the fixed schema instead of missing references
+     * @param totalCount - Total number of assets to process (for progress tracking)
      * @returns the `missingEnvLocales` object.
      */
-    async run(returnFixSchema = false) {
+    async run(returnFixSchema = false, totalCount) {
         var _a;
-        cli_utilities_1.log.debug(`Starting ${this.moduleName} audit process`, this.config.auditContext);
-        cli_utilities_1.log.debug(`Data directory: ${this.folderPath}`, this.config.auditContext);
-        cli_utilities_1.log.debug(`Fix mode: ${this.fix}`, this.config.auditContext);
-        if (!(0, fs_1.existsSync)(this.folderPath)) {
-            cli_utilities_1.log.debug(`Skipping ${this.moduleName} audit - path does not exist`, this.config.auditContext);
-            cli_utilities_1.log.warn(`Skipping ${this.moduleName} audit`, this.config.auditContext);
-            cli_utilities_1.cliux.print((0, messages_1.$t)(messages_1.auditMsg.NOT_VALID_PATH, { path: this.folderPath }), { color: 'yellow' });
-            return returnFixSchema ? [] : {};
-        }
-        cli_utilities_1.log.debug('Loading prerequisite data (locales and environments)', this.config.auditContext);
-        await this.prerequisiteData();
-        cli_utilities_1.log.debug('Starting asset Reference, Environment and Locale validation', this.config.auditContext);
-        await this.lookForReference();
-        if (returnFixSchema) {
-            cli_utilities_1.log.debug(`Returning fixed schema with ${((_a = this.schema) === null || _a === void 0 ? void 0 : _a.length) || 0} items`, this.config.auditContext);
-            return this.schema;
-        }
-        cli_utilities_1.log.debug('Cleaning up empty missing environment/locale references', this.config.auditContext);
-        for (let propName in this.missingEnvLocales) {
-            if (Array.isArray(this.missingEnvLocales[propName])) {
-                if (!this.missingEnvLocales[propName].length) {
-                    delete this.missingEnvLocales[propName];
+        try {
+            cli_utilities_1.log.debug(`Starting ${this.moduleName} audit process`, this.config.auditContext);
+            cli_utilities_1.log.debug(`Data directory: ${this.folderPath}`, this.config.auditContext);
+            cli_utilities_1.log.debug(`Fix mode: ${this.fix}`, this.config.auditContext);
+            if (!(0, fs_1.existsSync)(this.folderPath)) {
+                cli_utilities_1.log.debug(`Skipping ${this.moduleName} audit - path does not exist`, this.config.auditContext);
+                cli_utilities_1.log.warn(`Skipping ${this.moduleName} audit`, this.config.auditContext);
+                cli_utilities_1.cliux.print((0, messages_1.$t)(messages_1.auditMsg.NOT_VALID_PATH, { path: this.folderPath }), { color: 'yellow' });
+                return returnFixSchema ? [] : {};
+            }
+            // Load prerequisite data with loading spinner
+            await this.withLoadingSpinner('ASSETS: Loading prerequisite data (locales and environments)...', async () => {
+                await this.prerequisiteData();
+            });
+            // Create progress manager if we have a total count
+            if (totalCount && totalCount > 0) {
+                const progress = this.createSimpleProgress(this.moduleName, totalCount);
+                progress.updateStatus('Validating asset references...');
+            }
+            cli_utilities_1.log.debug('Starting asset Reference, Environment and Locale validation', this.config.auditContext);
+            await this.lookForReference();
+            if (returnFixSchema) {
+                cli_utilities_1.log.debug(`Returning fixed schema with ${((_a = this.schema) === null || _a === void 0 ? void 0 : _a.length) || 0} items`, this.config.auditContext);
+                return this.schema;
+            }
+            cli_utilities_1.log.debug('Cleaning up empty missing environment/locale references', this.config.auditContext);
+            for (let propName in this.missingEnvLocales) {
+                if (Array.isArray(this.missingEnvLocales[propName])) {
+                    if (!this.missingEnvLocales[propName].length) {
+                        delete this.missingEnvLocales[propName];
+                    }
                 }
             }
+            const totalIssues = Object.keys(this.missingEnvLocales).length;
+            cli_utilities_1.log.debug(`${this.moduleName} audit completed. Found ${totalIssues} assets with missing environment/locale references`, this.config.auditContext);
+            this.completeProgress(true);
+            return this.missingEnvLocales;
+        }
+        catch (error) {
+            this.completeProgress(false, (error === null || error === void 0 ? void 0 : error.message) || 'Assets audit failed');
+            throw error;
         }
-        const totalIssues = Object.keys(this.missingEnvLocales).length;
-        cli_utilities_1.log.debug(`${this.moduleName} audit completed. Found ${totalIssues} assets with missing environment/locale references`, this.config.auditContext);
-        return this.missingEnvLocales;
     }
     /**
      * @method prerequisiteData
@@ -182,6 +199,10 @@ class Assets {
                 });
                 const remainingPublishDetails = ((_d = this.assets[assetUid].publish_details) === null || _d === void 0 ? void 0 : _d.length) || 0;
                 cli_utilities_1.log.debug(`Asset ${assetUid} now has ${remainingPublishDetails} valid publish details`, this.config.auditContext);
+                // Track progress for each asset processed
+                if (this.progressManager) {
+                    this.progressManager.tick(true, `asset: ${assetUid}`, null);
+                }
                 if (this.fix) {
                     cli_utilities_1.log.debug(`Fixing asset ${assetUid}`, this.config.auditContext);
                     cli_utilities_1.log.info((0, messages_1.$t)(messages_1.auditFixMsg.ASSET_FIX, { uid: assetUid }), this.config.auditContext);

package/lib/modules/base-class.d.ts

@@ -0,0 +1,24 @@
+import { CLIProgressManager } from '@contentstack/cli-utilities';
+import { ConfigType, ModuleConstructorParam } from '../types';
+export default abstract class BaseClass {
+    protected progressManager: CLIProgressManager | null;
+    protected currentModuleName: string;
+    config: ConfigType;
+    constructor({ config }: ModuleConstructorParam);
+    /**
+     * Create simple progress manager
+     */
+    protected createSimpleProgress(moduleName: string, total?: number): CLIProgressManager;
+    /**
+     * Create nested progress manager
+     */
+    protected createNestedProgress(moduleName: string): CLIProgressManager;
+    /**
+     * Complete progress manager
+     */
+    protected completeProgress(success?: boolean, error?: string): void;
+    /**
+     * Execute action with loading spinner (if console logs are disabled)
+     */
+    protected withLoadingSpinner<T>(message: string, action: () => Promise<T>): Promise<T>;
+}