@contentstack/cli-audit 1.2.1 → 1.3.0

package/README.md

@@ -19,7 +19,7 @@ $ npm install -g @contentstack/cli-audit
 $ csdx COMMAND
 running command...
 $ csdx (--version|-v)
-@contentstack/cli-audit/1.2.1 linux-x64 node-v18.18.2
+@contentstack/cli-audit/1.3.0 linux-x64 node-v18.18.2
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -56,16 +56,20 @@ USAGE
     --no-truncate]
 
 FLAGS
+  --modules=<option>...  Provide the list of modules to be audited
+                         <options: content-types|global-fields|entries>
+  --report-path=<value>  Path to store the audit reports
+
+COMMON 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)
-  --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)
+
+TABLE FLAGS
+  --columns=<value>  Show only the specified columns (comma-separated)
+  --csv              The output is in the CSV format [alias: --output=csv]
+  --filter=<value>   Filter property by partial string matching. For example: name=foo
+  --no-truncate      The output is not truncated to fit the screen
+  --sort=<value>     Property to sort by (prepend '-' for descending)
 
 DESCRIPTION
   Perform audits and find possible errors in the exported Contentstack data
@@ -93,22 +97,29 @@ 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]
+    content-types|global-fields|entries] [--copy-path <value> --copy-dir] [--fix-only
+    reference|global_field|json:rte|json:custom-field|blocks|group] [--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
+  --fix-only=<option>...  Provide the list of fix options
+                          <options: reference|global_field|json:rte|json:custom-field|blocks|group>
   --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)
+
+COMMON FLAGS
+  -c, --config=<value>    Path of the external config
+  -d, --data-dir=<value>  Path where the data is stored
+
+TABLE FLAGS
+  --columns=<value>  Show only the specified columns (comma-separated)
+  --csv              The output is in the CSV format [alias: --output=csv]
+  --filter=<value>   Filter property by partial string matching. For example: name=foo
+  --no-truncate      The output is not truncated to fit the screen
+  --sort=<value>     Property to sort by (prepend '-' for descending)
 
 DESCRIPTION
   Perform audits and fix possible errors in the exported Contentstack data.
@@ -124,6 +135,8 @@ EXAMPLES
 
   $ csdx audit:fix --report-path=<path> --copy-dir --csv
 
+  $ csdx audit:fix --fix-only=reference,global_field --copy-dir
+
   $ 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>
@@ -140,16 +153,20 @@ USAGE
     --no-truncate]
 
 FLAGS
+  --modules=<option>...  Provide the list of modules to be audited
+                         <options: content-types|global-fields|entries>
+  --report-path=<value>  Path to store the audit reports
+
+COMMON 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)
-  --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)
+
+TABLE FLAGS
+  --columns=<value>  Show only the specified columns (comma-separated)
+  --csv              The output is in the CSV format [alias: --output=csv]
+  --filter=<value>   Filter property by partial string matching. For example: name=foo
+  --no-truncate      The output is not truncated to fit the screen
+  --sort=<value>     Property to sort by (prepend '-' for descending)
 
 DESCRIPTION
   Perform audits and find possible errors in the exported Contentstack data
