[v2] allow showMsgWhenDeprecated to accept an empty string as a parameter …

packages/imperative/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to the Imperative package will be documented in this file.
 
+
+## Recent Changes
+
+- BugFix: Modified showMsgWhenDeprecated() function to allow an empty string as a parameter when no replacement is availible for the deprecated command. When no replacement is availible an alternative message will be printed. [#2041](https://github.com/zowe/zowe-cli/issues/2041)
+
 ## `5.26.3`
 
 - BugFix: Fixed issue in local web help with highlighted sidebar item getting out of sync. [#2215](https://github.com/zowe/zowe-cli/pull/2215)

packages/imperative/src/utilities/__tests__/CliUtils.unit.test.ts

@@ -312,13 +312,22 @@ describe("CliUtils", () => {
             CliUtils.showMsgWhenDeprecated(handlerParms);
             expect(responseErrText).toEqual("Recommended replacement: " +
                 handlerParms.definition.deprecatedReplacement);
+            expect(responseErrText).not.toContain("Obsolete component. No replacement exists");
         });
 
         it("should not produce a deprecated message when not deprecated", () => {
             responseErrText = notSetYet;
             delete handlerParms.definition.deprecatedReplacement;
             CliUtils.showMsgWhenDeprecated(handlerParms);
             expect(responseErrText).toEqual(notSetYet);
+            expect(responseErrText).not.toContain("Obsolete component. No replacement exists");
+        });
+
+        it("should produce alternative text when deprecatedReplacement is an empty string", () => {
+            responseErrText = notSetYet;
+            handlerParms.definition.deprecatedReplacement = "";
+            CliUtils.showMsgWhenDeprecated(handlerParms);
+            expect(responseErrText).toContain("Obsolete component. No replacement exists");
         });
     });
 

packages/imperative/src/utilities/src/CliUtils.ts

@@ -378,20 +378,26 @@ export class CliUtils {
      * @memberof CliUtils
      */
     public static showMsgWhenDeprecated(handlerParms: IHandlerParameters) {
-        if (handlerParms.definition.deprecatedReplacement) {
+        let oldCmd: string | number;
+        if (handlerParms.definition.deprecatedReplacement || handlerParms.definition.deprecatedReplacement === "") {
             // form the command that is deprecated
-            let oldCmd: string;
-            if (handlerParms.positionals.length >= 1) {
-                oldCmd = handlerParms.positionals[0];
+            if(handlerParms.definition.deprecatedReplacement === "")
+            {
+                handlerParms.response.console.error("\nObsolete component. No replacement exists");
             }
-            if (handlerParms.positionals.length >= 2) {
-                oldCmd = oldCmd + " " + handlerParms.positionals[1];
-            }
-
-            // display the message
-            handlerParms.response.console.error("\nWarning: The command '" + oldCmd + "' is deprecated.");
-            handlerParms.response.console.error("Recommended replacement: " +
+            else
+            {
+                if (handlerParms.positionals.length >= 1) {
+                    oldCmd = handlerParms.positionals[0];
+                }
+                if (handlerParms.positionals.length >= 2) {
+                    oldCmd = oldCmd + " " + handlerParms.positionals[1];
+                }
+                // display the message
+                handlerParms.response.console.error("\nWarning: The command '" + oldCmd + "' is deprecated.");
+                handlerParms.response.console.error("Recommended replacement: " +
                 handlerParms.definition.deprecatedReplacement);
+            }
         }
     }