--help fail on config json error

packages/imperative/CHANGELOG.md

@@ -3,6 +3,7 @@
 All notable changes to the Imperative package will be documented in this file.
 
 ## Recent Changes
+- BugFix: Enabling commands with either the `--help` or `--version` flags to still display their information despite any config file issues [#2301](https://github.com/zowe/zowe-cli/pull/2301)
 
 - BugFix: Fixed issues flagged by Coverity [#2291](https://github.com/zowe/zowe-cli/pull/2291)
 

packages/imperative/src/config/src/Config.ts

@@ -179,7 +179,8 @@ export class Config {
                 exists: false,
                 properties: Config.empty(),
                 global: layer === Layers.GlobalUser || layer === Layers.GlobalConfig,
-                user: layer === Layers.ProjectUser || layer === Layers.GlobalUser
+                user: layer === Layers.ProjectUser || layer === Layers.GlobalUser,
+                ignoreErrors: process.argv.includes("--help") || process.argv.includes("--version")
             });
         }
 

packages/imperative/src/config/src/api/ConfigLayers.ts

@@ -18,6 +18,8 @@
 import { IConfigLayer } from "../doc/IConfigLayer";
 import { ConfigApi } from "./ConfigApi";
 import { IConfig } from "../doc/IConfig";
+import { TextUtils } from "../../../utilities";
+import { CommandResponse } from "../../../cmd/src/response/CommandResponse";
 
 /**
  * API Class for manipulating config layers.
@@ -31,7 +33,7 @@
      * @param opts The user and global flags that indicate which of the four
      *             config files (aka layers) is to be read.
      */
-    public read(opts?: { user: boolean; global: boolean }) {
+    public read(opts?: { user: boolean; global: boolean; ignoreErrors: boolean}) {
         // Attempt to populate the layer
         const layer = opts ? this.mConfig.findLayer(opts.user, opts.global) : this.mConfig.layerActive();
         if (fs.existsSync(layer.path)) {
@@ -49,11 +51,19 @@
                 layer.properties = JSONC.parse(fileContents.toString()) as any;
                 layer.exists = true;
             } catch (e) {
-                throw new ImperativeError({
-                    msg: `Error parsing JSON in the file '${layer.path}'.\n` +
-                        `Please check this configuration file for errors.\nError details: ${e.message}\nLine ${e.line}, Column ${e.column}`,
-                    suppressDump: true
-                });
+                const msg = `Error parsing JSON in the file '${layer.path}'.\n` +
+                `Please check this configuration file for errors.\nError details: ${e.message}\nLine ${e.line}, Column ${e.column}`;
+                if (!opts.ignoreErrors){
+                    throw new ImperativeError({
+                        msg:msg,
+                        suppressDump: true
+                    });
+               } else {
+                    const cmdResp: CommandResponse = new CommandResponse({
+                        responseFormat: "default"
+                    });
+                    cmdResp.console.log(TextUtils.chalk.red(msg));
+               }
             }
             this.mConfig.api.secure.loadCached(opts);
         } else if (layer.exists) {

packages/imperative/src/config/src/doc/IConfigLayer.ts

@@ -17,4 +17,5 @@ export interface IConfigLayer {
     properties: IConfig;
     global: boolean;
     user: boolean;
+    ignoreErrors: boolean;
 }