@contentstack/cli-audit 1.10.0 → 1.12.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.10.0 linux-x64 node-v22.14.0
+@contentstack/cli-audit/1.12.0 linux-x64 node-v22.14.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -34,7 +34,7 @@ USAGE
 * [`csdx audit:fix`](#csdx-auditfix)
 * [`csdx cm:stacks:audit`](#csdx-cmstacksaudit)
 * [`csdx cm:stacks:audit:fix`](#csdx-cmstacksauditfix)
-* [`csdx help [COMMANDS]`](#csdx-help-commands)
+* [`csdx help [COMMAND]`](#csdx-help-command)
 * [`csdx plugins`](#csdx-plugins)
 * [`csdx plugins:add PLUGIN`](#csdx-pluginsadd-plugin)
 * [`csdx plugins:inspect PLUGIN...`](#csdx-pluginsinspect-plugin)
@@ -52,21 +52,30 @@ Perform audits and find possible errors in the exported Contentstack data
 
 ```
 USAGE
-  $ csdx audit [--report-path <value>] [--modules
-    content-types|global-fields|entries|extensions|workflows|custom-roles|assets] [--columns <value> | ] [--sort
-    <value>] [--filter <value>] [--csv | --no-truncate]
+  $ csdx audit [-c <value>] [-d <value>] [--show-console-output] [--report-path <value>] [--modules
+    content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--columns <value>]
+    [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
 
 FLAGS
   --modules=<option>...  Provide the list of modules to be audited
-                         <options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets>
+                         <options:
+                         content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
   --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
+      --show-console-output  Display the audit and audit fix result for individual modules
+
 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)
+  --columns=<value>  Specify columns to display, comma-separated.
+  --csv              Output results in CSV format.
+  --filter=<value>   Filter rows by a column value (e.g., name=foo).
+  --no-header        Hide table headers in output.
+  --no-truncate      Prevent truncation of long text in columns.
+  --output=<option>  Specify output format: csv, json, or yaml.
+                     <options: csv|json|yaml>
+  --sort=<value>     Sort the table by a column. Use "-" for descending.
 
 DESCRIPTION
   Perform audits and find possible errors in the exported Contentstack data
@@ -93,10 +102,10 @@ Perform audits and fix possible errors in the exported Contentstack data.
 
 ```
 USAGE
-  $ csdx audit:fix [--report-path <value>] [--modules
-    content-types|global-fields|entries|extensions|workflows|custom-roles|assets] [--copy-path <value> --copy-dir]
-    [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types] [--columns <value> | ]
-    [--sort <value>] [--filter <value>] [--csv | --no-truncate]
+  $ csdx audit:fix [-c <value>] [-d <value>] [--show-console-output] [--report-path <value>] [--modules
+    content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--copy-path <value>
+    --copy-dir] [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns
+    <value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
 
 FLAGS
   --copy-dir              Create backup from the original data.
@@ -104,15 +113,24 @@ FLAGS
   --fix-only=<option>...  Provide the list of fix options
                           <options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
   --modules=<option>...   Provide the list of modules to be audited
-                          <options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets>
+                          <options:
+                          content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
   --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
+      --show-console-output  Display the audit and audit fix result for individual modules
+
 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)
+  --columns=<value>  Specify columns to display, comma-separated.
+  --csv              Output results in CSV format.
+  --filter=<value>   Filter rows by a column value (e.g., name=foo).
+  --no-header        Hide table headers in output.
+  --no-truncate      Prevent truncation of long text in columns.
+  --output=<option>  Specify output format: csv, json, or yaml.
+                     <options: csv|json|yaml>
+  --sort=<value>     Sort the table by a column. Use "-" for descending.
 
 DESCRIPTION
   Perform audits and fix possible errors in the exported Contentstack data.
@@ -141,21 +159,30 @@ Perform audits and find possible errors in the exported Contentstack data
 
 ```
 USAGE
-  $ csdx cm:stacks:audit [--report-path <value>] [--modules
-    content-types|global-fields|entries|extensions|workflows|custom-roles|assets] [--columns <value> | ] [--sort
-    <value>] [--filter <value>] [--csv | --no-truncate]
+  $ csdx cm:stacks:audit [-c <value>] [-d <value>] [--show-console-output] [--report-path <value>] [--modules
+    content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--columns <value>]
+    [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
 
 FLAGS
   --modules=<option>...  Provide the list of modules to be audited
-                         <options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets>
+                         <options:
+                         content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
   --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
+      --show-console-output  Display the audit and audit fix result for individual modules
+
 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)
+  --columns=<value>  Specify columns to display, comma-separated.
+  --csv              Output results in CSV format.
+  --filter=<value>   Filter rows by a column value (e.g., name=foo).
+  --no-header        Hide table headers in output.
+  --no-truncate      Prevent truncation of long text in columns.
+  --output=<option>  Specify output format: csv, json, or yaml.
+                     <options: csv|json|yaml>
+  --sort=<value>     Sort the table by a column. Use "-" for descending.
 
 DESCRIPTION
   Perform audits and find possible errors in the exported Contentstack data
@@ -184,10 +211,10 @@ Perform audits and fix possible errors in the exported Contentstack data.
 
 ```
 USAGE
-  $ csdx cm:stacks:audit:fix [--report-path <value>] [--modules
-    content-types|global-fields|entries|extensions|workflows|custom-roles|assets] [--copy-path <value> --copy-dir]
-    [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types] [--columns <value> | ]
-    [--sort <value>] [--filter <value>] [--csv | --no-truncate]
+  $ csdx cm:stacks:audit:fix [-c <value>] [-d <value>] [--show-console-output] [--report-path <value>] [--modules
+    content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--copy-path <value>
+    --copy-dir] [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns
+    <value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
 
 FLAGS
   --copy-dir              Create backup from the original data.
@@ -195,15 +222,24 @@ FLAGS
   --fix-only=<option>...  Provide the list of fix options
                           <options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
   --modules=<option>...   Provide the list of modules to be audited
-                          <options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets>
+                          <options:
+                          content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
   --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
+      --show-console-output  Display the audit and audit fix result for individual modules
+
 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)
+  --columns=<value>  Specify columns to display, comma-separated.
+  --csv              Output results in CSV format.
+  --filter=<value>   Filter rows by a column value (e.g., name=foo).
+  --no-header        Hide table headers in output.
+  --no-truncate      Prevent truncation of long text in columns.
+  --output=<option>  Specify output format: csv, json, or yaml.
+                     <options: csv|json|yaml>
+  --sort=<value>     Sort the table by a column. Use "-" for descending.
 
 DESCRIPTION
   Perform audits and fix possible errors in the exported Contentstack data.
@@ -228,16 +264,16 @@ EXAMPLES
 
 _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 help [COMMANDS]`
+## `csdx help [COMMAND]`
 
 Display help for csdx.
 
 ```
 USAGE
-  $ csdx help [COMMANDS] [-n]
+  $ csdx help [COMMAND...] [-n]
 
 ARGUMENTS
-  COMMANDS  Command to show help for.
+  COMMAND...  Command to show help for.
 
 FLAGS
   -n, --nested-commands  Include all nested commands in the output.
@@ -246,7 +282,7 @@ DESCRIPTION
   Display help for csdx.
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.20/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.27/src/commands/help.ts)_
 
 ## `csdx plugins`
 
@@ -277,10 +313,10 @@ Installs a plugin into csdx.
 
 ```
 USAGE
-  $ csdx plugins:add PLUGIN [--json] [-f] [-h] [-s | -v]
+  $ csdx plugins:add PLUGIN... [--json] [-f] [-h] [-s | -v]
 
 ARGUMENTS
-  PLUGIN  Plugin to install.
+  PLUGIN...  Plugin to install.
 
 FLAGS
   -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
@@ -327,7 +363,7 @@ USAGE
   $ csdx plugins:inspect PLUGIN...
 
 ARGUMENTS
-  PLUGIN  [default: .] Plugin to inspect.
+  PLUGIN...  [default: .] Plugin to inspect.
 
 FLAGS
   -h, --help     Show CLI help.
@@ -351,10 +387,10 @@ Installs a plugin into csdx.
 
 ```
 USAGE
-  $ csdx plugins:install PLUGIN [--json] [-f] [-h] [-s | -v]
+  $ csdx plugins:install PLUGIN... [--json] [-f] [-h] [-s | -v]
 
 ARGUMENTS
-  PLUGIN  Plugin to install.
+  PLUGIN...  Plugin to install.
 
 FLAGS
   -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
@@ -406,9 +442,9 @@ ARGUMENTS
   PATH  [default: .] path to plugin
 
 FLAGS
-  -h, --help      Show CLI help.
+  -h, --help          Show CLI help.
   -v, --verbose
-  --[no-]install  Install dependencies after linking the plugin.
+      --[no-]install  Install dependencies after linking the plugin.
 
 DESCRIPTION
   Links a plugin into the CLI for development.
@@ -431,10 +467,10 @@ Removes a plugin from the CLI.
 
 ```
 USAGE
-  $ csdx plugins:remove [PLUGIN] [-h] [-v]
+  $ csdx plugins:remove [PLUGIN...] [-h] [-v]
 
 ARGUMENTS
-  PLUGIN  plugin to uninstall
+  PLUGIN...  plugin to uninstall
 
 FLAGS
   -h, --help     Show CLI help.
@@ -472,10 +508,10 @@ Removes a plugin from the CLI.
 
 ```
 USAGE
-  $ csdx plugins:uninstall [PLUGIN] [-h] [-v]
+  $ csdx plugins:uninstall [PLUGIN...] [-h] [-v]
 
 ARGUMENTS
-  PLUGIN  plugin to uninstall
+  PLUGIN...  plugin to uninstall
 
 FLAGS
   -h, --help     Show CLI help.
@@ -500,10 +536,10 @@ Removes a plugin from the CLI.
 
 ```
 USAGE
-  $ csdx plugins:unlink [PLUGIN] [-h] [-v]
+  $ csdx plugins:unlink [PLUGIN...] [-h] [-v]
 
 ARGUMENTS
-  PLUGIN  plugin to uninstall
+  PLUGIN...  plugin to uninstall
 
 FLAGS
   -h, --help     Show CLI help.

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

@@ -3,6 +3,7 @@ import { BaseCommand } from './base-command';
 import { CommandNames, ContentTypeStruct } from './types';
 export declare abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseCommand> {
     private currentCommand;
+    private readonly summaryDataToPrint;
     get fixStatus(): {
         fixStatus: {
             minWidth: number;
@@ -24,8 +25,8 @@ export declare abstract class AuditBaseCommand extends BaseCommand<typeof AuditB
      * and `missingEntryRefs`.
      */
     scanAndFix(): Promise<{
-        missingCtRefs: Record<string, any> | undefined;
-        missingGfRefs: Record<string, any> | undefined;
+        missingCtRefs: Record<string, any> | ContentTypeStruct[] | undefined;
+        missingGfRefs: Record<string, any> | ContentTypeStruct[] | undefined;
         missingEntryRefs: Record<string, any> | undefined;
         missingCtRefsInExtensions: {} | undefined;
         missingCtRefsInWorkflow: {} | undefined;
@@ -33,8 +34,9 @@ export declare abstract class AuditBaseCommand extends BaseCommand<typeof AuditB
         missingMandatoryFields: Record<string, any> | undefined;
         missingTitleFields: Record<string, any> | undefined;
         missingRefInCustomRoles: {} | undefined;
-        missingEnvLocalesInAssets: Record<string, any> | undefined;
+        missingEnvLocalesInAssets: Record<string, any> | ContentTypeStruct[] | undefined;
         missingEnvLocalesInEntries: Record<string, any> | undefined;
+        missingFieldRules: Record<string, any> | undefined;
         missingMultipleFields: Record<string, any> | undefined;
     }>;
     /**
@@ -81,7 +83,7 @@ export declare abstract class AuditBaseCommand extends BaseCommand<typeof AuditB
      * 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 | keyof typeof config.ReportTitleForEntries, listOfMissingRefs: Record<string, any>): Promise<void>;
+    prepareReport(moduleName: keyof typeof config.moduleConfig | keyof typeof config.ReportTitleForEntries | 'field-rules' | 'Summary', 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.
@@ -92,5 +94,6 @@ export declare abstract class AuditBaseCommand extends BaseCommand<typeof AuditB
      * 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 | keyof typeof config.ReportTitleForEntries, listOfMissingRefs: Record<string, any>): Promise<void>;
+    prepareCSV(moduleName: keyof typeof config.moduleConfig | keyof typeof config.ReportTitleForEntries | 'field-rules' | 'Summary', listOfMissingRefs: Record<string, any>): Promise<void>;
+    getAffectedData(module: string, dataExported: Record<string, any>, listOfMissingRefs: Record<string, any>, isFixable?: boolean): void;
 }