@contentstack/cli-cm-branches 1.5.1 → 1.6.0

package/README.md

@@ -37,7 +37,7 @@ $ npm install -g @contentstack/cli-cm-branches
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-cm-branches/1.5.1 linux-x64 node-v22.18.0
+@contentstack/cli-cm-branches/1.6.0 linux-x64 node-v22.19.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -51,7 +51,7 @@ USAGE
 * [`csdx cm:branches`](#csdx-cmbranches)
 * [`csdx cm:branches:create`](#csdx-cmbranchescreate)
 * [`csdx cm:branches:delete [-uid <value>] [-k <value>]`](#csdx-cmbranchesdelete--uid-value--k-value)
-* [`csdx cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>]`](#csdx-cmbranchesdiff---base-branch-value---compare-branch-value--k-value--module-value)
+* [`csdx cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>] [--format <value>] [--csv-path <value>]`](#csdx-cmbranchesdiff---base-branch-value---compare-branch-value--k-value--module-value---format-value---csv-path-value)
 * [`csdx cm:branches:merge [-k <value>][--compare-branch <value>] [--no-revert] [--export-summary-path <value>] [--use-merge-summary <value>] [--comment <value>] [--base-branch <value>]`](#csdx-cmbranchesmerge--k-value--compare-branch-value---no-revert---export-summary-path-value---use-merge-summary-value---comment-value---base-branch-value)
 
 ## `csdx cm:branches`
@@ -136,18 +136,21 @@ EXAMPLES
 
 _See code: [src/commands/cm/branches/delete.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-export/src/commands/cm/branches/delete.ts)_
 
-## `csdx cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>]`
+## `csdx cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>] [--format <value>] [--csv-path <value>]`
 
 Differences between two branches
 
 ```
 USAGE
-  $ csdx cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>]
+  $ csdx cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>] [--format
+    <value>] [--csv-path <value>]
 
 FLAGS
   -k, --stack-api-key=<value>   [optional] Provide the stack API key to show the difference between branches.
       --base-branch=<value>     [optional] Base branch (Target branch).
       --compare-branch=<value>  [optional] Compare branch (Source branch).
+      --csv-path=<value>        [optional] Custom path for CSV output file. If not provided, will use the current
+                                working directory.
       --format=<option>         [default: compact-text] [default: compact-text] [optional] Type of flags to show the
                                 difference between two branches. <options: compact-text, detailed-text>
                                 <options: compact-text|detailed-text>
@@ -181,6 +184,10 @@ EXAMPLES
   $ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types"
 
   $ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types" --format "detailed-text"
+
+  $ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types" --format "compact-text"
+
+  $ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types" --format "detailed-text" --csv-path "./reports/diff-report.csv"
 ```
 
 _See code: [src/commands/cm/branches/diff.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-export/src/commands/cm/branches/diff.ts)_

package/lib/branch/diff-handler.js

@@ -7,6 +7,7 @@ const cli_utilities_1 = require("@contentstack/cli-utilities");
 const utils_1 = require("../utils");
 const interactive_1 = require("../utils/interactive");
 const branch_diff_utility_1 = require("../utils/branch-diff-utility");
+const csv_utility_1 = require("../utils/csv-utility");
 class BranchDiffHandler {
     constructor(params) {
         this.options = params;
@@ -40,6 +41,9 @@ class BranchDiffHandler {
         if (!this.options.module) {
             this.options.module = await (0, interactive_1.selectModule)();
         }
+        if (this.options.format === 'detailed-text' && !this.options.csvPath) {
+            this.options.csvPath = process.cwd();
+        }
         if (baseBranch) {
             cli_utilities_1.cliux.print(`\nBase branch: ${baseBranch}`, { color: 'grey' });
         }
@@ -109,6 +113,7 @@ class BranchDiffHandler {
             const verboseRes = await (0, branch_diff_utility_1.parseVerbose)(branchDiffData, payload);
             cli_utilities_1.cliux.loaderV2('', spinner);
             (0, branch_diff_utility_1.printVerboseTextView)(verboseRes);
+            (0, csv_utility_1.exportCSVReport)(payload.module, verboseRes, this.options.csvPath);
         }
     }
 }

package/lib/commands/cm/branches/diff.js

@@ -14,7 +14,8 @@ class BranchDiffCommand extends cli_command_1.Command {
                 compareBranch: branchDiffFlags['compare-branch'],
                 module: branchDiffFlags.module,
                 format: branchDiffFlags.format,
-                host: this.cmaHost
+                csvPath: branchDiffFlags['csv-path'],
+                host: this.cmaHost,
             };
             if (!(0, cli_utilities_1.isAuthenticated)()) {
                 const err = { errorMessage: 'You are not logged in. Please login with command $ csdx auth:login' };
@@ -43,8 +44,10 @@ BranchDiffCommand.examples = [
     'csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --module "content-types"',
     'csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types"',
     'csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types" --format "detailed-text"',
+    'csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types" --format "compact-text"',
+    'csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types" --format "detailed-text" --csv-path "./reports/diff-report.csv"',
 ];
-BranchDiffCommand.usage = 'cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>]';
+BranchDiffCommand.usage = 'cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>] [--format <value>] [--csv-path <value>]';
 BranchDiffCommand.flags = {
     'base-branch': cli_utilities_1.flags.string({
         description: '[optional] Base branch (Target branch).',
@@ -66,5 +69,8 @@ BranchDiffCommand.flags = {
         options: ['compact-text', 'detailed-text'],
         description: '[default: compact-text] [optional] Type of flags to show the difference between two branches. <options: compact-text, detailed-text>',
     }),
+    'csv-path': cli_utilities_1.flags.string({
+        description: '[optional] Custom path for CSV output file. If not provided, will use the current working directory.',
+    }),
 };
 BranchDiffCommand.aliases = []; // Note: alternative usage if any

package/lib/interfaces/index.js

@@ -1,2 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CSV_HEADER = exports.FIELD_TYPES = void 0;
+exports.FIELD_TYPES = ['modified', 'added', 'deleted'];
+exports.CSV_HEADER = 'Sr No,Content Type Name,Field Name,Field Path,Operation,Source Branch Value,Target Branch Value\n';

package/lib/utils/branch-diff-utility.js

@@ -12,6 +12,7 @@ const find_1 = tslib_1.__importDefault(require("lodash/find"));
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const isArray_1 = tslib_1.__importDefault(require("lodash/isArray"));
 const just_diff_1 = require("just-diff");
+const csv_utility_1 = require("./csv-utility");
 const config_1 = tslib_1.__importDefault(require("../config"));
 /**
  * Fetch differences between two branches
@@ -229,6 +230,7 @@ async function parseVerbose(branchesDiffData, payload) {
         added: added,
         deleted: deleted,
     };
+    verboseRes.csvData = (0, csv_utility_1.generateCSVDataFromVerbose)(verboseRes);
     return verboseRes;
 }
 exports.parseVerbose = parseVerbose;
@@ -270,13 +272,13 @@ exports.prepareBranchVerboseRes = prepareBranchVerboseRes;
  * @param params
  */
 async function baseAndCompareBranchDiff(params) {
-    const { baseBranchFieldExists, compareBranchFieldExists, diffData } = params;
+    const { baseBranchFieldExists, compareBranchFieldExists } = params;
     if (baseBranchFieldExists && compareBranchFieldExists) {
         await prepareModifiedDiff(params);
     }
     else if (baseBranchFieldExists && !compareBranchFieldExists) {
         let displayName = baseBranchFieldExists === null || baseBranchFieldExists === void 0 ? void 0 : baseBranchFieldExists.display_name;
-        let path = baseBranchFieldExists === null || baseBranchFieldExists === void 0 ? void 0 : baseBranchFieldExists.uid;
+        let path = (baseBranchFieldExists === null || baseBranchFieldExists === void 0 ? void 0 : baseBranchFieldExists.path) || (baseBranchFieldExists === null || baseBranchFieldExists === void 0 ? void 0 : baseBranchFieldExists.uid);
         let field = baseBranchFieldExists === null || baseBranchFieldExists === void 0 ? void 0 : baseBranchFieldExists.data_type;
         if (baseBranchFieldExists.path === 'description') {
             displayName = 'Description';
@@ -292,7 +294,7 @@ async function baseAndCompareBranchDiff(params) {
     }
     else if (!baseBranchFieldExists && compareBranchFieldExists) {
         let displayName = compareBranchFieldExists === null || compareBranchFieldExists === void 0 ? void 0 : compareBranchFieldExists.display_name;
-        let path = compareBranchFieldExists === null || compareBranchFieldExists === void 0 ? void 0 : compareBranchFieldExists.uid;
+        let path = (compareBranchFieldExists === null || compareBranchFieldExists === void 0 ? void 0 : compareBranchFieldExists.path) || (compareBranchFieldExists === null || compareBranchFieldExists === void 0 ? void 0 : compareBranchFieldExists.uid);
         let field = compareBranchFieldExists === null || compareBranchFieldExists === void 0 ? void 0 : compareBranchFieldExists.data_type;
         if (compareBranchFieldExists.path === 'description') {
             displayName = 'Description';
@@ -313,59 +315,72 @@ async function prepareModifiedDiff(params) {
         compareBranchFieldExists.path === 'title' ||
         compareBranchFieldExists.path === 'options.singleton') {
         let displayName;
+        let changeDetails = '';
         if (baseBranchFieldExists.path === 'options.singleton') {
             if (compareBranchFieldExists.value) {
                 displayName = 'Single';
+                changeDetails = `Changed from Multiple to Single`;
             }
             else {
                 displayName = 'Multiple';
+                changeDetails = `Changed from Single to Multiple`;
             }
         }
         else if (baseBranchFieldExists.path === 'description') {
             displayName = 'Description';
+            const oldDesc = baseBranchFieldExists.value || 'undefined';
+            const newDesc = compareBranchFieldExists.value || 'undefined';
+            changeDetails = `Changed from "${oldDesc}" to "${newDesc}"`;
         }
         else if (baseBranchFieldExists.path === 'title') {
             displayName = 'Display Name';
+            const oldTitle = baseBranchFieldExists.value || 'undefined';
+            const newTitle = compareBranchFieldExists.value || 'undefined';
+            changeDetails = `Changed from "${oldTitle}" to "${newTitle}"`;
         }
         params.listOfModifiedFields.push({
             path: '',
             displayName: displayName,
             uid: baseBranchFieldExists.path,
             field: 'changed',
+            changeDetails,
+            oldValue: baseBranchFieldExists.value,
+            newValue: compareBranchFieldExists.value,
         });
     }
     else {
-        if ((baseBranchFieldExists === null || baseBranchFieldExists === void 0 ? void 0 : baseBranchFieldExists.display_name) && (compareBranchFieldExists === null || compareBranchFieldExists === void 0 ? void 0 : compareBranchFieldExists.display_name)) {
-            const { modified, deleted, added } = await deepDiff(baseBranchFieldExists, compareBranchFieldExists);
-            for (let field of Object.values(added)) {
-                if (field) {
-                    params.listOfAddedFields.push({
-                        path: field['path'],
-                        displayName: field['displayName'],
-                        uid: field['uid'],
-                        field: field['fieldType'],
-                    });
-                }
+        const fieldDisplayName = (0, csv_utility_1.getFieldDisplayName)(compareBranchFieldExists);
+        const { modified, deleted, added } = await deepDiff(baseBranchFieldExists, compareBranchFieldExists);
+        for (let field of Object.values(added)) {
+            if (field) {
+                params.listOfAddedFields.push({
+                    path: field['path'],
+                    displayName: (0, csv_utility_1.getFieldDisplayName)(field),
+                    uid: field['uid'],
+                    field: field['fieldType'] || field['data_type'] || 'field',
+                });
             }
-            for (let field of Object.values(deleted)) {
-                if (field) {
-                    params.listOfDeletedFields.push({
-                        path: field['path'],
-                        displayName: field['displayName'],
-                        uid: field['uid'],
-                        field: field['fieldType'],
-                    });
-                }
+        }
+        for (let field of Object.values(deleted)) {
+            if (field) {
+                params.listOfDeletedFields.push({
+                    path: field['path'],
+                    displayName: (0, csv_utility_1.getFieldDisplayName)(field),
+                    uid: field['uid'],
+                    field: field['fieldType'] || field['data_type'] || 'field',
+                });
             }
-            for (let field of Object.values(modified)) {
-                if (field) {
-                    params.listOfModifiedFields.push({
-                        path: field['path'],
-                        displayName: field['displayName'],
-                        uid: field['uid'],
-                        field: `${field['fieldType']} field`,
-                    });
-                }
+        }
+        for (let field of Object.values(modified)) {
+            if (field) {
+                params.listOfModifiedFields.push({
+                    path: field['path'],
+                    displayName: field['displayName'] || field['display_name'] || fieldDisplayName,
+                    uid: field['uid'] || (compareBranchFieldExists === null || compareBranchFieldExists === void 0 ? void 0 : compareBranchFieldExists.uid),
+                    field: `${field['fieldType'] || field['data_type'] || (compareBranchFieldExists === null || compareBranchFieldExists === void 0 ? void 0 : compareBranchFieldExists.data_type) || 'field'} field`,
+                    propertyChanges: field['propertyChanges'],
+                    changeCount: field['changeCount'],
+                });
             }
         }
     }
@@ -449,7 +464,14 @@ async function deepDiff(baseObj, compareObj) {
         const { schema: compareSchema, path: comparePath } = compareObj, restCompareObj = tslib_1.__rest(compareObj, ["schema", "path"]);
         const currentPath = buildPath(path, baseObj['uid']);
         if (restBaseObj['uid'] === restCompareObj['uid']) {
-            prepareModifiedField({ restBaseObj, restCompareObj, currentPath, changes });
+            prepareModifiedField({
+                restBaseObj,
+                restCompareObj,
+                currentPath,
+                changes,
+                fullFieldContext: baseObj,
+                parentContext: baseObj,
+            });
         }
         //case1:- base & compare schema both exists
         if ((baseSchema === null || baseSchema === void 0 ? void 0 : baseSchema.length) && (compareSchema === null || compareSchema === void 0 ? void 0 : compareSchema.length) && (0, isArray_1.default)(baseSchema) && (0, isArray_1.default)(compareSchema)) {
@@ -498,6 +520,8 @@ function prepareAddedField(params) {
             uid: compareField['uid'],
             displayName: compareField['display_name'],
             fieldType: compareField['data_type'],
+            oldValue: undefined,
+            newValue: compareField,
         };
         changes.added[path] = obj;
     }
@@ -515,14 +539,31 @@ function prepareDeletedField(params) {
     }
 }
 function prepareModifiedField(params) {
-    const { restBaseObj, restCompareObj, currentPath, changes } = params;
+    const { restBaseObj, restCompareObj, currentPath, changes, fullFieldContext } = params;
     const differences = (0, just_diff_1.diff)(restBaseObj, restCompareObj);
     if (differences.length) {
         const modifiedField = {
             path: currentPath,
-            uid: restCompareObj['uid'],
-            displayName: restCompareObj['display_name'],
-            fieldType: restCompareObj['data_type'],
+            uid: fullFieldContext['uid'] || restCompareObj['uid'],
+            displayName: (0, csv_utility_1.getFieldDisplayName)(fullFieldContext) || (0, csv_utility_1.getFieldDisplayName)(restCompareObj) || 'Field',
+            fieldType: restCompareObj['data_type'] || 'field',
+            propertyChanges: differences.map((diff) => {
+                let oldValue = 'from' in diff ? diff.from : undefined;
+                let newValue = diff.value;
+                if (!('from' in diff) && fullFieldContext && diff.path && diff.path.length > 0) {
+                    const contextValue = (0, csv_utility_1.extractValueFromPath)(fullFieldContext, diff.path);
+                    if (contextValue !== undefined) {
+                        oldValue = contextValue;
+                    }
+                }
+                return {
+                    property: diff.path.join('.'),
+                    changeType: diff.op === 'add' ? 'added' : diff.op === 'remove' ? 'deleted' : 'modified',
+                    oldValue: oldValue,
+                    newValue: newValue,
+                };
+            }),
+            changeCount: differences.length,
         };
         if (!changes.modified[currentPath])
             changes.modified[currentPath] = modifiedField;

package/lib/utils/csv-utility.js

@@ -0,0 +1,307 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exportCSVReport = exports.generateCSVDataFromVerbose = exports.generateFieldPath = exports.extractValueFromPath = exports.formatValue = exports.getFieldDisplayName = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const interfaces_1 = require("../interfaces");
+/**
+ * Get display name for a field with special handling for system fields
+ * @param field - The field object
+ * @returns {string} Display name for the field
+ */
+function getFieldDisplayName(field) {
+    let fieldName = (field === null || field === void 0 ? void 0 : field.displayName) || (field === null || field === void 0 ? void 0 : field.display_name) || (field === null || field === void 0 ? void 0 : field.title) || (field === null || field === void 0 ? void 0 : field.uid);
+    // Special handling for field_rules
+    if (!fieldName && (field === null || field === void 0 ? void 0 : field.path) === 'field_rules') {
+        fieldName = 'Field Rules';
+    }
+    else if (!fieldName) {
+        fieldName = 'Unknown Field';
+    }
+    return fieldName;
+}
+exports.getFieldDisplayName = getFieldDisplayName;
+/**
+ * Format values for CSV display
+ * @param value - The value to format
+ * @returns {string} Formatted string value
+ */
+function formatValue(value) {
+    if (value === null || value === undefined) {
+        return 'N/A';
+    }
+    if (typeof value === 'string') {
+        if (value === '')
+            return 'N/A';
+        return value;
+    }
+    if (typeof value === 'number' || typeof value === 'boolean') {
+        return String(value);
+    }
+    if (Array.isArray(value)) {
+        return value.length > 0 ? value.join(', ') : 'Empty Array';
+    }
+    if (typeof value === 'object' && value !== null) {
+        // Priority order for extracting meaningful values
+        const priorityKeys = ['title', 'display_name', 'uid', 'value', 'key'];
+        for (const key of priorityKeys) {
+            if ((value === null || value === void 0 ? void 0 : value[key]) !== undefined && (value === null || value === void 0 ? void 0 : value[key]) !== '') {
+                return value[key];
+            }
+        }
+        if (value === null || value === void 0 ? void 0 : value.data_type) {
+            ``;
+            const simpleFieldTypes = ['text', 'boolean', 'number'];
+            if (simpleFieldTypes.includes(value.data_type) && (value === null || value === void 0 ? void 0 : value.default_value) !== undefined) {
+                return value.default_value;
+            }
+            if (value.data_type === 'field' || (value === null || value === void 0 ? void 0 : value.path)) {
+                return `${value.data_type} field`;
+            }
+            return `${value.data_type} field`;
+        }
+        // Special handling for field rules objects
+        if ((value === null || value === void 0 ? void 0 : value.path) && !(value === null || value === void 0 ? void 0 : value.data_type)) {
+            return value.path;
+        }
+        // For enum choices or other structured objects, try to extract meaningful info
+        const metadataKeys = ['mandatory', 'multiple', 'non_localizable'];
+        for (const key of metadataKeys) {
+            if ((value === null || value === void 0 ? void 0 : value[key]) !== undefined)
+                return `${key}: ${value[key]}`;
+        }
+        // If no meaningful properties found, stringify the object with char limit
+        const objectString = JSON.stringify(value);
+        if (objectString.length <= 200) {
+            return objectString;
+        }
+        else {
+            return `${objectString.substring(0, 200)}... (Please check the field as the char limit has been reached)`;
+        }
+    }
+    return String(value);
+}
+exports.formatValue = formatValue;
+/**
+ * Extract a value from an object using a path array
+ * @param obj - The object to traverse
+ * @param path - Array of path segments
+ * @returns The value at the path, or undefined if not found
+ */
+function extractValueFromPath(obj, path) {
+    if (!obj || !path || path.length === 0)
+        return undefined;
+    try {
+        let value = obj;
+        for (const pathSegment of path) {
+            if (value && typeof value === 'object') {
+                value = value[pathSegment];
+            }
+            else {
+                return undefined;
+            }
+        }
+        return value;
+    }
+    catch (error) {
+        cli_utilities_1.log.debug(`Failed to extract value from path ${path.join('.')}:`, error);
+        return undefined;
+    }
+}
+exports.extractValueFromPath = extractValueFromPath;
+/**
+ * Generate a descriptive field path showing the hierarchical location
+ * @param field - The field object containing path information
+ * @param contentTypeName - The name of the content type (for root-level context)
+ * @returns {string} Descriptive field path in readable format
+ */
+function generateFieldPath(field, contentTypeName) {
+    if (!(field === null || field === void 0 ? void 0 : field.path) || field.path === 'N/A') {
+        return 'N/A';
+    }
+    let readablePath = contentTypeName || '';
+    const fieldPath = field.path;
+    if (fieldPath.includes('.')) {
+        const pathParts = fieldPath.split('.');
+        const readableParts = pathParts.map(part => {
+            if (part === 'schema')
+                return '';
+            return part;
+        }).filter(part => part !== '');
+        if (readableParts.length > 0) {
+            readablePath += readablePath ? ' → ' : '';
+            readablePath += readableParts.join(' → ');
+        }
+    }
+    else if (fieldPath.includes('[') && fieldPath.includes(']')) {
+        if (readablePath) {
+            readablePath += ' → ';
+        }
+        const displayName = typeof (field === null || field === void 0 ? void 0 : field.displayName) === 'string' ? field.displayName : '';
+        const uid = typeof (field === null || field === void 0 ? void 0 : field.uid) === 'string' ? field.uid : '';
+        readablePath += displayName || uid || fieldPath;
+    }
+    else {
+        if (readablePath) {
+            readablePath += ' → ';
+        }
+        readablePath += fieldPath;
+    }
+    return readablePath || 'N/A';
+}
+exports.generateFieldPath = generateFieldPath;
+/**
+ * Add content type rows to CSV data
+ * @param csvRows - The CSV rows array to add to
+ * @param items - Array of content type items
+ * @param operation - The operation type ('added' or 'deleted')
+ * @param getSrNo - Function to get the next serial number
+ */
+function addContentTypeRows(csvRows, items, operation, getSrNo) {
+    if (!(items === null || items === void 0 ? void 0 : items.length))
+        return;
+    for (const item of items) {
+        const contentTypeName = (item === null || item === void 0 ? void 0 : item.title) || (item === null || item === void 0 ? void 0 : item.uid) || 'Unknown';
+        addCSVRow(csvRows, {
+            srNo: getSrNo(),
+            contentTypeName,
+            fieldName: 'Content Type',
+            fieldType: operation,
+            sourceValue: 'N/A',
+            targetValue: 'N/A'
+        });
+    }
+}
+/**
+ * Generate CSV data from verbose results
+ * @param verboseRes - The verbose results containing all diff data
+ * @returns {CSVRow[]} Array of CSV rows
+ */
+function generateCSVDataFromVerbose(verboseRes) {
+    var _a, _b, _c;
+    const csvRows = [];
+    let srNo = 1;
+    if ((_a = verboseRes.modified) === null || _a === void 0 ? void 0 : _a.length) {
+        for (const moduleDetail of verboseRes.modified) {
+            const contentTypeName = ((_b = moduleDetail === null || moduleDetail === void 0 ? void 0 : moduleDetail.moduleDetails) === null || _b === void 0 ? void 0 : _b.title) || ((_c = moduleDetail === null || moduleDetail === void 0 ? void 0 : moduleDetail.moduleDetails) === null || _c === void 0 ? void 0 : _c.uid) || 'Unknown';
+            if (moduleDetail.modifiedFields) {
+                addFieldChangesToCSV(csvRows, {
+                    contentTypeName,
+                    modifiedFields: moduleDetail.modifiedFields,
+                    operation: 'modified',
+                    startSrNo: srNo
+                });
+                srNo += getFieldCount(moduleDetail.modifiedFields);
+            }
+        }
+    }
+    addContentTypeRows(csvRows, verboseRes.added, 'added', () => srNo++);
+    addContentTypeRows(csvRows, verboseRes.deleted, 'deleted', () => srNo++);
+    return csvRows;
+}
+exports.generateCSVDataFromVerbose = generateCSVDataFromVerbose;
+/**
+ * Add a CSV row with common properties
+ * @param csvRows - Array of CSV rows to add to
+ * @param params - Object containing CSV row parameters
+ */
+function addCSVRow(csvRows, params) {
+    csvRows.push({
+        srNo: params.srNo,
+        contentTypeName: params.contentTypeName,
+        fieldName: params.fieldName,
+        fieldPath: 'N/A',
+        operation: params.fieldType,
+        sourceBranchValue: params.sourceValue,
+        targetBranchValue: params.targetValue,
+    });
+}
+/**
+ * Add field changes to CSV rows
+ * @param csvRows - Array of CSV rows to add to
+ * @param params - Object containing field changes parameters
+ */
+function addFieldChangesToCSV(csvRows, params) {
+    const fieldTypes = interfaces_1.FIELD_TYPES;
+    let srNo = params.startSrNo;
+    fieldTypes.forEach(fieldType => {
+        const fields = params.modifiedFields[fieldType];
+        if (!fields)
+            return;
+        fields.forEach(field => {
+            var _a;
+            const fieldName = getFieldDisplayName(field);
+            if (((_a = field.propertyChanges) === null || _a === void 0 ? void 0 : _a.length) > 0) {
+                field.propertyChanges.forEach(propertyChange => {
+                    addCSVRow(csvRows, {
+                        srNo: srNo++,
+                        contentTypeName: params.contentTypeName,
+                        fieldName,
+                        fieldType,
+                        sourceValue: formatValue(propertyChange.newValue),
+                        targetValue: formatValue(propertyChange.oldValue)
+                    });
+                });
+            }
+            else {
+                addCSVRow(csvRows, {
+                    srNo: srNo++,
+                    contentTypeName: params.contentTypeName,
+                    fieldName,
+                    fieldType,
+                    sourceValue: fieldType === 'added' ? 'N/A' : formatValue(field),
+                    targetValue: fieldType === 'deleted' ? 'N/A' : formatValue(field)
+                });
+            }
+        });
+    });
+}
+/**
+ * Get total field count for serial number calculation
+ * @param modifiedFields - Field changes data
+ * @returns {number} Total number of fields
+ */
+function getFieldCount(modifiedFields) {
+    let count = 0;
+    const fieldTypes = interfaces_1.FIELD_TYPES;
+    fieldTypes.forEach(fieldType => {
+        const fields = modifiedFields[fieldType];
+        if (fields) {
+            fields.forEach(field => {
+                var _a;
+                if (((_a = field.propertyChanges) === null || _a === void 0 ? void 0 : _a.length) > 0) {
+                    count += field.propertyChanges.length;
+                }
+                else {
+                    count += 1;
+                }
+            });
+        }
+    });
+    return count;
+}
+/**
+ * Export CSV report to file using pre-processed data
+ * @param moduleName - The module name (content-types, global-fields, etc.)
+ * @param diffData - The diff data from branch comparison (must include csvData)
+ * @param customPath - Optional custom path for CSV output
+ */
+function exportCSVReport(moduleName, diffData, customPath) {
+    let csvPath;
+    if (customPath) {
+        csvPath = (0, path_1.join)(customPath, `${(0, cli_utilities_1.sanitizePath)(moduleName)}-diff.csv`);
+        if (!(0, fs_1.existsSync)(customPath)) {
+            (0, fs_1.mkdirSync)(customPath, { recursive: true });
+        }
+    }
+    else {
+        csvPath = (0, path_1.join)(process.cwd(), `${(0, cli_utilities_1.sanitizePath)(moduleName)}-diff.csv`);
+    }
+    const csvRows = diffData.csvData || [];
+    const csvHeader = interfaces_1.CSV_HEADER;
+    const csvContent = csvRows.map(row => `${row.srNo},"${row.contentTypeName}","${row.fieldName}","${row.fieldPath}","${row.operation}","${row.sourceBranchValue}","${row.targetBranchValue}"`).join('\n');
+    (0, fs_1.writeFileSync)(csvPath, csvHeader + csvContent);
+    cli_utilities_1.cliux.print(`CSV report generated at: ${csvPath}`, { color: 'green' });
+}
+exports.exportCSVReport = exportCSVReport;

package/oclif.manifest.json

@@ -124,7 +124,9 @@
         "csdx cm:branches:diff --stack-api-key \"bltxxxxxxxx\" --base-branch \"main\" --compare-branch \"develop\"",
         "csdx cm:branches:diff --stack-api-key \"bltxxxxxxxx\" --base-branch \"main\" --module \"content-types\"",
         "csdx cm:branches:diff --stack-api-key \"bltxxxxxxxx\" --base-branch \"main\" --compare-branch \"develop\" --module \"content-types\"",
-        "csdx cm:branches:diff --stack-api-key \"bltxxxxxxxx\" --base-branch \"main\" --compare-branch \"develop\" --module \"content-types\" --format \"detailed-text\""
+        "csdx cm:branches:diff --stack-api-key \"bltxxxxxxxx\" --base-branch \"main\" --compare-branch \"develop\" --module \"content-types\" --format \"detailed-text\"",
+        "csdx cm:branches:diff --stack-api-key \"bltxxxxxxxx\" --base-branch \"main\" --compare-branch \"develop\" --module \"content-types\" --format \"compact-text\"",
+        "csdx cm:branches:diff --stack-api-key \"bltxxxxxxxx\" --base-branch \"main\" --compare-branch \"develop\" --module \"content-types\" --format \"detailed-text\" --csv-path \"./reports/diff-report.csv\""
       ],
       "flags": {
         "base-branch": {
@@ -172,6 +174,13 @@
             "detailed-text"
           ],
           "type": "option"
+        },
+        "csv-path": {
+          "description": "[optional] Custom path for CSV output file. If not provided, will use the current working directory.",
+          "name": "csv-path",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
@@ -181,7 +190,7 @@
       "pluginName": "@contentstack/cli-cm-branches",
       "pluginType": "core",
       "strict": true,
-      "usage": "cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>]",
+      "usage": "cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>] [--format <value>] [--csv-path <value>]",
       "isESM": false,
       "relativePath": [
         "lib",
@@ -355,5 +364,5 @@
       ]
     }
   },
-  "version": "1.5.1"
+  "version": "1.6.0"
 }

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@contentstack/cli-cm-branches",
   "description": "Contentstack CLI plugin to do branches operations",
-  "version": "1.5.1",
+  "version": "1.6.0",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-command": "~1.6.0",
+    "@contentstack/cli-command": "~1.6.1",
     "@oclif/core": "^4.3.0",
     "@oclif/plugin-help": "^6.2.28",
-    "@contentstack/cli-utilities": "~1.13.1",
+    "@contentstack/cli-utilities": "~1.14.1",
     "chalk": "^4.1.2",
     "just-diff": "^6.0.2",
     "lodash": "^4.17.21"