From 43810801394441ff1982bdef1df3d6f1191e9a25 Mon Sep 17 00:00:00 2001
From: Antony <antonyagustineraj@gmail.com>
Date: Wed, 20 Sep 2023 21:45:53 +0530
Subject: [PATCH 1/2] Feat: Global field audit functionality added

---
 package-lock.json                             |   2 -
 packages/contentstack-audit/README.md         |  43 +++-
 .../src/commands/cm/stacks/audit/index.ts     | 220 ++++++++++++++----
 .../contentstack-audit/src/config/index.ts    |  10 +-
 .../contentstack-audit/src/messages/index.ts  |   3 +-
 .../src/modules/content-types.ts              | 156 +++++--------
 .../src/modules/global-fields.ts              |  45 ++++
 .../src/types/content-types.ts                |  14 +-
 pnpm-lock.yaml                                |   2 -
 9 files changed, 343 insertions(+), 152 deletions(-)
 create mode 100644 packages/contentstack-audit/src/modules/global-fields.ts

diff --git a/package-lock.json b/package-lock.json
index a75d027b2f..07785bc25f 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -22953,7 +22953,6 @@
         "@contentstack/cli-migration": "~1.3.13",
         "@contentstack/cli-utilities": "~1.5.2",
         "@contentstack/management": "~1.10.0",
-        "@oclif/core": "^2.9.3",
         "@oclif/plugin-help": "^5",
         "@oclif/plugin-not-found": "^2.4.0",
         "@oclif/plugin-plugins": "^3.3.2",
@@ -27004,7 +27003,6 @@
         "@contentstack/cli-migration": "~1.3.13",
         "@contentstack/cli-utilities": "~1.5.2",
         "@contentstack/management": "~1.10.0",
-        "@oclif/core": "^2.9.3",
         "@oclif/plugin-help": "^5",
         "@oclif/plugin-not-found": "^2.4.0",
         "@oclif/plugin-plugins": "^3.3.2",
diff --git a/packages/contentstack-audit/README.md b/packages/contentstack-audit/README.md
index f47b02b851..3dd3db3993 100644
--- a/packages/contentstack-audit/README.md
+++ b/packages/contentstack-audit/README.md
@@ -54,7 +54,7 @@ USAGE
 
 FLAGS
   -c, --config=<value>    Path of the external config
-  -d, --data-dir=<value>  Current working directory.
+  -d, --data-dir=<value>  Path and location where data is stored
 
 DESCRIPTION
   Audit fix command
