Deprecate getZoweYargsResponse

packages/imperative/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to the Imperative package will be documented in this file.
 
+## Recent Changes
+
+- Enhancement: Deprecated function AbstractCommandYargs.getBrightYargsResponse in favor of AbstractCommandYargs.getZoweYargsResponse
+- Enhancement: Deprecated the 'bright' command as an alias for the 'zowe' command. The 'bright' command will be removed in Zowe V3.
+
 ## `5.18.4`
 
 - BugFix: Removed out of date `Perf-Timing` performance timing package.

packages/imperative/src/cmd/src/yargs/AbstractCommandYargs.ts

@@ -240,6 +240,16 @@
      */
     public abstract defineCommandToYargs(commandExecuted: YargsCommandCompleted): void;
 
+    /**
+     * @deprecated Use `getZoweYargsResponse` instead
+     */
+    protected getBrightYargsResponse(successful: boolean, responseMessage: string,
+        action: ImperativeYargsCommandAction,
+        responses?: ICommandResponse[]): IYargsResponse
+    {
+        return this.getZoweYargsResponse(successful, responseMessage, action, responses);
+    }
+
     /**
      * Build The Bright Yargs response for the callback. Includes the Bright command response and status info.
      * @param {boolean} successful: True if the command succeeded
@@ -248,7 +258,7 @@
      * @param {ICommandResponse[]} responses
      * @return {IYargsResponse}
      */
-    protected getBrightYargsResponse(successful: boolean, responseMessage: string,
+    protected getZoweYargsResponse(successful: boolean, responseMessage: string,
         action: ImperativeYargsCommandAction,
         responses?: ICommandResponse[]): IYargsResponse {
         let exitCode: number;
@@ -309,7 +319,7 @@
                 stream: ImperativeConfig.instance.daemonContext?.stream
             }));
         } catch (helpErr) {
-            const errorResponse: IYargsResponse = this.getBrightYargsResponse(false,
+            const errorResponse: IYargsResponse = this.getZoweYargsResponse(false,
                 `The help for ${this.definition.name} was invoked and failed.`,
                 "help invoked");
             errorResponse.causeErrors = helpErr;
@@ -318,7 +328,7 @@
         }
 
         if (!invoked) {
-            commandExecuted(args, this.getBrightYargsResponse(true,
+            commandExecuted(args, this.getZoweYargsResponse(true,
                 `The help for ${this.definition.name} was invoked.`,
                 "help invoked", [response]));
         }
@@ -423,7 +433,7 @@
                 })
             );
         } catch (helpErr) {
-            const errorResponse: IYargsResponse = this.getBrightYargsResponse(false,
+            const errorResponse: IYargsResponse = this.getZoweYargsResponse(false,
                 `The web help for ${this.definition.name} was invoked and failed.`,
                 "help invoked");
             errorResponse.causeErrors = helpErr;
@@ -432,7 +442,7 @@
         }
 
         if (!invoked) {
-            commandExecuted(args, this.getBrightYargsResponse(true,
+            commandExecuted(args, this.getZoweYargsResponse(true,
                 `The web help for ${this.definition.name} was invoked.`,
                 "help invoked", [response]));
         }

packages/imperative/src/cmd/src/yargs/CommandYargs.ts

@@ -137,13 +137,13 @@
                          */
                         this.invokeHandlers(handlerDefinition, 0, argsForHandler, responses)
                             .then((successResponses) => {
-                                commandExecuted(argsForHandler, this.getBrightYargsResponse(true,
+                                commandExecuted(argsForHandler, this.getZoweYargsResponse(true,
                                     `${successResponses.length} command handlers invoked.`,
                                     "command handler invoked", successResponses));
 
                             })
                             .catch((errorResponses) => {
-                                const response: IYargsResponse = this.getBrightYargsResponse(false,
+                                const response: IYargsResponse = this.getZoweYargsResponse(false,
                                     `Error in command ${this.definition.name}`,
                                     "command handler invoked", errorResponses);
                                 this.log.error(`Error in command ${this.definition.name}`);
@@ -155,7 +155,7 @@
                          * No handlers were present - Respond with an error - this condition should not occur if the
                          * definition was validated against the schema.
                          */
-                        const response: IYargsResponse = this.getBrightYargsResponse(false,
+                        const response: IYargsResponse = this.getZoweYargsResponse(false,
                             `No handlers provided for ${this.definition.name}`,
                             "command handler invoked");
                         commandExecuted(argsForHandler, response);