@@ -179,22 +196,29 @@ Perform audits and fix possible errors in the exported Contentstack data.
 ```
 USAGE
   $ 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]
+    content-types|global-fields|entries] [--copy-path <value> --copy-dir] [--fix-only
+    reference|global_field|json:rte|json:custom-field|blocks|group] [--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
+  --fix-only=<option>...  Provide the list of fix options
+                          <options: reference|global_field|json:rte|json:custom-field|blocks|group>
   --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)
+
+COMMON FLAGS
+  -c, --config=<value>    Path of the external config
+  -d, --data-dir=<value>  Path where the data is stored
+
+TABLE FLAGS
+  --columns=<value>  Show only the specified columns (comma-separated)
+  --csv              The output is in the CSV format [alias: --output=csv]
+  --filter=<value>   Filter property by partial string matching. For example: name=foo
+  --no-truncate      The output is not truncated to fit the screen
+  --sort=<value>     Property to sort by (prepend '-' for descending)
 
 DESCRIPTION
   Perform audits and fix possible errors in the exported Contentstack data.
@@ -210,6 +234,8 @@ EXAMPLES
 
   $ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir --csv
 
+  $ csdx cm:stacks:audit:fix --fix-only=reference,global_field --copy-dir
+
   $ 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>

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

@@ -1,6 +1,6 @@
 import config from './config';
 import { BaseCommand } from './base-command';
-import { ContentTypeStruct } from './types';
+import { CommandNames, ContentTypeStruct } from './types';
 export declare abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseCommand> {
     private currentCommand;
     get fixStatus(): {
@@ -16,7 +16,7 @@ export declare abstract class AuditBaseCommand extends BaseCommand<typeof AuditB
      * @param {string} command - The `command` parameter is a string that represents the current command
      * being executed.
      */
-    start(command: string): Promise<void>;
+    start(command: CommandNames): 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.

package/lib/audit-base-command.js

@@ -56,6 +56,10 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
         else {
             this.log(this.messages.NO_MISSING_REF_FOUND, 'info');
             this.log('');
+            if (this.currentCommand === 'cm:stacks:audit:fix' && (0, fs_1.existsSync)(this.sharedConfig.basePath)) {
+                // NOTE Clean up the backup dir if no issue found while audit the content
+                (0, fs_1.rmSync)(this.sharedConfig.basePath, { recursive: true });
+            }
         }
     }
     /**
@@ -227,14 +231,10 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
      * @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);
+            // file deepcode ignore MissingClose: Will auto close once csv stream end
+            const ws = (0, fs_1.createWriteStream)(csvPath).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();
@@ -245,6 +245,7 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
                 const [column, value] = this.sharedConfig.flags.filter.split('=');
                 missingRefs = missingRefs.filter((row) => row[types_1.OutputColumn[column]] === value);
             }
+            const rowData = [];
             for (const issue of missingRefs) {
                 let row = {};
                 for (const column of columns) {
@@ -254,9 +255,9 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
                 if (this.currentCommand === 'cm:stacks:audit:fix') {
                     row['Fix status'] = row.fixStatus;
                 }
-                csvStream.write(row);
+                rowData.push(row);
             }
-            csvStream.end();
+            csv.write(rowData, { headers: true }).pipe(ws).on('error', reject).on('finish', resolve);
         });
     }
 }

package/lib/base-command.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseCommand = void 0;
 const tslib_1 = require("tslib");
+const merge_1 = tslib_1.__importDefault(require("lodash/merge"));
 const fs_1 = require("fs");
 const cli_command_1 = require("@contentstack/cli-command");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
@@ -66,7 +67,7 @@ class BaseCommand extends cli_command_1.Command {
     registerConfig() {
         if (this.flags.config && (0, fs_1.existsSync)(this.flags.config)) {
             try {
-                this.sharedConfig = JSON.parse((0, fs_1.readFileSync)(this.flags.config, { encoding: 'utf-8' }));
+                this.sharedConfig = (0, merge_1.default)(this.sharedConfig, JSON.parse((0, fs_1.readFileSync)(this.flags.config, { encoding: 'utf-8' })));
             }
             catch (error) {
                 this.log(error, 'error');
@@ -79,10 +80,12 @@ exports.BaseCommand = BaseCommand;
 BaseCommand.baseFlags = {
     config: cli_utilities_1.Flags.string({
         char: 'c',
+        helpGroup: 'COMMON',
         description: messages_1.commonMsg.CONFIG,
     }),
     'data-dir': cli_utilities_1.Flags.string({
         char: 'd',
+        helpGroup: 'COMMON',
         description: messages_1.commonMsg.DATA_DIR,
     }),
 };

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const config_1 = tslib_1.__importDefault(require("../../../../config"));
+const util_1 = require("../../../../util");
 const messages_1 = require("../../../../messages");
 const audit_base_command_1 = require("../../../../audit-base-command");
 class AuditFix extends audit_base_command_1.AuditBaseCommand {
@@ -29,6 +30,7 @@ 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 %> --fix-only=reference,global_field --copy-dir',
     '$ <%= 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>',
 ];
@@ -46,10 +48,12 @@ AuditFix.flags = Object.assign({ 'report-path': cli_utilities_1.Flags.string({
     }), 'copy-path': cli_utilities_1.Flags.string({
         dependsOn: ['copy-dir'],
         description: messages_1.auditFixMsg.BKP_PATH,
+    }), 'fix-only': cli_utilities_1.Flags.string({
+        multiple: true,
+        options: config_1.default['fix-fields'],
+        description: messages_1.auditFixMsg.FIX_OPTIONS,
     }), 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'],
-}));
+    }) }, (0, util_1.getTableFlags)());

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

@@ -5,6 +5,7 @@ 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");
+const util_1 = require("../../../../util");
 class Audit extends audit_base_command_1.AuditBaseCommand {
     /**
      * The `run` function is an asynchronous function that performs an audit on different modules
@@ -16,7 +17,6 @@ class Audit extends audit_base_command_1.AuditBaseCommand {
         }
         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);
         }
@@ -41,6 +41,4 @@ Audit.flags = Object.assign({ 'report-path': cli_utilities_1.Flags.string({
         multiple: true,
         options: config_1.default.modules,
         description: messages_1.auditMsg.MODULES,
-    }) }, cli_utilities_1.ux.table.flags({
-    only: ['columns', 'sort', 'filter', 'csv', 'no-truncate'],
-}));
+    }) }, (0, util_1.getTableFlags)());

package/lib/config/index.d.ts

@@ -2,6 +2,7 @@ declare const config: {
     showTerminalOutput: boolean;
     skipRefs: string[];
     modules: string[];
+    'fix-fields': string[];
     moduleConfig: {
         'content-types': {
             name: string;

package/lib/config/index.js

@@ -4,6 +4,7 @@ const config = {
     showTerminalOutput: true,
     skipRefs: ['sys_assets'],
     modules: ['content-types', 'global-fields', 'entries'],
+    'fix-fields': ['reference', 'global_field', 'json:rte', 'json:custom-field', 'blocks', 'group'],
     moduleConfig: {
         'content-types': {
             name: 'content type',

package/lib/messages/index.d.ts

@@ -1,4 +1,11 @@
 declare const errors: {};
+declare const tableColumnDescriptions: {
+    TABLE_COLUMNS: string;
+    TABLE_SORT: string;
+    TABLE_CSV: string;
+    TABLE_FILTER: string;
+    'TABLE_NO-TRUNCATE': string;
+};
 declare const commonMsg: {
     CONFIG: string;
     DATA_DIR: string;
@@ -20,11 +27,12 @@ declare const auditMsg: {
 declare const auditFixMsg: {
     COPY_DATA: string;
     BKP_PATH: string;
+    FIX_OPTIONS: string;
     FIXED_CONTENT_PATH_MAG: string;
     EMPTY_FIX_MSG: string;
     AUDIT_FIX_CMD_DESCRIPTION: string;
 };
-declare const messages: typeof errors & typeof commonMsg & typeof auditMsg & typeof auditFixMsg;
+declare const messages: typeof errors & typeof commonMsg & typeof auditMsg & typeof auditFixMsg & typeof tableColumnDescriptions;
 /**
  * The function `$t` is a TypeScript function that replaces placeholders in a string with corresponding
  * values from an object.
@@ -36,4 +44,4 @@ declare const messages: typeof errors & typeof commonMsg & typeof auditMsg & typ
  */
 declare function $t(msg: string, args: Record<string, string>): string;
 export default messages;
-export { $t, errors, commonMsg, auditMsg, auditFixMsg };
+export { $t, errors, commonMsg, auditMsg, auditFixMsg, tableColumnDescriptions };

package/lib/messages/index.js

@@ -1,8 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.auditFixMsg = exports.auditMsg = exports.commonMsg = exports.errors = exports.$t = void 0;
+exports.tableColumnDescriptions = exports.auditFixMsg = exports.auditMsg = exports.commonMsg = exports.errors = exports.$t = void 0;
 const errors = {};
 exports.errors = errors;
+const tableColumnDescriptions = {
+    TABLE_COLUMNS: 'Show only the specified columns (comma-separated)',
+    TABLE_SORT: "Property to sort by (prepend '-' for descending)",
+    TABLE_CSV: 'The output is in the CSV format [alias: --output=csv]',
+    TABLE_FILTER: 'Filter property by partial string matching. For example: name=foo',
+    'TABLE_NO-TRUNCATE': 'The output is not truncated to fit the screen',
+};
+exports.tableColumnDescriptions = tableColumnDescriptions;
 const commonMsg = {
     CONFIG: 'Path of the external config',
     DATA_DIR: 'Path where the data is stored',
@@ -26,12 +34,13 @@ exports.auditMsg = auditMsg;
 const auditFixMsg = {
     COPY_DATA: 'Create backup from the original data.',
     BKP_PATH: 'Provide the path to backup the copied data',
+    FIX_OPTIONS: 'Provide the list of fix options',
     FIXED_CONTENT_PATH_MAG: 'You can locate the fixed content at {path}.',
     EMPTY_FIX_MSG: 'Successfully removed the empty field/block found at {path} from the schema.',
     AUDIT_FIX_CMD_DESCRIPTION: 'Perform audits and fix possible errors in the exported Contentstack data.',
 };
 exports.auditFixMsg = auditFixMsg;
-const messages = Object.assign(Object.assign(Object.assign(Object.assign({}, errors), commonMsg), auditMsg), auditFixMsg);
+const messages = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, errors), commonMsg), auditMsg), auditFixMsg), tableColumnDescriptions);
 /**
  * The function `$t` is a TypeScript function that replaces placeholders in a string with corresponding
  * values from an object.

package/lib/modules/content-types.d.ts

@@ -8,6 +8,7 @@ export default class ContentType {
     folderPath: string;
     currentUid: string;
     currentTitle: string;
+    inMemoryFix: boolean;
     gfSchema: ContentTypeStruct[];
     ctSchema: ContentTypeStruct[];
     protected schema: ContentTypeStruct[];

package/lib/modules/content-types.js

@@ -2,15 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const find_1 = tslib_1.__importDefault(require("lodash/find"));
-const core_1 = require("@oclif/core");
 const isEmpty_1 = tslib_1.__importDefault(require("lodash/isEmpty"));
 const path_1 = require("path");
 const fs_1 = require("fs");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
 const messages_1 = require("../messages");
 /* The `ContentType` class is responsible for scanning content types, looking for references, and
 generating a report in JSON and CSV formats. */
 class ContentType {
     constructor({ log, fix, config, moduleName, ctSchema, gfSchema }) {
+        this.inMemoryFix = false;
         this.schema = [];
         this.missingRefs = {};
         this.log = log;
@@ -29,6 +30,7 @@ class ContentType {
      */
     async run(returnFixSchema = false) {
         var _a;
+        this.inMemoryFix = returnFixSchema;
         if (!(0, fs_1.existsSync)(this.folderPath)) {
             throw new Error((0, messages_1.$t)(messages_1.auditMsg.NOT_VALID_PATH, { path: this.folderPath }));
         }
@@ -59,12 +61,15 @@ class ContentType {
      * JSON to the specified file path.
      */
     async writeFixContent() {
+        var _a;
         let canWrite = true;
-        if (this.fix && !this.config.flags['copy-dir']) {
-            canWrite = this.config.flags.yes || (await core_1.ux.confirm(messages_1.commonMsg.FIX_CONFIRMATION));
-        }
-        if (canWrite) {
-            (0, fs_1.writeFileSync)((0, path_1.join)(this.folderPath, this.config.moduleConfig[this.moduleName].fileName), JSON.stringify(this.schema));
+        if (!this.inMemoryFix && this.fix) {
+            if (!this.config.flags['copy-dir']) {
+                canWrite = (_a = this.config.flags.yes) !== null && _a !== void 0 ? _a : (await cli_utilities_1.ux.confirm(messages_1.commonMsg.FIX_CONFIRMATION));
+            }
+            if (canWrite) {
+                (0, fs_1.writeFileSync)((0, path_1.join)(this.folderPath, this.config.moduleConfig[this.moduleName].fileName), JSON.stringify(this.schema));
+            }
         }
     }
     /**
@@ -79,11 +84,14 @@ class ContentType {
      * object in the array should have a `uid` and `name` property.
      */
     async lookForReference(tree, field) {
-        var _a;
+        var _a, _b;
+        const fixTypes = (_a = this.config.flags['fix-only']) !== null && _a !== void 0 ? _a : this.config['fix-fields'];
         if (this.fix) {
             field.schema = this.runFixOnSchema(tree, field.schema);
         }
-        for (let child of (_a = field.schema) !== null && _a !== void 0 ? _a : []) {
+        for (let child of (_b = field.schema) !== null && _b !== void 0 ? _b : []) {
+            if (!fixTypes.includes(child.data_type) && child.data_type !== 'json')
+                continue;
             switch (child.data_type) {
                 case 'reference':
                     this.missingRefs[this.currentUid].push(...this.validateReferenceField([...tree, { uid: field.uid, name: child.display_name }], child));
@@ -93,9 +101,13 @@ class ContentType {
                     break;
                 case 'json':
                     if (child.field_metadata.extension) {
+                        if (!fixTypes.includes('json:custom-field'))
+                            continue;
                         // NOTE Custom field type
                     }
                     else if (child.field_metadata.allow_json_rte) {
+                        if (!fixTypes.includes('json:rte'))
+                            continue;
                         // NOTE JSON RTE field type
                         this.missingRefs[this.currentUid].push(...this.validateJsonRTEFields([...tree, { uid: child.uid, name: child.display_name }], child));
                     }
@@ -131,6 +143,18 @@ class ContentType {
      */
     async validateGlobalField(tree, field) {
         // NOTE Any GlobalField related logic can be added here
+        if (!field.schema && !this.fix) {
+            this.missingRefs[this.currentUid].push({
+                tree,
+                ct_uid: this.currentUid,
+                name: this.currentTitle,
+                data_type: field.data_type,
+                display_name: field.display_name,
+                missingRefs: 'Empty schema found',
+                treeStr: tree.map(({ name }) => name).join(' ➜ '),
+            });
+            return void 0;
+        }
         await this.lookForReference(tree, field);
     }
     /**
@@ -233,7 +257,11 @@ class ContentType {
         // NOTE Global field Fix
         return schema
             .map((field) => {
+            var _a;
             const { data_type } = field;
+            const fixTypes = (_a = this.config.flags['fix-only']) !== null && _a !== void 0 ? _a : this.config['fix-fields'];
+            if (!fixTypes.includes(data_type) && data_type !== 'json')
+                return field;
             switch (data_type) {
                 case 'global_field':
                     return this.fixGlobalFieldReferences(tree, field);
@@ -242,9 +270,14 @@ class ContentType {
                     if (data_type === 'json') {
                         if (field.field_metadata.extension) {
                             // NOTE Custom field type
+                            if (!fixTypes.includes('json:custom-field'))
+                                return field;
+                            // NOTE Fix logic
                             return field;
                         }
                         else if (field.field_metadata.allow_json_rte) {
+                            if (!fixTypes.includes('json:rte'))
+                                return field;
                             return this.fixMissingReferences(tree, field);
                         }
                     }
@@ -279,6 +312,7 @@ class ContentType {
      * doesn't.
      */
     fixGlobalFieldReferences(tree, field) {
+        var _a;
         const { reference_to, display_name, data_type } = field;
         if (reference_to && data_type === 'global_field') {
             tree = [...tree, { uid: field.uid, name: field.display_name, data_type: field.data_type }];
@@ -289,12 +323,28 @@ class ContentType {
                     data_type,
                     display_name,
                     fixStatus: 'Fixed',
-                    missingRefs: [reference_to],
                     ct_uid: this.currentUid,
                     name: this.currentTitle,
+                    missingRefs: [reference_to],
                     treeStr: tree.map(({ name }) => name).join(' ➜ '),
                 });
             }
+            else if (!field.schema) {
+                const gfSchema = (_a = (0, find_1.default)(this.gfSchema, { uid: field.reference_to })) === null || _a === void 0 ? void 0 : _a.schema;
+                if (gfSchema) {
+                    field.schema = gfSchema;
+                    this.missingRefs[this.currentUid].push({
+                        tree,
+                        data_type,
+                        display_name,
+                        fixStatus: 'Fixed',
+                        ct_uid: this.currentUid,
+                        name: this.currentTitle,
+                        missingRefs: 'Empty schema found',
+                        treeStr: tree.map(({ name }) => name).join(' ➜ '),
+                    });
+                }
+            }
             return refExist ? field : null;
         }
         return field;

package/lib/modules/entries.d.ts

@@ -2,7 +2,7 @@ import auditConfig from '../config';
 import { LogFn, Locale, ConfigType, EntryStruct, EntryFieldType, ModularBlockType, ContentTypeStruct, CtConstructorParam, GroupFieldDataType, GlobalFieldDataType, JsonRTEFieldDataType, ContentTypeSchemaType, ModularBlocksDataType, ModuleConstructorParam, ReferenceFieldDataType, EntryRefErrorReturnType, EntryGroupFieldDataType, EntryGlobalFieldDataType, EntryJsonRTEFieldDataType, EntryModularBlocksDataType, EntryReferenceFieldDataType } from '../types';
 export default class Entries {
     log: LogFn;
-    private fix;
+    protected fix: boolean;
     fileName: string;
     locales: Locale[];
     config: ConfigType;
@@ -11,7 +11,7 @@ export default class Entries {
     currentTitle: string;
     gfSchema: ContentTypeStruct[];
     ctSchema: ContentTypeStruct[];
-    private entries;
+    protected entries: Record<string, EntryStruct>;
     protected missingRefs: Record<string, any>;
     entryMetaData: Record<string, any>[];
     moduleName: keyof typeof auditConfig.moduleConfig;

package/lib/modules/entries.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const find_1 = tslib_1.__importDefault(require("lodash/find"));
-const core_1 = require("@oclif/core");
 const values_1 = tslib_1.__importDefault(require("lodash/values"));
 const isEmpty_1 = tslib_1.__importDefault(require("lodash/isEmpty"));
 const path_1 = require("path");
@@ -10,6 +9,7 @@ const cli_utilities_1 = require("@contentstack/cli-utilities");
 const fs_1 = require("fs");
 const content_types_1 = tslib_1.__importDefault(require("./content-types"));
 const messages_1 = require("../messages");
+const global_fields_1 = tslib_1.__importDefault(require("./global-fields"));
 class Entries {
     constructor({ log, fix, config, moduleName, ctSchema, gfSchema }) {
         this.missingRefs = {};
@@ -38,7 +38,7 @@ class Entries {
         for (const { code } of this.locales) {
             for (const ctSchema of this.ctSchema) {
                 const basePath = (0, path_1.join)(this.folderPath, ctSchema.uid, code);
-                const fsUtility = new cli_utilities_1.FsUtility({ basePath, indexFileName: 'index.json' });
+                const fsUtility = new cli_utilities_1.FsUtility({ basePath, indexFileName: 'index.json', createDirIfNotExist: false });
                 const indexer = fsUtility.indexFileContent;
                 for (const fileIndex in indexer) {
                     const entries = (await fsUtility.readChunkFiles.next());
@@ -89,11 +89,11 @@ class Entries {
             ctSchema: this.ctSchema,
             gfSchema: this.gfSchema,
         }).run(true));
-        this.gfSchema = (await new content_types_1.default({
+        this.gfSchema = (await new global_fields_1.default({
             fix: true,
             log: () => { },
             config: this.config,
-            moduleName: 'entries',
+            moduleName: 'global-fields',
             ctSchema: this.ctSchema,
             gfSchema: this.gfSchema,
         }).run(true));
@@ -104,11 +104,13 @@ class Entries {
      */
     async writeFixContent(filePath, schema) {
         let canWrite = true;
-        if (this.fix && !this.config.flags['copy-dir']) {
-            canWrite = this.config.flags.yes || (await core_1.ux.confirm(messages_1.commonMsg.FIX_CONFIRMATION));
-        }
-        if (canWrite) {
-            (0, fs_1.writeFileSync)(filePath, JSON.stringify(schema));
+        if (this.fix) {
+            if (!this.config.flags['copy-dir']) {
+                canWrite = this.config.flags.yes || (await cli_utilities_1.ux.confirm(messages_1.commonMsg.FIX_CONFIRMATION));
+            }
+            if (canWrite) {
+                (0, fs_1.writeFileSync)(filePath, JSON.stringify(schema));
+            }
         }
     }
     /**
@@ -131,7 +133,7 @@ class Entries {
         for (const child of (_a = field.schema) !== null && _a !== void 0 ? _a : []) {
             const { uid } = child;
             if (!(entry === null || entry === void 0 ? void 0 : entry[uid]))
-                return;
+                continue;
             switch (child.data_type) {
                 case 'reference':
                     this.missingRefs[this.currentUid].push(...this.validateReferenceField([...tree, { uid: child.uid, name: child.display_name, field: uid }], child, entry[uid]));
@@ -203,7 +205,6 @@ class Entries {
      */
     validateJsonRTEFields(tree, fieldStructure, field) {
         var _a;
-        // const missingRefIndex = []
         // NOTE Other possible reference logic will be added related to JSON RTE (Ex missing assets, extensions etc.,)
         for (const index in (_a = field === null || field === void 0 ? void 0 : field.children) !== null && _a !== void 0 ? _a : []) {
             const child = field.children[index];

package/lib/modules/global-fields.d.ts

@@ -6,7 +6,7 @@ export default class GlobalField extends ContentType {
      * references.
      * @returns the value of the variable `missingRefs`.
      */
-    run(): Promise<Record<string, any>>;
+    run(returnFixSchema?: boolean): Promise<Record<string, any>>;
     /**
      * The function validates a field containing modular blocks by traversing each block and checking for
      * references in a given tree.

package/lib/modules/global-fields.js

@@ -8,9 +8,9 @@ class GlobalField extends content_types_1.default {
      * references.
      * @returns the value of the variable `missingRefs`.
      */
-    async run() {
+    async run(returnFixSchema = false) {
         // NOTE add any validation if required
-        const missingRefs = await super.run();
+        const missingRefs = await super.run(returnFixSchema);
         return missingRefs;
     }
     /**

package/lib/types/common.d.ts

@@ -0,0 +1,5 @@
+import { ux } from "@contentstack/cli-utilities";
+type IFlags = typeof ux.table.Flags;
+type IncludeFlags<T, K extends keyof T> = Pick<T, K>;
+type CommandNames = 'cm:stacks:audit' | 'cm:stacks:audit:fix';
+export { IFlags, IncludeFlags, CommandNames };

package/lib/types/common.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/content-types.d.ts

@@ -73,4 +73,4 @@ declare enum OutputColumn {
     'Missing references' = "missingRefs",
     Path = "treeStr"
 }
-export { CtConstructorParam, ContentTypeStruct, ModuleConstructorParam, ReferenceFieldDataType, GlobalFieldDataType, CustomFieldDataType, JsonRTEFieldDataType, GroupFieldDataType, ModularBlocksDataType, RefErrorReturnType, ModularBlocksSchemaTypes, ModularBlockType, OutputColumn, ContentTypeSchemaType, };
+export { CtConstructorParam, ContentTypeStruct, ModuleConstructorParam, ReferenceFieldDataType, GlobalFieldDataType, CustomFieldDataType, JsonRTEFieldDataType, GroupFieldDataType, ModularBlocksDataType, RefErrorReturnType, ModularBlocksSchemaTypes, ModularBlockType, OutputColumn, ContentTypeSchemaType, GlobalFieldSchemaTypes, };

package/lib/types/index.d.ts

@@ -1,3 +1,4 @@
-export * from "./utils";
+export * from './utils';
+export * from './common';
 export * from './entries';
 export * from './content-types';

package/lib/types/index.js

@@ -2,5 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./utils"), exports);
+tslib_1.__exportStar(require("./common"), exports);
 tslib_1.__exportStar(require("./entries"), exports);
 tslib_1.__exportStar(require("./content-types"), exports);

package/lib/util/flags.d.ts

@@ -0,0 +1,10 @@
+import { IFlags, IncludeFlags } from '../types';
+/**
+ * The function `getTableFlags` returns a set of table flags based on the specified columns, with
+ * updated descriptions and help groups.
+ * @param {(keyof IFlags)[]} columns - An optional array of column keys from the IFlags interface. The
+ * default value is ['columns', 'sort', 'filter', 'csv', 'no-truncate'].
+ * @returns an object of type `IncludeFlags<IFlags, keyof IFlags>`.
+ */
+declare function getTableFlags(columns?: (keyof IFlags)[]): IncludeFlags<IFlags, keyof IFlags>;
+export { getTableFlags };

package/lib/util/flags.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTableFlags = void 0;
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const messages_1 = require("../messages");
+/**
+ * The function `getTableFlags` returns a set of table flags based on the specified columns, with
+ * updated descriptions and help groups.
+ * @param {(keyof IFlags)[]} columns - An optional array of column keys from the IFlags interface. The
+ * default value is ['columns', 'sort', 'filter', 'csv', 'no-truncate'].
+ * @returns an object of type `IncludeFlags<IFlags, keyof IFlags>`.
+ */
+function getTableFlags(columns = ['columns', 'sort', 'filter', 'csv', 'no-truncate']) {
+    const flags = cli_utilities_1.ux.table.flags({
+        only: columns,
+    });
+    // NOTE Assign group and update Descriptions
+    columns.forEach((element) => {
+        var _a;
+        flags[element].helpGroup = 'TABLE';
+        const descriptionKey = `TABLE_${element.toUpperCase()}`;
+        flags[element].description = (_a = messages_1.tableColumnDescriptions[descriptionKey]) !== null && _a !== void 0 ? _a : flags[element].description;
+    });
+    return flags;
+}
+exports.getTableFlags = getTableFlags;

package/lib/util/index.d.ts

@@ -1 +1,2 @@
-export { default as Logger } from "./log";
+export * from './flags';
+export { default as Logger, print } from './log';

package/lib/util/index.js

@@ -1,8 +1,8 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Logger = void 0;
+exports.print = exports.Logger = void 0;
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./flags"), exports);
 var log_1 = require("./log");
-Object.defineProperty(exports, "Logger", { enumerable: true, get: function () { return __importDefault(log_1).default; } });
+Object.defineProperty(exports, "Logger", { enumerable: true, get: function () { return tslib_1.__importDefault(log_1).default; } });
+Object.defineProperty(exports, "print", { enumerable: true, get: function () { return log_1.print; } });

package/lib/util/log.js

@@ -4,7 +4,6 @@ exports.print = void 0;
 const tslib_1 = require("tslib");
 const map_1 = tslib_1.__importDefault(require("lodash/map"));
 const winston_1 = tslib_1.__importDefault(require("winston"));
-const fs_1 = require("fs");
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const replace_1 = tslib_1.__importDefault(require("lodash/replace"));
 const isObject_1 = tslib_1.__importDefault(require("lodash/isObject"));
@@ -52,26 +51,18 @@ class Logger {
         if (logType === 'error') {
             consoleOptions.level = logType;
         }
-        if ((0, fs_1.existsSync)(this.config.basePath)) {
-            const filename = (0, path_1.normalize)((0, path_1.resolve)(this.config.basePath, 'logs', `${logType}.log`)).replace(/^(\.\.(\/|\\|$))+/, '');
-            const loggerOptions = {
-                transports: [
-                    new winston_1.default.transports.File(Object.assign(Object.assign({}, this.loggerOptions), { level: logType, filename })),
-                    new winston_1.default.transports.Console(consoleOptions),
-                ],
-                levels: customLevels.levels,
-            };
-            if (logType === 'error') {
-                loggerOptions.levels = { error: 0 };
-            }
-            return winston_1.default.createLogger(loggerOptions);
+        const filename = (0, path_1.normalize)((0, path_1.resolve)(this.config.basePath, 'logs', `${logType}.log`)).replace(/^(\.\.(\/|\\|$))+/, '');
+        const loggerOptions = {
+            transports: [
+                new winston_1.default.transports.File(Object.assign(Object.assign({}, this.loggerOptions), { level: logType, filename })),
+                new winston_1.default.transports.Console(consoleOptions),
+            ],
+            levels: customLevels.levels,
+        };
+        if (logType === 'error') {
+            loggerOptions.levels = { error: 0 };
         }
-        winston_1.default
-            .createLogger({
-            transports: [new winston_1.default.transports.Console(consoleOptions)],
-        })
-            .error('Provided base path is not valid');
-        throw new Error('Provided base path is not valid');
+        return winston_1.default.createLogger(loggerOptions);
     }
     /**
      * The function `log` takes a message and an optional log type, and logs the message using different
@@ -108,7 +99,7 @@ class Logger {
         let returnStr = '';
         const replaceCredentials = (item) => {
             try {
-                return JSON.stringify(item).replace(/authtoken":"abc................/g, 'authtoken":"abc....');
+                return JSON.stringify(item).replace(/"authtoken":\s*".*?"/, '"authtoken": "..."');
             }
             catch (error) { }
             return item;

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.2.1",
+  "version": "1.3.0",
   "commands": {
     "cm:stacks:audit:fix": {
       "id": "cm:stacks:audit:fix",
@@ -16,6 +16,7 @@
         "$ <%= 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 %> --fix-only=reference,global_field --copy-dir",
         "$ <%= 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>"
       ],
@@ -25,6 +26,7 @@
           "type": "option",
           "char": "c",
           "description": "Path of the external config",
+          "helpGroup": "COMMON",
           "multiple": false
         },
         "data-dir": {
@@ -32,6 +34,7 @@
           "type": "option",
           "char": "d",
           "description": "Path where the data is stored",
+          "helpGroup": "COMMON",
           "multiple": false
         },
         "report-path": {
@@ -73,6 +76,20 @@
             "copy-dir"
           ]
         },
+        "fix-only": {
+          "name": "fix-only",
+          "type": "option",
+          "description": "Provide the list of fix options",
+          "multiple": true,
+          "options": [
+            "reference",
+            "global_field",
+            "json:rte",
+            "json:custom-field",
+            "blocks",
+            "group"
+          ]
+        },
         "yes": {
           "name": "yes",
           "type": "boolean",
@@ -84,7 +101,8 @@
         "columns": {
           "name": "columns",
           "type": "option",
-          "description": "only show provided columns (comma-separated)",
+          "description": "Show only the specified columns (comma-separated)",
+          "helpGroup": "TABLE",
           "multiple": false,
           "exclusive": [
             "extended"
@@ -93,19 +111,22 @@
         "sort": {
           "name": "sort",
           "type": "option",
-          "description": "property to sort by (prepend '-' for descending)",
+          "description": "Property to sort by (prepend '-' for descending)",
+          "helpGroup": "TABLE",
           "multiple": false
         },
         "filter": {
           "name": "filter",
           "type": "option",
-          "description": "filter property by partial string matching, ex: name=foo",
+          "description": "Filter property by partial string matching. For example: name=foo",
+          "helpGroup": "TABLE",
           "multiple": false
         },
         "csv": {
           "name": "csv",
           "type": "boolean",
-          "description": "output is csv format [alias: --output=csv]",
+          "description": "The output is in the CSV format [alias: --output=csv]",
+          "helpGroup": "TABLE",
           "allowNo": false,
           "exclusive": [
             "no-truncate"
@@ -114,7 +135,8 @@
         "no-truncate": {
           "name": "no-truncate",
           "type": "boolean",
-          "description": "do not truncate output to fit screen",
+          "description": "The output is not truncated to fit the screen",
+          "helpGroup": "TABLE",
           "allowNo": false,
           "exclusive": [
             "csv"
@@ -147,6 +169,7 @@
           "type": "option",
           "char": "c",
           "description": "Path of the external config",
+          "helpGroup": "COMMON",
           "multiple": false
         },
         "data-dir": {
@@ -154,6 +177,7 @@
           "type": "option",
           "char": "d",
           "description": "Path where the data is stored",
+          "helpGroup": "COMMON",
           "multiple": false
         },
         "report-path": {
@@ -183,7 +207,8 @@
         "columns": {
           "name": "columns",
           "type": "option",
-          "description": "only show provided columns (comma-separated)",
+          "description": "Show only the specified columns (comma-separated)",
+          "helpGroup": "TABLE",
           "multiple": false,
           "exclusive": [
             "extended"
@@ -192,19 +217,22 @@
         "sort": {
           "name": "sort",
           "type": "option",
-          "description": "property to sort by (prepend '-' for descending)",
+          "description": "Property to sort by (prepend '-' for descending)",
+          "helpGroup": "TABLE",
           "multiple": false
         },
         "filter": {
           "name": "filter",
           "type": "option",
-          "description": "filter property by partial string matching, ex: name=foo",
+          "description": "Filter property by partial string matching. For example: name=foo",
+          "helpGroup": "TABLE",
           "multiple": false
         },
         "csv": {
           "name": "csv",
           "type": "boolean",
-          "description": "output is csv format [alias: --output=csv]",
+          "description": "The output is in the CSV format [alias: --output=csv]",
+          "helpGroup": "TABLE",
           "allowNo": false,
           "exclusive": [
             "no-truncate"
@@ -213,7 +241,8 @@
         "no-truncate": {
           "name": "no-truncate",
           "type": "boolean",
-          "description": "do not truncate output to fit screen",
+          "description": "The output is not truncated to fit the screen",
+          "helpGroup": "TABLE",
           "allowNo": false,
           "exclusive": [
             "csv"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-audit",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "Contentstack audit plugin",
   "author": "Contentstack CLI",
   "homepage": "https://github.com/contentstack/cli",
@@ -18,8 +18,8 @@
     "/oclif.manifest.json"
   ],
   "dependencies": {
-    "@contentstack/cli-command": "~1.2.15",
-    "@contentstack/cli-utilities": "~1.5.5",
+    "@contentstack/cli-command": "~1.2.16",
+    "@contentstack/cli-utilities": "~1.5.7",
     "@oclif/plugin-help": "^5",
     "@oclif/plugin-plugins": "^3.8.4",
     "chalk": "^4.1.2",
@@ -30,6 +30,7 @@
     "winston": "^3.10.0"
   },
   "devDependencies": {
+    "@contentstack/cli-dev-dependencies": "^1.2.4",
     "@oclif/test": "^2.0.3",
     "@types/chai": "^4.3.5",
     "@types/fs-extra": "^11.0.2",
@@ -41,8 +42,10 @@
     "eslint-config-oclif-typescript": "^1.0.3",
     "mocha": "^10.2.0",
     "nyc": "^15.1.0",
-    "oclif": "^3.10.0",
+    "oclif": "^3",
     "shx": "^0.3.4",
+    "sinon": "^17.0.0",
+    "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
     "tslib": "^2.5.3",
     "typescript": "^5.1.3"