@contentstack/cli-audit 1.0.0 → 1.2.1

package/README.md

@@ -2,6 +2,7 @@
 <!-- Insert Audit version here -->
 
 # @contentstack/cli-audit
+
 Audit plugin
 
 ## How to install this plugin
@@ -12,15 +13,13 @@ $ csdx plugins:install @contentstack/cli-audit
 
 ## How to use this plugin
 
-This plugin requires you to be authenticated using [csdx auth:login](https://www.contentstack.com/docs/developers/cli/authenticate-with-the-cli/).
-
 <!-- usage -->
 ```sh-session
 $ npm install -g @contentstack/cli-audit
 $ csdx COMMAND
 running command...
 $ csdx (--version|-v)
-@contentstack/cli-audit/1.0.0 linux-x64 node-v18.18.0
+@contentstack/cli-audit/1.2.1 linux-x64 node-v18.18.2
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -29,10 +28,12 @@ USAGE
 <!-- usagestop -->
 
 # Commands
+
 <!-- commands -->
-* [`csdx cm::stacks:audit:fix`](#csdx-cmstacksauditfix)
+* [`csdx audit`](#csdx-audit)
+* [`csdx audit:fix`](#csdx-auditfix)
 * [`csdx cm:stacks:audit`](#csdx-cmstacksaudit)
-* [`csdx cm:stacks:audit:fix`](#csdx-cmstacksauditfix-1)
+* [`csdx cm:stacks:audit:fix`](#csdx-cmstacksauditfix)
 * [`csdx help [COMMANDS]`](#csdx-help-commands)
 * [`csdx plugins`](#csdx-plugins)
 * [`csdx plugins:install PLUGIN...`](#csdx-pluginsinstall-plugin)
@@ -44,29 +45,89 @@ USAGE
 * [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin-2)
 * [`csdx plugins:update`](#csdx-pluginsupdate)
 
-## `csdx cm::stacks:audit:fix`
+## `csdx audit`
 
-Audit fix command
+Perform audits and find possible errors in the exported Contentstack data
 
 ```
 USAGE
-  $ csdx cm::stacks:audit:fix [-c <value>] [-d <value>]
+  $ csdx audit [-c <value>] [-d <value>] [--report-path <value>] [--modules
+    content-types|global-fields|entries] [--columns <value> | ] [--sort <value>] [--filter <value>] [--csv |
+    --no-truncate]
 
 FLAGS
-  -c, --config=<value>    Path of the external config.
-  -d, --data-dir=<value>  Path where the data is stored.
+  -c, --config=<value>    Path of the external config
+  -d, --data-dir=<value>  Path where the data is stored
+  --columns=<value>       only show provided columns (comma-separated)
+  --csv                   output is csv format [alias: --output=csv]
+  --filter=<value>        filter property by partial string matching, ex: name=foo
+  --modules=<option>...   Provide the list of modules to be audited
+                          <options: content-types|global-fields|entries>
+  --no-truncate           do not truncate output to fit screen
+  --report-path=<value>   Path to store the audit reports
+  --sort=<value>          property to sort by (prepend '-' for descending)
 
 DESCRIPTION
-  Audit fix command
+  Perform audits and find possible errors in the exported Contentstack data
 
 ALIASES
-  $ csdx cm::stacks:audit:fix
+  $ csdx audit
+  $ csdx cm:stacks:audit
 
 EXAMPLES
-  $ csdx cm::stacks:audit:fix
+  $ csdx audit
+
+  $ csdx audit --report-path=<path>
+
+  $ csdx audit --report-path=<path> --csv
+
+  $ csdx audit --report-path=<path> --filter="name=<filter-value>"
+
+  $ csdx audit --report-path=<path> --modules=content-types --filter="name="<filter-value>"
 ```
 
-_See code: [src/commands/cm/stacks/audit/fix.ts](https://github.com/contentstack/audit/blob/main/packages/contentstack-audit/src/commands/cm/stacks/audit/fix.ts)_
+## `csdx audit:fix`
+
+Perform audits and fix possible errors in the exported Contentstack data.
+
+```
+USAGE
+  $ csdx audit:fix [-c <value>] [-d <value>] [--report-path <value>] [--modules
+    content-types|global-fields|entries] [--copy-path <value> --copy-dir] [--columns <value> | ] [--sort <value>]
+    [--filter <value>] [--csv | --no-truncate]
+
+FLAGS
+  -c, --config=<value>    Path of the external config
+  -d, --data-dir=<value>  Path where the data is stored
+  --columns=<value>       only show provided columns (comma-separated)
+  --copy-dir              Create backup from the original data.
+  --copy-path=<value>     Provide the path to backup the copied data
+  --csv                   output is csv format [alias: --output=csv]
+  --filter=<value>        filter property by partial string matching, ex: name=foo
+  --modules=<option>...   Provide the list of modules to be audited
+                          <options: content-types|global-fields|entries>
+  --no-truncate           do not truncate output to fit screen
+  --report-path=<value>   Path to store the audit reports
+  --sort=<value>          property to sort by (prepend '-' for descending)
+
+DESCRIPTION
+  Perform audits and fix possible errors in the exported Contentstack data.
+
+ALIASES
+  $ csdx audit:fix
+  $ csdx cm:stacks:audit:fix
+
+EXAMPLES
+  $ csdx audit:fix --copy-dir
+
+  $ csdx audit:fix --report-path=<path> --copy-dir
+
+  $ csdx audit:fix --report-path=<path> --copy-dir --csv
+
+  $ csdx audit:fix --report-path=<path> --filter="name=<filter-value>"
+
+  $ csdx audit:fix --report-path=<path> --modules=content-types --filter="name="<filter-value>" --copy-dir --copy-path=<path>
+```
 
 ## `csdx cm:stacks:audit`
 
@@ -79,21 +140,22 @@ USAGE
     --no-truncate]
 
 FLAGS
-  -c, --config=<value>    Path of the external config.
-  -d, --data-dir=<value>  Path where the data is stored.
+  -c, --config=<value>    Path of the external config
+  -d, --data-dir=<value>  Path where the data is stored
   --columns=<value>       only show provided columns (comma-separated)
   --csv                   output is csv format [alias: --output=csv]
   --filter=<value>        filter property by partial string matching, ex: name=foo
-  --modules=<option>...   Provide the list of modules to be audited.
+  --modules=<option>...   Provide the list of modules to be audited
                           <options: content-types|global-fields|entries>
   --no-truncate           do not truncate output to fit screen
-  --report-path=<value>   Path to store the audit reports.
+  --report-path=<value>   Path to store the audit reports
   --sort=<value>          property to sort by (prepend '-' for descending)
 
 DESCRIPTION
   Perform audits and find possible errors in the exported Contentstack data
 
 ALIASES
+  $ csdx audit
   $ csdx cm:stacks:audit
 
 EXAMPLES
@@ -112,24 +174,45 @@ _See code: [src/commands/cm/stacks/audit/index.ts](https://github.com/contentsta
 
 ## `csdx cm:stacks:audit:fix`
 
-Audit fix command
+Perform audits and fix possible errors in the exported Contentstack data.
 
 ```
 USAGE
-  $ csdx cm:stacks:audit:fix [-c <value>] [-d <value>]
+  $ csdx cm:stacks:audit:fix [-c <value>] [-d <value>] [--report-path <value>] [--modules
+    content-types|global-fields|entries] [--copy-path <value> --copy-dir] [--columns <value> | ] [--sort <value>]
+    [--filter <value>] [--csv | --no-truncate]
 
 FLAGS
-  -c, --config=<value>    Path of the external config.
-  -d, --data-dir=<value>  Path where the data is stored.
+  -c, --config=<value>    Path of the external config
+  -d, --data-dir=<value>  Path where the data is stored
+  --columns=<value>       only show provided columns (comma-separated)
+  --copy-dir              Create backup from the original data.
+  --copy-path=<value>     Provide the path to backup the copied data
+  --csv                   output is csv format [alias: --output=csv]
+  --filter=<value>        filter property by partial string matching, ex: name=foo
+  --modules=<option>...   Provide the list of modules to be audited
+                          <options: content-types|global-fields|entries>
+  --no-truncate           do not truncate output to fit screen
+  --report-path=<value>   Path to store the audit reports
+  --sort=<value>          property to sort by (prepend '-' for descending)
 
 DESCRIPTION
-  Audit fix command
+  Perform audits and fix possible errors in the exported Contentstack data.
 
 ALIASES
-  $ csdx cm::stacks:audit:fix
+  $ csdx audit:fix
+  $ csdx cm:stacks:audit:fix
 
 EXAMPLES
-  $ csdx cm:stacks:audit:fix
+  $ csdx cm:stacks:audit:fix --copy-dir
+
+  $ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir
+
+  $ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir --csv
+
+  $ csdx cm:stacks:audit:fix --report-path=<path> --filter="name=<filter-value>"
+
+  $ csdx cm:stacks:audit:fix --report-path=<path> --modules=content-types --filter="name="<filter-value>" --copy-dir --copy-path=<path>
 ```
 
 _See code: [src/commands/cm/stacks/audit/fix.ts](https://github.com/contentstack/audit/blob/main/packages/contentstack-audit/src/commands/cm/stacks/audit/fix.ts)_

package/lib/audit-base-command.d.ts

@@ -0,0 +1,83 @@
+import config from './config';
+import { BaseCommand } from './base-command';
+import { ContentTypeStruct } from './types';
+export declare abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseCommand> {
+    private currentCommand;
+    get fixStatus(): {
+        fixStatus: {
+            minWidth: number;
+            header: string;
+            get: (row: any) => string;
+        };
+    };
+    /**
+     * The `start` function performs an audit on content types, global fields, and entries, and displays
+     * any missing references.
+     * @param {string} command - The `command` parameter is a string that represents the current command
+     * being executed.
+     */
+    start(command: string): Promise<void>;
+    /**
+     * The `scan` function performs an audit on different modules (content-types, global-fields, and
+     * entries) and returns the missing references for each module.
+     * @returns The function `scan()` returns an object with properties `missingCtRefs`, `missingGfRefs`,
+     * and `missingEntryRefs`.
+     */
+    scanAndFix(): Promise<{
+        missingCtRefs: Record<string, any> | undefined;
+        missingGfRefs: Record<string, any> | undefined;
+        missingEntryRefs: Record<string, any> | undefined;
+    }>;
+    /**
+     * The `promptQueue` function prompts the user to enter a data directory path if the `data-dir` flag
+     * is missing, and sets the `basePath` property of the `sharedConfig` object to the entered path.
+     */
+    promptQueue(): Promise<void>;
+    /**
+     * The function `createBackUp` creates a backup of data if the `copy-dir` flag is set, and throws
+     * an error if the specified path does not exist.
+     */
+    createBackUp(): Promise<void>;
+    /**
+     * The function `getCtAndGfSchema` reads and parses JSON files containing content type and global
+     * field schemas, and returns them as an object.
+     * @returns The function `getCtAndGfSchema()` returns an object with two properties: `ctSchema` and
+     * `gfSchema`. The values of these properties are the parsed JSON data from two different files.
+     */
+    getCtAndGfSchema(): {
+        ctSchema: ContentTypeStruct[];
+        gfSchema: ContentTypeStruct[];
+    };
+    /**
+     * The function `showOutputOnScreen` displays missing references on the terminal screen if the
+     * `showTerminalOutput` flag is set to true.
+     * @param {{ module: string; missingRefs?: Record<string, any> }[]} allMissingRefs - An array of
+     * objects, where each object has two properties:
+     */
+    showOutputOnScreen(allMissingRefs: {
+        module: string;
+        missingRefs?: Record<string, any>;
+    }[]): void;
+    /**
+     * The function prepares a report by writing a JSON file and a CSV file with a list of missing
+     * references for a given module.
+     * @param moduleName - The `moduleName` parameter is a string that represents the name of a module.
+     * It is used to generate the filename for the report.
+     * @param listOfMissingRefs - The `listOfMissingRefs` parameter is a record object that contains
+     * information about missing references. It is a key-value pair where the key represents the
+     * reference name and the value represents additional information about the missing reference.
+     * @returns The function `prepareReport` returns a Promise that resolves to `void`.
+     */
+    prepareReport(moduleName: keyof typeof config.moduleConfig, listOfMissingRefs: Record<string, any>): Promise<void>;
+    /**
+     * The function `prepareCSV` takes a module name and a list of missing references, and generates a
+     * CSV file with the specified columns and filtered rows.
+     * @param moduleName - The `moduleName` parameter is a string that represents the name of a module.
+     * It is used to generate the name of the CSV file that will be created.
+     * @param listOfMissingRefs - The `listOfMissingRefs` parameter is a record object that contains
+     * information about missing references. Each key in the record represents a reference, and the
+     * corresponding value is an array of objects that contain details about the missing reference.
+     * @returns The function `prepareCSV` returns a Promise that resolves to `void`.
+     */
+    prepareCSV(moduleName: keyof typeof config.moduleConfig, listOfMissingRefs: Record<string, any>): Promise<void>;
+}

package/lib/audit-base-command.js

@@ -0,0 +1,263 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditBaseCommand = void 0;
+const tslib_1 = require("tslib");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const csv = tslib_1.__importStar(require("fast-csv"));
+const fs_extra_1 = require("fs-extra");
+const uuid_1 = require("uuid");
+const isEmpty_1 = tslib_1.__importDefault(require("lodash/isEmpty"));
+const path_1 = require("path");
+const cloneDeep_1 = tslib_1.__importDefault(require("lodash/cloneDeep"));
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const fs_1 = require("fs");
+const log_1 = require("./util/log");
+const messages_1 = require("./messages");
+const base_command_1 = require("./base-command");
+const modules_1 = require("./modules");
+const types_1 = require("./types");
+class AuditBaseCommand extends base_command_1.BaseCommand {
+    get fixStatus() {
+        return {
+            fixStatus: {
+                minWidth: 7,
+                header: 'Fix Status',
+                get: (row) => {
+                    return row.fixStatus === 'Fixed' ? chalk_1.default.greenBright(row.fixStatus) : chalk_1.default.redBright(row.fixStatus);
+                },
+            },
+        };
+    }
+    /**
+     * The `start` function performs an audit on content types, global fields, and entries, and displays
+     * any missing references.
+     * @param {string} command - The `command` parameter is a string that represents the current command
+     * being executed.
+     */
+    async start(command) {
+        this.currentCommand = command;
+        await this.promptQueue();
+        await this.createBackUp();
+        this.sharedConfig.reportPath = (0, path_1.resolve)(this.flags['report-path'] || process.cwd(), 'audit-report');
+        const { missingCtRefs, missingGfRefs, missingEntryRefs } = await this.scanAndFix();
+        this.showOutputOnScreen([
+            { module: 'Content types', missingRefs: missingCtRefs },
+            { module: 'Global Fields', missingRefs: missingGfRefs },
+            { module: 'Entries', missingRefs: missingEntryRefs },
+        ]);
+        if (!(0, isEmpty_1.default)(missingCtRefs) || !(0, isEmpty_1.default)(missingGfRefs) || !(0, isEmpty_1.default)(missingEntryRefs)) {
+            if (this.currentCommand === 'cm:stacks:audit') {
+                this.log(this.$t(messages_1.auditMsg.FINAL_REPORT_PATH, { path: this.sharedConfig.reportPath }), 'warn');
+            }
+            else {
+                this.log(this.$t(this.messages.FIXED_CONTENT_PATH_MAG, { path: this.sharedConfig.basePath }), 'warn');
+            }
+        }
+        else {
+            this.log(this.messages.NO_MISSING_REF_FOUND, 'info');
+            this.log('');
+        }
+    }
+    /**
+     * The `scan` function performs an audit on different modules (content-types, global-fields, and
+     * entries) and returns the missing references for each module.
+     * @returns The function `scan()` returns an object with properties `missingCtRefs`, `missingGfRefs`,
+     * and `missingEntryRefs`.
+     */
+    async scanAndFix() {
+        let { ctSchema, gfSchema } = this.getCtAndGfSchema();
+        let missingCtRefs, missingGfRefs, missingEntryRefs;
+        for (const module of this.sharedConfig.flags.modules || this.sharedConfig.modules) {
+            cli_utilities_1.ux.action.start(this.$t(this.messages.AUDIT_START_SPINNER, { module }));
+            const constructorParam = {
+                ctSchema,
+                gfSchema,
+                log: this.log,
+                moduleName: module,
+                config: this.sharedConfig,
+                fix: this.currentCommand === 'cm:stacks:audit:fix',
+            };
+            switch (module) {
+                case 'content-types':
+                    missingCtRefs = await new modules_1.ContentType((0, cloneDeep_1.default)(constructorParam)).run();
+                    await this.prepareReport(module, missingCtRefs);
+                    break;
+                case 'global-fields':
+                    missingGfRefs = await new modules_1.GlobalField((0, cloneDeep_1.default)(constructorParam)).run();
+                    await this.prepareReport(module, missingGfRefs);
+                    break;
+                case 'entries':
+                    missingEntryRefs = await new modules_1.Entries((0, cloneDeep_1.default)(constructorParam)).run();
+                    await this.prepareReport(module, missingEntryRefs);
+                    break;
+            }
+            cli_utilities_1.ux.action.stop();
+        }
+        return { missingCtRefs, missingGfRefs, missingEntryRefs };
+    }
+    /**
+     * The `promptQueue` function prompts the user to enter a data directory path if the `data-dir` flag
+     * is missing, and sets the `basePath` property of the `sharedConfig` object to the entered path.
+     */
+    async promptQueue() {
+        // NOTE get content path if data-dir flag is missing
+        this.sharedConfig.basePath =
+            this.flags['data-dir'] ||
+                (await cli_utilities_1.cliux.inquire({
+                    type: 'input',
+                    name: 'data-dir',
+                    message: this.messages.DATA_DIR,
+                }));
+    }
+    /**
+     * The function `createBackUp` creates a backup of data if the `copy-dir` flag is set, and throws
+     * an error if the specified path does not exist.
+     */
+    async createBackUp() {
+        if (this.currentCommand === 'cm:stacks:audit:fix' && this.flags['copy-dir']) {
+            if (!(0, fs_1.existsSync)(this.sharedConfig.basePath)) {
+                throw Error(this.$t(this.messages.NOT_VALID_PATH, { path: this.sharedConfig.basePath }));
+            }
+            // NOTE create bkp directory
+            const backupDirPath = `${(this.flags['copy-path'] || this.flags['data-dir']).replace(/\/+$/, '')}_backup_${(0, uuid_1.v4)()}`;
+            if (!(0, fs_1.existsSync)(backupDirPath)) {
+                (0, fs_1.mkdirSync)(backupDirPath, { recursive: true });
+            }
+            await (0, fs_extra_1.copy)(this.sharedConfig.basePath, backupDirPath);
+            this.sharedConfig.basePath = backupDirPath;
+        }
+    }
+    /**
+     * The function `getCtAndGfSchema` reads and parses JSON files containing content type and global
+     * field schemas, and returns them as an object.
+     * @returns The function `getCtAndGfSchema()` returns an object with two properties: `ctSchema` and
+     * `gfSchema`. The values of these properties are the parsed JSON data from two different files.
+     */
+    getCtAndGfSchema() {
+        const modules = this.sharedConfig.flags.modules || this.sharedConfig.modules;
+        const ctPath = (0, path_1.join)(this.sharedConfig.basePath, this.sharedConfig.moduleConfig['content-types'].dirName, this.sharedConfig.moduleConfig['content-types'].fileName);
+        const gfPath = (0, path_1.join)(this.sharedConfig.basePath, this.sharedConfig.moduleConfig['global-fields'].dirName, this.sharedConfig.moduleConfig['global-fields'].fileName);
+        if (modules.includes('content-types')) {
+            if (!(0, fs_1.existsSync)(ctPath)) {
+                this.log(this.$t(messages_1.auditMsg.NOT_VALID_PATH, { path: ctPath }), 'error');
+            }
+        }
+        if (modules.includes('global-fields')) {
+            if (!(0, fs_1.existsSync)(gfPath)) {
+                this.log(this.$t(messages_1.auditMsg.NOT_VALID_PATH, { path: ctPath }), 'error');
+            }
+        }
+        const gfSchema = (0, fs_1.existsSync)(gfPath) ? JSON.parse((0, fs_1.readFileSync)(gfPath, 'utf8')) : [];
+        const ctSchema = (0, fs_1.existsSync)(ctPath) ? JSON.parse((0, fs_1.readFileSync)(ctPath, 'utf8')) : [];
+        return { ctSchema, gfSchema };
+    }
+    /**
+     * The function `showOutputOnScreen` displays missing references on the terminal screen if the
+     * `showTerminalOutput` flag is set to true.
+     * @param {{ module: string; missingRefs?: Record<string, any> }[]} allMissingRefs - An array of
+     * objects, where each object has two properties:
+     */
+    showOutputOnScreen(allMissingRefs) {
+        var _a;
+        if (this.sharedConfig.showTerminalOutput) {
+            this.log(''); // NOTE adding new line
+            for (const { module, missingRefs } of allMissingRefs) {
+                if (!(0, isEmpty_1.default)(missingRefs)) {
+                    (0, log_1.print)([
+                        {
+                            bold: true,
+                            color: 'cyan',
+                            message: ` ${module}`,
+                        },
+                    ]);
+                    const tableValues = Object.values(missingRefs).flat();
+                    cli_utilities_1.ux.table(tableValues, Object.assign(Object.assign({ name: {
+                            minWidth: 7,
+                            header: 'Title',
+                        }, display_name: {
+                            minWidth: 7,
+                            header: 'Field name',
+                        }, data_type: {
+                            minWidth: 7,
+                            header: 'Field type',
+                        }, missingRefs: {
+                            minWidth: 7,
+                            header: 'Missing references',
+                            get: (row) => {
+                                return chalk_1.default.red(typeof row.missingRefs === 'object' ? JSON.stringify(row.missingRefs) : row.missingRefs);
+                            },
+                        } }, (((_a = tableValues[0]) === null || _a === void 0 ? void 0 : _a.fixStatus) ? this.fixStatus : {})), { treeStr: {
+                            minWidth: 7,
+                            header: 'Path',
+                        } }), Object.assign({}, this.flags));
+                    this.log(''); // NOTE adding new line
+                }
+            }
+        }
+    }
+    /**
+     * The function prepares a report by writing a JSON file and a CSV file with a list of missing
+     * references for a given module.
+     * @param moduleName - The `moduleName` parameter is a string that represents the name of a module.
+     * It is used to generate the filename for the report.
+     * @param listOfMissingRefs - The `listOfMissingRefs` parameter is a record object that contains
+     * information about missing references. It is a key-value pair where the key represents the
+     * reference name and the value represents additional information about the missing reference.
+     * @returns The function `prepareReport` returns a Promise that resolves to `void`.
+     */
+    prepareReport(moduleName, listOfMissingRefs) {
+        if ((0, isEmpty_1.default)(listOfMissingRefs))
+            return Promise.resolve(void 0);
+        if (!(0, fs_1.existsSync)(this.sharedConfig.reportPath)) {
+            (0, fs_1.mkdirSync)(this.sharedConfig.reportPath, { recursive: true });
+        }
+        // NOTE write int json
+        (0, fs_1.writeFileSync)((0, path_1.join)(this.sharedConfig.reportPath, `${moduleName}.json`), JSON.stringify(listOfMissingRefs));
+        // NOTE write into CSV
+        return this.prepareCSV(moduleName, listOfMissingRefs);
+    }
+    /**
+     * The function `prepareCSV` takes a module name and a list of missing references, and generates a
+     * CSV file with the specified columns and filtered rows.
+     * @param moduleName - The `moduleName` parameter is a string that represents the name of a module.
+     * It is used to generate the name of the CSV file that will be created.
+     * @param listOfMissingRefs - The `listOfMissingRefs` parameter is a record object that contains
+     * information about missing references. Each key in the record represents a reference, and the
+     * corresponding value is an array of objects that contain details about the missing reference.
+     * @returns The function `prepareCSV` returns a Promise that resolves to `void`.
+     */
+    prepareCSV(moduleName, listOfMissingRefs) {
+        const csvStream = csv.format({ headers: true });
+        const csvPath = (0, path_1.join)(this.sharedConfig.reportPath, `${moduleName}.csv`);
+        const assetFileStream = (0, fs_1.createWriteStream)(csvPath);
+        assetFileStream.on('error', (error) => {
+            throw error;
+        });
+        return new Promise((resolve, reject) => {
+            csvStream.pipe(assetFileStream).on('close', resolve).on('error', reject);
+            const defaultColumns = Object.keys(types_1.OutputColumn);
+            const userDefinedColumns = this.sharedConfig.flags.columns ? this.sharedConfig.flags.columns.split(',') : null;
+            let missingRefs = Object.values(listOfMissingRefs).flat();
+            const columns = userDefinedColumns
+                ? [...userDefinedColumns, ...defaultColumns.filter((val) => !userDefinedColumns.includes(val))]
+                : defaultColumns;
+            if (this.sharedConfig.flags.filter) {
+                const [column, value] = this.sharedConfig.flags.filter.split('=');
+                missingRefs = missingRefs.filter((row) => row[types_1.OutputColumn[column]] === value);
+            }
+            for (const issue of missingRefs) {
+                let row = {};
+                for (const column of columns) {
+                    row[column] = issue[types_1.OutputColumn[column]];
+                    row[column] = typeof row[column] === 'object' ? JSON.stringify(row[column]) : row[column];
+                }
+                if (this.currentCommand === 'cm:stacks:audit:fix') {
+                    row['Fix status'] = row.fixStatus;
+                }
+                csvStream.write(row);
+            }
+            csvStream.end();
+        });
+    }
+}
+exports.AuditBaseCommand = AuditBaseCommand;

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

@@ -1,8 +1,13 @@
-import { BaseCommand } from '../../../../base-command';
-export default class AuditFix extends BaseCommand<typeof AuditFix> {
-    static description: string;
+import { FlagInput } from '@contentstack/cli-utilities';
+import { AuditBaseCommand } from '../../../../audit-base-command';
+export default class AuditFix extends AuditBaseCommand {
     static aliases: string[];
+    static description: string;
     static examples: string[];
-    static flags: {};
+    static flags: FlagInput;
+    /**
+     * The `run` function is an asynchronous function that performs an audit on different modules
+     * (content-types, global-fields, entries) and generates a report.
+     */
     run(): Promise<void>;
 }

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

@@ -1,11 +1,55 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const base_command_1 = require("../../../../base-command");
-class AuditFix extends base_command_1.BaseCommand {
-    async run() { }
+const tslib_1 = require("tslib");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const config_1 = tslib_1.__importDefault(require("../../../../config"));
+const messages_1 = require("../../../../messages");
+const audit_base_command_1 = require("../../../../audit-base-command");
+class AuditFix extends audit_base_command_1.AuditBaseCommand {
+    /**
+     * The `run` function is an asynchronous function that performs an audit on different modules
+     * (content-types, global-fields, entries) and generates a report.
+     */
+    async run() {
+        try {
+            await this.start('cm:stacks:audit:fix');
+        }
+        catch (error) {
+            this.log(error instanceof Error ? error.message : error, 'error');
+            console.trace(error);
+            cli_utilities_1.ux.action.stop('Process failed.!');
+            this.exit(1);
+        }
+    }
 }
 exports.default = AuditFix;
-AuditFix.description = 'Audit fix command';
-AuditFix.aliases = ['cm::stacks:audit:fix'];
-AuditFix.examples = ['$ <%= config.bin %> <%= command.id %>'];
-AuditFix.flags = {};
+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',
+    '$ <%= config.bin %> <%= command.id %> --report-path=<path> --copy-dir',
+    '$ <%= config.bin %> <%= command.id %> --report-path=<path> --copy-dir --csv',
+    '$ <%= config.bin %> <%= command.id %> --report-path=<path> --filter="name=<filter-value>"',
+    '$ <%= config.bin %> <%= command.id %> --report-path=<path> --modules=content-types --filter="name="<filter-value>" --copy-dir --copy-path=<path>',
+];
+AuditFix.flags = Object.assign({ 'report-path': cli_utilities_1.Flags.string({
+        description: messages_1.auditMsg.REPORT_PATH,
+    }), 'reference-only': cli_utilities_1.Flags.boolean({
+        hidden: true,
+        description: messages_1.auditMsg.REFERENCE_ONLY,
+    }), modules: cli_utilities_1.Flags.string({
+        multiple: true,
+        options: config_1.default.modules,
+        description: messages_1.auditMsg.MODULES,
+    }), 'copy-dir': cli_utilities_1.Flags.boolean({
+        description: messages_1.auditFixMsg.COPY_DATA,
+    }), 'copy-path': cli_utilities_1.Flags.string({
+        dependsOn: ['copy-dir'],
+        description: messages_1.auditFixMsg.BKP_PATH,
+    }), yes: cli_utilities_1.Flags.boolean({
+        char: 'y',
+        hidden: true,
+        description: 'Use this flag to skip confirmation',
+    }) }, cli_utilities_1.ux.table.flags({
+    only: ['columns', 'sort', 'filter', 'csv', 'no-truncate'],
+}));