@contentstack/cli-audit 1.5.0 → 1.5.1

package/README.md

@@ -19,7 +19,7 @@ $ npm install -g @contentstack/cli-audit
 $ csdx COMMAND
 running command...
 $ csdx (--version|-v)
-@contentstack/cli-audit/1.5.0 linux-x64 node-v18.19.1
+@contentstack/cli-audit/1.5.1 linux-x64 node-v18.19.1
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -36,14 +36,14 @@ USAGE
 * [`csdx cm:stacks:audit:fix`](#csdx-cmstacksauditfix)
 * [`csdx help [COMMANDS]`](#csdx-help-commands)
 * [`csdx plugins`](#csdx-plugins)
-* [`csdx plugins:install PLUGIN...`](#csdx-pluginsinstall-plugin)
+* [`csdx plugins:add PLUGIN`](#csdx-pluginsadd-plugin)
 * [`csdx plugins:inspect PLUGIN...`](#csdx-pluginsinspect-plugin)
-* [`csdx plugins:install PLUGIN...`](#csdx-pluginsinstall-plugin-1)
-* [`csdx plugins:link PLUGIN`](#csdx-pluginslink-plugin)
-* [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin)
+* [`csdx plugins:install PLUGIN`](#csdx-pluginsinstall-plugin)
+* [`csdx plugins:link PATH`](#csdx-pluginslink-path)
+* [`csdx plugins:remove [PLUGIN]`](#csdx-pluginsremove-plugin)
 * [`csdx plugins:reset`](#csdx-pluginsreset)
-* [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin-1)
-* [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin-2)
+* [`csdx plugins:uninstall [PLUGIN]`](#csdx-pluginsuninstall-plugin)
+* [`csdx plugins:unlink [PLUGIN]`](#csdx-pluginsunlink-plugin)
 * [`csdx plugins:update`](#csdx-pluginsupdate)
 
 ## `csdx audit`
@@ -285,48 +285,53 @@ EXAMPLES
   $ csdx plugins
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.2/src/commands/plugins/index.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.0/src/commands/plugins/index.ts)_
 
-## `csdx plugins:install PLUGIN...`
+## `csdx plugins:add PLUGIN`
 
-Installs a plugin into the CLI.
+Installs a plugin into csdx.
 
 ```
 USAGE
-  $ csdx plugins:install PLUGIN...
+  $ csdx plugins:add PLUGIN [--json] [-f] [-h] [-s | -v]
 
 ARGUMENTS
   PLUGIN  Plugin to install.
 
 FLAGS
-  -f, --force    Run yarn install with force flag.
+  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
   -h, --help     Show CLI help.
-  -s, --silent   Silences yarn output.
-  -v, --verbose  Show verbose yarn output.
+  -s, --silent   Silences npm output.
+  -v, --verbose  Show verbose npm output.
 
 GLOBAL FLAGS
   --json  Format output as json.
 
 DESCRIPTION
-  Installs a plugin into the CLI.
-  Can be installed from npm or a git url.
+  Installs a plugin into csdx.
 
-  Installation of a user-installed plugin will override a core plugin.
+  Uses bundled npm executable to install plugins into /home/runner/.local/share/@contentstack/cli-audit
 
-  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
-  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
-  the CLI without the need to patch and update the whole CLI.
+  Installation of a user-installed plugin will override a core plugin.
 
+  Use the CSDX_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the CSDX_NPM_REGISTRY environment variable to set the npm registry.
 
 ALIASES
   $ csdx plugins:add
 
 EXAMPLES
-  $ csdx plugins:add myplugin 
+  Install a plugin from npm registry.
+
+    $ csdx plugins:add myplugin
+
+  Install a plugin from a github url.
+
+    $ csdx plugins:add https://github.com/someuser/someplugin
 
-  $ csdx plugins:add https://github.com/someuser/someplugin
+  Install a plugin from a github slug.
 
-  $ csdx plugins:add someuser/someplugin
+    $ csdx plugins:add someuser/someplugin
 ```
 
 ## `csdx plugins:inspect PLUGIN...`
@@ -354,59 +359,64 @@ EXAMPLES
   $ csdx plugins:inspect myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.2/src/commands/plugins/inspect.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.0/src/commands/plugins/inspect.ts)_
 
-## `csdx plugins:install PLUGIN...`
+## `csdx plugins:install PLUGIN`
 
-Installs a plugin into the CLI.
+Installs a plugin into csdx.
 
 ```
 USAGE
-  $ csdx plugins:install PLUGIN...
+  $ csdx plugins:install PLUGIN [--json] [-f] [-h] [-s | -v]
 
 ARGUMENTS
   PLUGIN  Plugin to install.
 
 FLAGS
-  -f, --force    Run yarn install with force flag.
+  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
   -h, --help     Show CLI help.
-  -s, --silent   Silences yarn output.
-  -v, --verbose  Show verbose yarn output.
+  -s, --silent   Silences npm output.
+  -v, --verbose  Show verbose npm output.
 
 GLOBAL FLAGS
   --json  Format output as json.
 
 DESCRIPTION
-  Installs a plugin into the CLI.
-  Can be installed from npm or a git url.
+  Installs a plugin into csdx.
 
-  Installation of a user-installed plugin will override a core plugin.
+  Uses bundled npm executable to install plugins into /home/runner/.local/share/@contentstack/cli-audit
 
-  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
-  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
-  the CLI without the need to patch and update the whole CLI.
+  Installation of a user-installed plugin will override a core plugin.
 
+  Use the CSDX_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the CSDX_NPM_REGISTRY environment variable to set the npm registry.
 
 ALIASES
   $ csdx plugins:add
 
 EXAMPLES
-  $ csdx plugins:install myplugin 
+  Install a plugin from npm registry.
+
+    $ csdx plugins:install myplugin
+
+  Install a plugin from a github url.
+
+    $ csdx plugins:install https://github.com/someuser/someplugin
 
-  $ csdx plugins:install https://github.com/someuser/someplugin
+  Install a plugin from a github slug.
 
-  $ csdx plugins:install someuser/someplugin
+    $ csdx plugins:install someuser/someplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.2/src/commands/plugins/install.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.0/src/commands/plugins/install.ts)_
 
-## `csdx plugins:link PLUGIN`
+## `csdx plugins:link PATH`
 
 Links a plugin into the CLI for development.
 
 ```
 USAGE
-  $ csdx plugins:link PLUGIN
+  $ csdx plugins:link PATH [-h] [--install] [-v]
 
 ARGUMENTS
   PATH  [default: .] path to plugin
@@ -428,15 +438,15 @@ EXAMPLES
   $ csdx plugins:link myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.2/src/commands/plugins/link.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.0/src/commands/plugins/link.ts)_
 
-## `csdx plugins:uninstall PLUGIN...`
+## `csdx plugins:remove [PLUGIN]`
 
 Removes a plugin from the CLI.
 
 ```
 USAGE
-  $ csdx plugins:uninstall PLUGIN...
+  $ csdx plugins:remove [PLUGIN] [-h] [-v]
 
 ARGUMENTS
   PLUGIN  plugin to uninstall
@@ -469,15 +479,15 @@ FLAGS
   --reinstall  Reinstall all plugins after uninstalling.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.2/src/commands/plugins/reset.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.0/src/commands/plugins/reset.ts)_
 
-## `csdx plugins:uninstall PLUGIN...`
+## `csdx plugins:uninstall [PLUGIN]`
 
 Removes a plugin from the CLI.
 
 ```
 USAGE
-  $ csdx plugins:uninstall PLUGIN...
+  $ csdx plugins:uninstall [PLUGIN] [-h] [-v]
 
 ARGUMENTS
   PLUGIN  plugin to uninstall
@@ -497,15 +507,15 @@ EXAMPLES
   $ csdx plugins:uninstall myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.2/src/commands/plugins/uninstall.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.0/src/commands/plugins/uninstall.ts)_
 
-## `csdx plugins:uninstall PLUGIN...`
+## `csdx plugins:unlink [PLUGIN]`
 
 Removes a plugin from the CLI.
 
 ```
 USAGE
-  $ csdx plugins:uninstall PLUGIN...
+  $ csdx plugins:unlink [PLUGIN] [-h] [-v]
 
 ARGUMENTS
   PLUGIN  plugin to uninstall
@@ -541,5 +551,5 @@ DESCRIPTION
   Update installed plugins.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.2/src/commands/plugins/update.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.0/src/commands/plugins/update.ts)_
 <!-- commandsstop -->

package/lib/audit-base-command.js

@@ -249,7 +249,7 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
             const tableValues = Object.values(missingRefs).flat();
             const tableKeys = Object.keys(missingRefs[0]);
             const arrayOfObjects = tableKeys.map((key) => {
-                if (['title', 'name', 'uid', 'content_types', 'fixStatus'].includes(key)) {
+                if (['title', 'name', 'uid', 'content_types', 'branches', 'fixStatus'].includes(key)) {
                     return {
                         [key]: {
                             minWidth: 7,
@@ -258,7 +258,7 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
                                 if (key === 'fixStatus') {
                                     return chalk_1.default.green(typeof row[key] === 'object' ? JSON.stringify(row[key]) : row[key]);
                                 }
-                                else if (key === 'content_types') {
+                                else if (key === 'content_types' || key === 'branches') {
                                     return chalk_1.default.red(typeof row[key] === 'object' ? JSON.stringify(row[key]) : row[key]);
                                 }
                                 else {
@@ -319,14 +319,22 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
                 : defaultColumns;
             if (this.sharedConfig.flags.filter) {
                 const [column, value] = this.sharedConfig.flags.filter.split('=');
-                missingRefs = missingRefs.filter((row) => row[types_1.OutputColumn[column]] === value);
+                // Filter the missingRefs array
+                missingRefs = missingRefs.filter((row) => {
+                    if (types_1.OutputColumn[column] in row) {
+                        const rowKey = types_1.OutputColumn[column];
+                        return row[rowKey] === value;
+                    }
+                    return false;
+                });
             }
             const rowData = [];
             for (const issue of missingRefs) {
                 let row = {};
                 for (const column of columns) {
                     if (Object.keys(issue).includes(types_1.OutputColumn[column])) {
-                        row[column] = issue[types_1.OutputColumn[column]];
+                        const issueKey = types_1.OutputColumn[column];
+                        row[column] = issue[issueKey];
                         row[column] = typeof row[column] === 'object' ? JSON.stringify(row[column]) : row[column];
                     }
                 }

package/lib/messages/index.d.ts

@@ -14,6 +14,7 @@ declare const commonMsg: {
     WORKFLOW_FIX_CONFIRMATION: string;
     EXTENSION_FIX_WARN: string;
     EXTENSION_FIX_CONFIRMATION: string;
+    WF_BRANCH_REMOVAL: string;
 };
 declare const auditMsg: {
     REPORT_PATH: string;

package/lib/messages/index.js

@@ -22,6 +22,7 @@ const commonMsg = {
     WORKFLOW_FIX_CONFIRMATION: 'Would you like to overwrite existing file?',
     EXTENSION_FIX_WARN: `The extension associated with UID {uid} and title '{title}' will be removed.`,
     EXTENSION_FIX_CONFIRMATION: `Would you like to overwrite existing file?`,
+    WF_BRANCH_REMOVAL: `Removing the branch '{branch} from workflow with UID {uid} and name {name} will be removed.'`,
 };
 exports.commonMsg = commonMsg;
 const auditMsg = {

package/lib/modules/extensions.js

@@ -80,6 +80,7 @@ class Extensions {
         if (this.fix &&
             (this.config.flags['copy-dir'] ||
                 ((_a = this.config.flags['external-config']) === null || _a === void 0 ? void 0 : _a.skipConfirm) ||
+                this.config.flags.yes ||
                 (await cli_utilities_1.ux.confirm(messages_1.commonMsg.FIX_CONFIRMATION)))) {
             (0, fs_1.writeFileSync)((0, path_1.join)(this.folderPath, this.config.moduleConfig[this.moduleName].fileName), JSON.stringify(fixedExtensions));
         }

package/lib/modules/workflows.d.ts

@@ -13,6 +13,7 @@ export default class Workflows {
     missingCtInWorkflows: Workflow[];
     missingCts: Set<string>;
     workflowPath: string;
+    isBranchFixDone: boolean;
     constructor({ log, fix, config, moduleName, ctSchema, }: ModuleConstructorParam & Pick<CtConstructorParam, 'ctSchema'>);
     /**
      * Check whether the given path for the workflow exists or not

package/lib/modules/workflows.js

@@ -20,6 +20,7 @@ class Workflows {
         this.missingCtInWorkflows = [];
         this.missingCts = new Set();
         this.workflowPath = '';
+        this.isBranchFixDone = false;
     }
     /**
      * Check whether the given path for the workflow exists or not
@@ -28,6 +29,7 @@ class Workflows {
      * @returns Array of object containing the workflow name, uid and content_types that are missing
      */
     async run() {
+        var _a;
         if (!(0, fs_1.existsSync)(this.folderPath)) {
             this.log(`Skipping ${this.moduleName} audit`, 'warn');
             this.log((0, messages_1.$t)(messages_1.auditMsg.NOT_VALID_PATH, { path: this.folderPath }), { color: 'yellow' });
@@ -40,9 +42,16 @@ class Workflows {
         this.ctSchema.forEach((ct) => this.ctUidSet.add(ct.uid));
         for (const workflow of this.workflowSchema) {
             const ctNotPresent = workflow.content_types.filter((ct) => !this.ctUidSet.has(ct));
-            if (ctNotPresent.length) {
+            const branch = (_a = workflow === null || workflow === void 0 ? void 0 : workflow.branches) === null || _a === void 0 ? void 0 : _a.filter((branch) => { var _a; return branch !== ((_a = this.config) === null || _a === void 0 ? void 0 : _a.branch); });
+            if (ctNotPresent.length || (branch === null || branch === void 0 ? void 0 : branch.length)) {
                 const tempwf = (0, lodash_1.cloneDeep)(workflow);
-                tempwf.content_types = ctNotPresent;
+                tempwf.content_types = ctNotPresent || [];
+                if (workflow === null || workflow === void 0 ? void 0 : workflow.branches) {
+                    tempwf.branches = branch;
+                }
+                if (branch === null || branch === void 0 ? void 0 : branch.length) {
+                    this.isBranchFixDone = true;
+                }
                 ctNotPresent.forEach((ct) => this.missingCts.add(ct));
                 this.missingCtInWorkflows.push(tempwf);
             }
@@ -51,19 +60,34 @@ class Workflows {
                 uid: workflow.uid,
             }), 'info');
         }
-        if (this.fix && this.missingCtInWorkflows.length) {
+        if (this.fix && (this.missingCtInWorkflows.length || this.isBranchFixDone)) {
             await this.fixWorkflowSchema();
             this.missingCtInWorkflows.forEach((wf) => (wf.fixStatus = 'Fixed'));
         }
         return this.missingCtInWorkflows;
     }
     async fixWorkflowSchema() {
+        var _a;
         const newWorkflowSchema = (0, fs_1.existsSync)(this.workflowPath)
             ? JSON.parse((0, fs_1.readFileSync)(this.workflowPath, 'utf8'))
             : {};
         if (Object.keys(newWorkflowSchema).length !== 0) {
             for (const workflow of this.workflowSchema) {
                 const fixedCts = workflow.content_types.filter((ct) => !this.missingCts.has(ct));
+                const fixedBranches = [];
+                (_a = workflow === null || workflow === void 0 ? void 0 : workflow.branches) === null || _a === void 0 ? void 0 : _a.forEach((branch) => {
+                    var _a;
+                    if (branch !== ((_a = this.config) === null || _a === void 0 ? void 0 : _a.branch)) {
+                        const { uid, name } = workflow;
+                        this.log((0, messages_1.$t)(messages_1.commonMsg.WF_BRANCH_REMOVAL, { uid, name, branch }), { color: 'yellow' });
+                    }
+                    else {
+                        fixedBranches.push(branch);
+                    }
+                });
+                if (fixedBranches.length > 0) {
+                    newWorkflowSchema[workflow.uid].branches = fixedBranches;
+                }
                 if (fixedCts.length) {
                     newWorkflowSchema[workflow.uid].content_types = fixedCts;
                 }
@@ -82,8 +106,10 @@ class Workflows {
     async writeFixContent(newWorkflowSchema) {
         var _a;
         if (this.fix &&
-            !(this.config.flags['copy-dir'] || ((_a = this.config.flags['external-config']) === null || _a === void 0 ? void 0 : _a.skipConfirm)) &&
-            (this.config.flags.yes || (await cli_utilities_1.ux.confirm(messages_1.commonMsg.FIX_CONFIRMATION)))) {
+            (this.config.flags['copy-dir'] ||
+                ((_a = this.config.flags['external-config']) === null || _a === void 0 ? void 0 : _a.skipConfirm) ||
+                this.config.flags.yes ||
+                (await cli_utilities_1.ux.confirm(messages_1.commonMsg.FIX_CONFIRMATION)))) {
             (0, fs_1.writeFileSync)((0, path_1.join)(this.folderPath, this.config.moduleConfig[this.moduleName].fileName), JSON.stringify(newWorkflowSchema));
         }
     }

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

@@ -40,6 +40,9 @@ type RefErrorReturnType = {
     content_types?: string[];
     title?: string;
 };
+type WorkflowExtensionsRefErrorReturnType = RefErrorReturnType & {
+    branches?: string[];
+};
 type ReferenceFieldDataType = CommonDataTypeStruct & {
     reference_to: string[];
 };
@@ -79,6 +82,7 @@ declare enum OutputColumn {
     Path = "treeStr",
     title = "title",
     'uid' = "uid",
-    'missingCts' = "content_types"
+    'missingCts' = "content_types",
+    'Missing Branches' = "branches"
 }
-export { CtConstructorParam, ContentTypeStruct, ModuleConstructorParam, ReferenceFieldDataType, GlobalFieldDataType, ExtensionOrAppFieldDataType, JsonRTEFieldDataType, GroupFieldDataType, ModularBlocksDataType, RefErrorReturnType, ModularBlocksSchemaTypes, ModularBlockType, OutputColumn, ContentTypeSchemaType, GlobalFieldSchemaTypes, };
+export { CtConstructorParam, ContentTypeStruct, ModuleConstructorParam, ReferenceFieldDataType, GlobalFieldDataType, ExtensionOrAppFieldDataType, JsonRTEFieldDataType, GroupFieldDataType, ModularBlocksDataType, RefErrorReturnType, ModularBlocksSchemaTypes, ModularBlockType, OutputColumn, ContentTypeSchemaType, GlobalFieldSchemaTypes, WorkflowExtensionsRefErrorReturnType, };

package/lib/types/content-types.js

@@ -11,5 +11,6 @@ var OutputColumn;
     OutputColumn["title"] = "title";
     OutputColumn["uid"] = "uid";
     OutputColumn["missingCts"] = "content_types";
+    OutputColumn["Missing Branches"] = "branches";
 })(OutputColumn || (OutputColumn = {}));
 exports.OutputColumn = OutputColumn;

package/lib/types/workflow.d.ts

@@ -10,4 +10,5 @@ export interface Workflow {
     deleted_at?: any;
     missingRefs?: any;
     fixStatus?: string;
+    branches?: string[];
 }

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.5.0",
+  "version": "1.5.1",
   "commands": {
     "cm:stacks:audit:fix": {
       "id": "cm:stacks:audit:fix",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-audit",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "Contentstack audit plugin",
   "author": "Contentstack CLI",
   "homepage": "https://github.com/contentstack/cli",
@@ -21,7 +21,7 @@
     "@contentstack/cli-command": "~1.2.16",
     "@contentstack/cli-utilities": "~1.6.0",
     "@oclif/plugin-help": "^5",
-    "@oclif/plugin-plugins": "^4.1.9",
+    "@oclif/plugin-plugins": "^5.0.0",
     "chalk": "^4.1.2",
     "fast-csv": "^4.3.6",
     "fs-extra": "^11.1.1",
@@ -86,4 +86,4 @@
   "keywords": [
     "oclif"
   ]
-}
+}