@@ -74,11 +74,21 @@ Audit and find possible errors in the exported data
 
 ```
 USAGE
-  $ csdx cm:stacks:audit [-c <value>] [-d <value>]
+  $ csdx cm:stacks:audit [-c <value>] [-d <value>] [--report-path <value>] [--reference-only] [--modules
+    content-types|global-fields] [--columns <value> | ] [--sort <value>] [--filter <value>] [--csv | --no-truncate]
 
 FLAGS
   -c, --config=<value>    Path of the external config
-  -d, --data-dir=<value>  Current working directory.
+  -d, --data-dir=<value>  Path and location where 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 list of modules to be audited
+                          <options: content-types|global-fields>
+  --no-truncate           do not truncate output to fit screen
+  --reference-only        Checks only for missing references
+  --report-path=<value>   Path to store the audit reports
+  --sort=<value>          property to sort by (prepend '-' for descending)
 
 DESCRIPTION
   Audit and find possible errors in the exported data
@@ -88,6 +98,14 @@ ALIASES
 
 EXAMPLES
   $ csdx cm:stacks:audit
+
+  $ csdx cm:stacks:audit --report-path=<path>
+
+  $ csdx cm:stacks:audit --report-path=<path> --csv
+
+  $ csdx cm:stacks:audit --report-path=<path> --filter="name=<filter-value>"
+
+  $ csdx cm:stacks:audit --report-path=<path> --modules=content-types --filter="name="<filter-value>"
 ```
 
 _See code: [src/commands/cm/stacks/audit/index.ts](https://github.com/contentstack/audit/blob/main/packages/contentstack-audit/src/commands/cm/stacks/audit/index.ts)_
@@ -102,7 +120,7 @@ USAGE
 
 FLAGS
   -c, --config=<value>    Path of the external config
-  -d, --data-dir=<value>  Current working directory.
+  -d, --data-dir=<value>  Path and location where data is stored
 
 DESCRIPTION
   Audit fix command
@@ -142,11 +160,14 @@ List installed plugins.
 
 ```
 USAGE
-  $ csdx plugins [--core]
+  $ csdx plugins [--json] [--core]
 
 FLAGS
   --core  Show core plugins.
 
+GLOBAL FLAGS
+  --json  Format output as json.
+
 DESCRIPTION
   List installed plugins.
 
@@ -154,7 +175,7 @@ EXAMPLES
   $ csdx plugins
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/index.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.3.2/src/commands/plugins/index.ts)_
 
 ## `csdx plugins:install PLUGIN...`
 
@@ -219,7 +240,7 @@ EXAMPLES
   $ csdx plugins:inspect myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/inspect.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.3.2/src/commands/plugins/inspect.ts)_
 
 ## `csdx plugins:install PLUGIN...`
 
@@ -259,7 +280,7 @@ EXAMPLES
   $ csdx plugins:install someuser/someplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/install.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.3.2/src/commands/plugins/install.ts)_
 
 ## `csdx plugins:link PLUGIN`
 
@@ -288,7 +309,7 @@ EXAMPLES
   $ csdx plugins:link myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/link.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.3.2/src/commands/plugins/link.ts)_
 
 ## `csdx plugins:uninstall PLUGIN...`
 
@@ -336,7 +357,7 @@ ALIASES
   $ csdx plugins:remove
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/uninstall.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.3.2/src/commands/plugins/uninstall.ts)_
 
 ## `csdx plugins:uninstall PLUGIN...`
 
@@ -377,5 +398,5 @@ DESCRIPTION
   Update installed plugins.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/update.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.3.2/src/commands/plugins/update.ts)_
 <!-- commandsstop -->
diff --git a/packages/contentstack-audit/src/commands/cm/stacks/audit/index.ts b/packages/contentstack-audit/src/commands/cm/stacks/audit/index.ts
index 10bc3ea17f..86ba1915e5 100644
--- a/packages/contentstack-audit/src/commands/cm/stacks/audit/index.ts
+++ b/packages/contentstack-audit/src/commands/cm/stacks/audit/index.ts
@@ -1,11 +1,15 @@
-import { resolve } from 'path';
 import chalk from 'chalk';
+import * as csv from 'fast-csv';
+import { join, resolve } from 'path';
 import { FlagInput, Flags, cliux, ux } from '@contentstack/cli-utilities';
+import { createWriteStream, existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
 
 import config from '../../../../config';
 import { auditMsg } from '../../../../messages';
 import { BaseCommand } from '../../../../base-command';
 import ContentType from '../../../../modules/content-types';
+import GlobalField from '../../../../modules/global-fields';
+import { ContentTypeStruct, OutputColumn, RefErrorReturnType } from '../../../../types';
 
 export default class Audit extends BaseCommand<typeof Audit> {
   static aliases: string[] = ['cm:stacks:audit'];
@@ -37,64 +41,67 @@ export default class Audit extends BaseCommand<typeof Audit> {
     }),
   };
 
+  /**
+   * 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(): Promise<void> {
     try {
-      const { flags } = await this.parse(Audit);
-
       await this.promptQueue();
       const reportPath = this.flags['report-path'] || process.cwd();
       this.sharedConfig.reportPath = resolve(reportPath, 'audit-report');
+      let { ctSchema, gfSchema } = this.getCtAndGfSchema();
 
       for (const module of this.sharedConfig.flags.modules || this.sharedConfig.modules) {
+        ux.action.start(this.$t(this.messages.AUDIT_START_SPINNER, { module }));
+
         switch (module) {
           case 'content-types':
-            const ctErrors = await new ContentType({ config: this.sharedConfig, log: this.log }).run();
-            ux.table(
-              Object.values(ctErrors).flat(),
-              {
-                name: {
-                  minWidth: 7,
-                  header: 'Content Type name',
-                },
-                display_name: {
-                  minWidth: 7,
-                  header: 'Field name',
-                },
-                data_type: {
-                  minWidth: 7,
-                  header: 'Field type',
-                },
-                missingRefs: {
-                  minWidth: 7,
-                  header: 'Missing references',
-                  get: (row) => {
-                    return chalk.red(row.missingRefs);
-                  },
-                },
-                treeStr: {
-                  minWidth: 7,
-                  header: 'Path',
-                },
-              },
-              {
-                ...flags,
-              },
-            );
-            this.log(''); // NOTE add new line in terminal
-            this.log(''); // NOTE add new line in terminal
-            break;
-          case 'entries':
+            const missingCtRefs = await new ContentType({
+              ctSchema,
+              gfSchema,
+              log: this.log,
+              moduleName: module,
+              config: this.sharedConfig,
+            }).run();
+
+            await this.prepareReport(module, missingCtRefs);
+            this.showOutputOnScreen(missingCtRefs);
             break;
           case 'global-fields':
+            const missingGfRefs = await new GlobalField({
+              ctSchema,
+              gfSchema,
+              log: this.log,
+              moduleName: module,
+              config: this.sharedConfig,
+            }).run();
+
+            await this.prepareReport(module, missingGfRefs);
+            this.showOutputOnScreen(missingGfRefs);
+            break;
+          case 'entries':
             break;
         }
+
+        ux.action.stop();
+        this.log('');
       }
+
+      this.log(this.$t(auditMsg.FINAL_REPORT_PATH, { path: this.sharedConfig.reportPath }), 'warn');
     } catch (error) {
+      console.trace(error);
+      console.log(error);
       this.log(error instanceof Error ? error.message : error, 'error');
+      ux.action.stop('Process failed.!');
       this.exit(1);
     }
   }
 
+  /**
+   * 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 =
@@ -105,4 +112,139 @@ export default class Audit extends BaseCommand<typeof Audit> {
         message: this.messages.DATA_DIR,
       }));
   }
+
+  /**
+   * 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() {
+    let ctSchema = JSON.parse(
+      readFileSync(
+        join(
+          this.sharedConfig.basePath,
+          this.sharedConfig.moduleConfig['content-types'].dirName,
+          this.sharedConfig.moduleConfig['content-types'].fileName,
+        ),
+        'utf-8',
+      ),
+    ) as ContentTypeStruct[];
+    let gfSchema = JSON.parse(
+      readFileSync(
+        join(
+          this.sharedConfig.basePath,
+          this.sharedConfig.moduleConfig['global-fields'].dirName,
+          this.sharedConfig.moduleConfig['global-fields'].fileName,
+        ),
+        'utf-8',
+      ),
+    ) as ContentTypeStruct[];
+
+    return { ctSchema, gfSchema };
+  }
+
+  /**
+   * The function `showOutputOnScreen` displays data in a table format on the screen, with specific
+   * column headers and formatting options.
+   * @param data - The `data` parameter is a record object that contains information about fields. Each
+   * field is represented by a key-value pair, where the key is the field name and the value is an
+   * object containing various properties such as `name`, `display_name`, `data_type`, `missingRefs`,
+   * and `
+   */
+  showOutputOnScreen(data: Record<string, any>) {
+    ux.table(
+      Object.values(data).flat(),
+      {
+        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.red(row.missingRefs);
+          },
+        },
+        treeStr: {
+          minWidth: 7,
+          header: 'Path',
+        },
+      },
+      {
+        ...this.flags,
+      },
+    );
+    this.log(''); // NOTE add new line in terminal
+  }
+
+  /**
+   * The `prepareReport` function takes a module name and a list of missing references, and generates a
+   * report in both JSON and CSV formats.
+   * @param moduleName - The `moduleName` parameter is a string that represents the name of a module.
+   * It is used to generate the filenames for the report files (JSON and CSV).
+   * @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 `prepareReport` returns a Promise that resolves to `void`.
+   */
+  prepareReport(moduleName: keyof typeof config.moduleConfig, listOfMissingRefs: Record<string, any>): Promise<void> {
+    return new Promise<void>((resolve, reject) => {
+      if (!existsSync(this.sharedConfig.reportPath)) {
+        mkdirSync(this.sharedConfig.reportPath, { recursive: true });
+      }
+
+      // NOTE write int json
+      writeFileSync(join(this.sharedConfig.reportPath, `${moduleName}.json`), JSON.stringify(listOfMissingRefs));
+      this.log(''); // NOTE add new line in terminal
+
+      // NOTE write into CSV
+      const csvStream = csv.format({ headers: true });
+      const csvPath = join(this.sharedConfig.reportPath, `${moduleName}.csv`);
+      const assetFileStream = createWriteStream(csvPath);
+      assetFileStream.on('error', (error) => {
+        throw error;
+      });
+      csvStream
+        .pipe(assetFileStream)
+        .on('close', () => {
+          resolve();
+          this.log(''); // NOTE add new line in terminal
+        })
+        .on('error', reject);
+
+      const defaultColumns = Object.keys(OutputColumn);
+      const userDefinedColumns = this.sharedConfig.flags.columns ? this.sharedConfig.flags.columns.split(',') : null;
+      let missingRefs: RefErrorReturnType[] = Object.values(listOfMissingRefs).flat();
+      const columns: (keyof typeof OutputColumn)[] = userDefinedColumns
+        ? [...userDefinedColumns, ...defaultColumns.filter((val: string) => !userDefinedColumns.includes(val))]
+        : defaultColumns;
+
+      if (this.sharedConfig.flags.filter) {
+        const [column, value]: [keyof typeof OutputColumn, string] = this.sharedConfig.flags.filter.split('=');
+        missingRefs = missingRefs.filter((row: RefErrorReturnType) => row[OutputColumn[column]] === value);
+      }
+
+      for (const issue of missingRefs) {
+        let row: Record<string, string | string[]> = {};
+
+        for (const column of columns) {
+          row[column] = issue[OutputColumn[column]];
+        }
+
+        csvStream.write(row);
+      }
+
+      csvStream.end();
+    });
+  }
 }
diff --git a/packages/contentstack-audit/src/config/index.ts b/packages/contentstack-audit/src/config/index.ts
index a960324642..7c67846780 100644
--- a/packages/contentstack-audit/src/config/index.ts
+++ b/packages/contentstack-audit/src/config/index.ts
@@ -1,10 +1,16 @@
 const config = {
-  modules: ['content-types', 'entries', 'global-fields'],
+  modules: ['content-types', 'global-fields'],
   skipRefs: ['sys_assets'],
   moduleConfig: {
     'content-types': {
+      name: 'content type',
+      fileName: 'schema.json',
       dirName: 'content_types',
-      fileName: 'content_types.json',
+    },
+    'global-fields': {
+      name: 'global field',
+      dirName: 'global_fields',
+      fileName: 'globalfields.json',
     },
   },
 };
diff --git a/packages/contentstack-audit/src/messages/index.ts b/packages/contentstack-audit/src/messages/index.ts
index 27321b8733..a571e4cf1a 100644
--- a/packages/contentstack-audit/src/messages/index.ts
+++ b/packages/contentstack-audit/src/messages/index.ts
@@ -11,9 +11,10 @@ const commonMsg = {
 const auditMsg = {
   REPORT_PATH: 'Path to store the audit reports',
   MODULES: 'Provide list of modules to be audited',
+  AUDIT_START_SPINNER: 'Starting {module} scanning',
   REFERENCE_ONLY: 'Checks only for missing references',
   NOT_VALID_PATH: "Provided path: '{path}' is not valid",
-  SCAN_CT_SUCCESS_MSG: "The scanning of content type '{title}' has been successfully finished.",
+  SCAN_CT_SUCCESS_MSG: "The scanning of {module} '{title}' has been successfully finished.",
   FINAL_REPORT_PATH: "Writing reports completed. You can find reports at '{path}'",
 };
 
diff --git a/packages/contentstack-audit/src/modules/content-types.ts b/packages/contentstack-audit/src/modules/content-types.ts
index a5f3463722..91e779471a 100644
--- a/packages/contentstack-audit/src/modules/content-types.ts
+++ b/packages/contentstack-audit/src/modules/content-types.ts
@@ -1,122 +1,75 @@
 import { join } from 'path';
 import find from 'lodash/find';
-import * as csv from 'fast-csv';
-import { createWriteStream, existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
+import { existsSync } from 'fs';
 
 import {
   LogFn,
   ConfigType,
-  OutputColumn,
   ModularBlockType,
   ContentTypeStruct,
   GroupFieldDataType,
   RefErrorReturnType,
+  CtConstructorParam,
   GlobalFieldDataType,
   JsonRTEFieldDataType,
   ModularBlocksDataType,
   ModuleConstructorParam,
   ReferenceFieldDataType,
 } from '../types';
+import auditConfig from '../config';
 import { $t, auditMsg } from '../messages';
 
 /* The `ContentType` class is responsible for scanning content types, looking for references, and
 generating a report in JSON and CSV formats. */
 export default class ContentType {
-  private log: LogFn;
-  private config: ConfigType;
-  private folderPath: string;
-  private currentCTId!: string;
-  private currentCTName!: string;
-  private ctErrors: Record<string, any> = {};
-  private contentTypes: ContentTypeStruct[] = [];
+  public log: LogFn;
+  public fileName: string;
+  public config: ConfigType;
+  public folderPath: string;
+  public currentUid!: string;
+  public currentTitle!: string;
+  public gfSchema: ContentTypeStruct[];
+  public ctSchema: ContentTypeStruct[];
+  protected schema: ContentTypeStruct[] = [];
+  protected missingRefs: Record<string, any> = {};
+  public moduleName: keyof typeof auditConfig.moduleConfig = 'content-types';
 
-  constructor({ log, config }: ModuleConstructorParam) {
+  constructor({ log, config, moduleName, ctSchema, gfSchema }: ModuleConstructorParam & CtConstructorParam) {
     this.log = log;
     this.config = config;
-    this.folderPath = join(config.basePath, config.moduleConfig['content-types'].dirName);
+    this.ctSchema = ctSchema;
+    this.gfSchema = gfSchema;
+    this.fileName = config.moduleConfig[this.moduleName].fileName;
+    this.folderPath = join(config.basePath, config.moduleConfig[this.moduleName].dirName);
+
+    if (moduleName) this.moduleName = moduleName;
   }
 
   /**
-   * The above function scans content types, looks for references, and generates a report in both JSON
-   * and CSV formats.
-   * @returns The function `run()` returns the `ctErrors` object.
+   * The `run` function checks if a folder path exists, sets the schema based on the module name,
+   * iterates over the schema and looks for references, and returns a list of missing references.
+   * @returns the `missingRefs` object.
    */
   async run() {
     if (!existsSync(this.folderPath)) {
       throw new Error($t(auditMsg.NOT_VALID_PATH, { path: this.folderPath }));
     }
 
-    this.contentTypes = JSON.parse(readFileSync(join(this.folderPath, 'schema.json'), 'utf-8')); // TODO check size
+    this.schema = this.moduleName === 'content-types' ? this.ctSchema : this.gfSchema;
 
-    for (const ct of this.contentTypes) {
-      this.currentCTId = ct.uid;
-      this.currentCTName = ct.title;
-      this.ctErrors[this.currentCTId] = [];
-      const { uid, title } = ct;
-      await this.lookForReference([{ uid, name: title }], ct);
-      this.log($t(auditMsg.SCAN_CT_SUCCESS_MSG, { title }), 'info');
+    for (const schema of this.schema ?? []) {
+      this.currentUid = schema.uid;
+      this.currentTitle = schema.title;
+      this.missingRefs[this.currentUid] = [];
+      const { uid, title } = schema;
+      await this.lookForReference([{ uid, name: title }], schema);
+      this.log(
+        $t(auditMsg.SCAN_CT_SUCCESS_MSG, { title, module: this.config.moduleConfig[this.moduleName].name }),
+        'info',
+      );
     }
 
-    await this.prepareReport();
-
-    return this.ctErrors;
-  }
-
-  /**
-   * The `prepareReport` function prepares a report by writing content types errors into a JSON file
-   * and a CSV file.
-   * @returns The `prepareReport()` function returns a Promise that resolves to `void`.
-   */
-  prepareReport(): Promise<void> {
-    return new Promise<void>((resolve, reject) => {
-      if (!existsSync(this.config.reportPath)) {
-        mkdirSync(this.config.reportPath, { recursive: true });
-      }
-
-      // NOTE write int json
-      writeFileSync(join(this.config.reportPath, 'content-types.json'), JSON.stringify(this.ctErrors));
-      this.log(''); // NOTE add new line in terminal
-
-      // NOTE write into CSV
-      const csvStream = csv.format({ headers: true });
-      const csvPath = join(this.config.reportPath, 'content-types.csv');
-      const assetFileStream = createWriteStream(csvPath);
-      assetFileStream.on('error', (error) => {
-        throw error;
-      });
-      csvStream
-        .pipe(assetFileStream)
-        .on('close', () => {
-          resolve();
-          this.log($t(auditMsg.FINAL_REPORT_PATH, { path: this.config.reportPath }), 'warn');
-          this.log(''); // NOTE add new line in terminal
-        })
-        .on('error', reject);
-
-      const defaultColumns = Object.keys(OutputColumn);
-      const userDefinedColumns = this.config.flags.columns ? this.config.flags.columns.split(',') : null;
-      let ctRefIssues: RefErrorReturnType[] = Object.values(this.ctErrors).flat();
-      const columns: (keyof typeof OutputColumn)[] = userDefinedColumns
-        ? [...userDefinedColumns, ...defaultColumns.filter((val: string) => !userDefinedColumns.includes(val))]
-        : defaultColumns;
-
-      if (this.config.flags.filter) {
-        const [column, value]: [keyof typeof OutputColumn, string] = this.config.flags.filter.split('=');
-        ctRefIssues = ctRefIssues.filter((row: RefErrorReturnType) => row[OutputColumn[column]] === value);
-      }
-
-      for (const issue of ctRefIssues) {
-        let row: Record<string, string | string[]> = {};
-
-        for (const column of columns) {
-          row[column] = issue[OutputColumn[column]];
-        }
-
-        csvStream.write(row);
-      }
-
-      csvStream.end();
-    });
+    return this.missingRefs;
   }
 
   /**
@@ -134,10 +87,10 @@ export default class ContentType {
     tree: Record<string, unknown>[],
     { schema }: ContentTypeStruct | GlobalFieldDataType | ModularBlockType | GroupFieldDataType,
   ): Promise<void> {
-    for (const field of schema) {
+    for (const field of schema ?? []) {
       switch (field.data_type) {
         case 'reference':
-          this.ctErrors[this.currentCTId].push(
+          this.missingRefs[this.currentUid].push(
             ...this.validateReferenceField(
               [...tree, { uid: field.uid, name: field.display_name }],
               field as ReferenceFieldDataType,
@@ -155,7 +108,7 @@ export default class ContentType {
             // NOTE Custom field type
           } else if (field.field_metadata.allow_json_rte) {
             // NOTE JSON RTE field type
-            this.ctErrors[this.currentCTId].push(
+            this.missingRefs[this.currentUid].push(
               ...this.validateJsonRTEFields(
                 [...tree, { uid: field.uid, name: field.display_name }],
                 field as ReferenceFieldDataType,
@@ -202,6 +155,25 @@ export default class ContentType {
    */
   async validateGlobalField(tree: Record<string, unknown>[], field: GlobalFieldDataType): Promise<void> {
     // NOTE Any GlobalField related logic can be added here
+    const missingRefs = [];
+    const { reference_to, display_name, data_type } = field;
+
+    if (!find(this.gfSchema, { uid: reference_to })) {
+      missingRefs.push(reference_to);
+    }
+
+    if (missingRefs.length) {
+      this.missingRefs[this.currentUid].push({
+        tree,
+        data_type,
+        missingRefs,
+        display_name,
+        ct_uid: this.currentUid,
+        name: this.currentTitle,
+        treeStr: tree.map(({ name }) => name).join(' ➜ '),
+      });
+    }
+
     await this.lookForReference(tree, field);
   }
 
@@ -236,7 +208,7 @@ export default class ContentType {
     for (const block of blocks) {
       const { uid, title } = block;
 
-      await this.lookForReference([...tree, { uid, name: title }, { uid: field.uid, name: field.display_name }], block);
+      await this.lookForReference([...tree, { uid, name: title }], block);
     }
   }
 
@@ -272,11 +244,11 @@ export default class ContentType {
     const missingRefs = [];
     const { reference_to, display_name, data_type } = field;
 
-    for (const reference of reference_to) {
-      // NOTE can skip specific references keys (Ex, system defined keys can be skipped)
+    for (const reference of reference_to ?? []) {
+      // NOTE Can skip specific references keys (Ex, system defined keys can be skipped)
       if (this.config.skipRefs.includes(reference)) continue;
 
-      const refExist = find(this.contentTypes, { uid: reference });
+      const refExist = find(this.ctSchema, { uid: reference });
 
       if (!refExist) {
         missingRefs.push(reference);
@@ -290,8 +262,8 @@ export default class ContentType {
             data_type,
             missingRefs,
             display_name,
-            ct_uid: this.currentCTId,
-            name: this.currentCTName,
+            ct_uid: this.currentUid,
+            name: this.currentTitle,
             treeStr: tree.map(({ name }) => name).join(' ➜ '),
           },
         ]
diff --git a/packages/contentstack-audit/src/modules/global-fields.ts b/packages/contentstack-audit/src/modules/global-fields.ts
new file mode 100644
index 0000000000..d9467d8de3
--- /dev/null
+++ b/packages/contentstack-audit/src/modules/global-fields.ts
@@ -0,0 +1,45 @@
+import ContentType from './content-types';
+import { GroupFieldDataType, ModularBlocksDataType } from '../types';
+
+export default class GlobalField extends ContentType {
+  /**
+   * The above function is an asynchronous function that runs a validation and returns any missing
+   * references.
+   * @returns the value of the variable `missingRefs`.
+   */
+  async run() {
+    // NOTE add any validation if required
+    const missingRefs = await super.run();
+
+    return missingRefs;
+  }
+
+  /**
+   * The function validates a field containing modular blocks by traversing each block and checking for
+   * references in a given tree.
+   * @param {Record<string, unknown>[]} tree - The `tree` parameter is an array of objects that
+   * represents a tree structure. Each object in the array represents a node in the tree.
+   * @param {ModularBlocksDataType} field - The `field` parameter is of type `ModularBlocksDataType`.
+   */
+  async validateModularBlocksField(tree: Record<string, unknown>[], field: ModularBlocksDataType): Promise<void> {
+    const { blocks } = field;
+
+    // NOTE Traverse each and every module and look for reference
+    for (const block of blocks) {
+      await this.lookForReference(tree, block);
+    }
+  }
+
+  /**
+   * The function "validateGroupField" performs group field validation by looking for a reference in a
+   * tree structure.
+   * @param {Record<string, unknown>[]} tree - The `tree` parameter is an array of objects representing
+   * a tree structure. Each object in the array represents a node in the tree and has properties like
+   * `uid` and `name`.
+   * @param {GroupFieldDataType} field - The `field` parameter is of type `GroupFieldDataType`.
+   */
+  async validateGroupField(tree: Record<string, unknown>[], field: GroupFieldDataType): Promise<void> {
+    // NOTE Any Group Field related logic can be added here (Ex data serialization or picking any metadata for report etc.,)
+    await this.lookForReference([...tree, { uid: field.uid, name: field.display_name }], field);
+  }
+}
diff --git a/packages/contentstack-audit/src/types/content-types.ts b/packages/contentstack-audit/src/types/content-types.ts
index dbe47ea84a..e0e3086f25 100644
--- a/packages/contentstack-audit/src/types/content-types.ts
+++ b/packages/contentstack-audit/src/types/content-types.ts
@@ -1,10 +1,11 @@
+import config from '../config';
 import { ConfigType, LogFn } from './utils';
 
 type ContentTypeStruct = {
   uid: string;
   title: string;
   description: string;
-  schema: (
+  schema?: (
     | ReferenceFieldDataType
     | GlobalFieldDataType
     | CustomFieldDataType
@@ -17,6 +18,12 @@ type ContentTypeStruct = {
 type ModuleConstructorParam = {
   log: LogFn;
   config: ConfigType;
+  moduleName?: keyof typeof config.moduleConfig;
+};
+
+type CtConstructorParam = {
+  gfSchema: ContentTypeStruct[] | [];
+  ctSchema: ContentTypeStruct[] | [];
 };
 
 type CommonDataTypeStruct = {
@@ -47,7 +54,7 @@ type ReferenceFieldDataType = CommonDataTypeStruct & {
 
 // NOTE Type 2
 type GlobalFieldDataType = CommonDataTypeStruct & {
-  reference_to: string[];
+  reference_to: string;
   schema: GlobalFieldSchemaTypes[];
 };
 
@@ -89,7 +96,7 @@ type GlobalFieldSchemaTypes = ReferenceFieldDataType | GroupFieldDataType | Cust
 type ModularBlocksSchemaTypes = ReferenceFieldDataType | JsonRTEFieldDataType;
 
 enum OutputColumn {
-  'Content Type name' = 'name',
+  Title = 'name',
   'Field name' = 'display_name',
   'Field type' = 'data_type',
   'Missing references' = 'missingRefs',
@@ -97,6 +104,7 @@ enum OutputColumn {
 }
 
 export {
+  CtConstructorParam,
   ContentTypeStruct,
   ModuleConstructorParam,
   ReferenceFieldDataType,
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 687c4f019a..733ec8faa8 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -27,7 +27,6 @@ importers:
       '@contentstack/cli-migration': ~1.3.13
       '@contentstack/cli-utilities': ~1.5.2
       '@contentstack/management': ~1.10.0
-      '@oclif/core': ^2.9.3
       '@oclif/plugin-help': ^5
       '@oclif/plugin-not-found': ^2.4.0
       '@oclif/plugin-plugins': ^3.3.2
@@ -81,7 +80,6 @@ importers:
       '@contentstack/cli-migration': link:../contentstack-migration
       '@contentstack/cli-utilities': link:../contentstack-utilities
       '@contentstack/management': 1.10.0_debug@4.3.4
-      '@oclif/core': 2.9.4_4qcp7qp4jxxdgb4qbxgwox4hwq
       '@oclif/plugin-help': 5.2.14_4qcp7qp4jxxdgb4qbxgwox4hwq
       '@oclif/plugin-not-found': 2.4.0_4qcp7qp4jxxdgb4qbxgwox4hwq
       '@oclif/plugin-plugins': 3.3.2_4qcp7qp4jxxdgb4qbxgwox4hwq

From 954dd429aaf0d5f7568a0ad8b6c4e1f25e89ff29 Mon Sep 17 00:00:00 2001
From: Antony <antonyagustineraj@gmail.com>
Date: Fri, 22 Sep 2023 12:40:22 +0530
Subject: [PATCH 2/2] Fix: Console removed

---
 .../contentstack-audit/src/commands/cm/stacks/audit/index.ts    | 2 --
 1 file changed, 2 deletions(-)

diff --git a/packages/contentstack-audit/src/commands/cm/stacks/audit/index.ts b/packages/contentstack-audit/src/commands/cm/stacks/audit/index.ts
index 86ba1915e5..f920bf763c 100644
--- a/packages/contentstack-audit/src/commands/cm/stacks/audit/index.ts
+++ b/packages/contentstack-audit/src/commands/cm/stacks/audit/index.ts
@@ -90,8 +90,6 @@ export default class Audit extends BaseCommand<typeof Audit> {
 
       this.log(this.$t(auditMsg.FINAL_REPORT_PATH, { path: this.sharedConfig.reportPath }), 'warn');
     } catch (error) {
-      console.trace(error);
-      console.log(error);
       this.log(error instanceof Error ? error.message : error, 'error');
       ux.action.stop('Process failed.!');
       this.exit(1);