Update Readme and fix lint issues

.eslintrc.yaml

@@ -1,5 +1,6 @@
 extends:
   - eslint:recommended
+  - plugin:deprecation/recommended
   - plugin:@typescript-eslint/recommended-requiring-type-checking
   - prettier
 env:
@@ -31,7 +32,7 @@ rules:
   "@typescript-eslint/await-thenable": off
   "@typescript-eslint/consistent-type-assertions": warn
   "@typescript-eslint/restrict-plus-operands": off
-  "@typescript-eslint/explicit-member-accessibility": warn
+  "@typescript-eslint/explicit-member-accessibility": off
   "@typescript-eslint/explicit-function-return-type": off
   "@typescript-eslint/restrict-template-expressions": off
   indent": off

package.json

@@ -37,6 +37,7 @@
     "chalk": "^4.1.2",
     "eslint": "^8.37.0",
     "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-deprecation": "^2.0.0",
     "eslint-plugin-jest": "^27.2.1",
     "eslint-plugin-license-header": "^0.6.0",
     "eslint-plugin-prettier": "^4.2.1",

packages/cli/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to the IBM® CICS® Plug-in for Zowe CLI will be documented in this file.
 
+## Recent Changes
+
+- BugFix: Documented that exit codes with non-zero values indicate failure.
+- BugFix: Updated deprecated methods for technical currency purposes
+
 ## `6.0.0-next.202402072252`
 
 - Major: Release v3.0.0-next pre-release

packages/cli/README.md

@@ -23,6 +23,8 @@ As an application developer, you can use the plug-in to perform various CICS-rel
 
 The plug-in uses the IBM CICS management client interface (CMCI) API to achieve the interaction with CICS. For more information, see [CICS management client interface](https://www.ibm.com/docs/en/cics-ts/5.6?topic=environment-cics-management-client-interface-cmci).
 
+**Note:** The plug-in will return an exit code of `1` when there is an error coming back from the CMCI REST APIs.
+
 ## Software requirements
 
 Before you install and use the plug-in:

packages/cli/__tests__/__resources__/properties/example_properties.yaml

@@ -24,12 +24,12 @@ cics:
   user: *user
   password: *pass
   host: *host
-  port: 1443
+  port: 1234
   rejectUnauthorized: *ru
   protocol: https
 cmci:
   regionName: region-name
   csdGroup: CSDGROUP
 urimap:
-  certificate: " "
+  certificate: null
 

packages/cli/__tests__/__system__/add-to-list/csdGroup/cli.add-to-list.csdGroup.system.test.ts

@@ -13,14 +13,6 @@ import { ITestEnvironment, TestEnvironment, runCliScript } from "@zowe/cli-test-
 import { ITestPropertiesSchema } from "../../../__src__/ITestPropertiesSchema";
 
 let TEST_ENVIRONMENT: ITestEnvironment<ITestPropertiesSchema>;
-let regionName: string;
-let csdGroup: string;
-let host: string;
-let port: number;
-let user: string;
-let password: string;
-let protocol: string;
-let rejectUnauthorized: boolean;
 describe("CICS add-to-list csdGroup command", () => {
 
   beforeAll(async () => {
@@ -29,14 +21,6 @@ describe("CICS add-to-list csdGroup command", () => {
       installPlugin: true,
       tempProfileTypes: ["cics"]
     });
-    csdGroup = TEST_ENVIRONMENT.systemTestProperties.cmci.csdGroup;
-    regionName = TEST_ENVIRONMENT.systemTestProperties.cmci.regionName;
-    host = TEST_ENVIRONMENT.systemTestProperties.cics.host;
-    port = TEST_ENVIRONMENT.systemTestProperties.cics.port;
-    user = TEST_ENVIRONMENT.systemTestProperties.cics.user;
-    password = TEST_ENVIRONMENT.systemTestProperties.cics.password;
-    protocol = TEST_ENVIRONMENT.systemTestProperties.cics.protocol;
-    rejectUnauthorized = TEST_ENVIRONMENT.systemTestProperties.cics.rejectUnauthorized;
   });
 
   afterAll(async () => {

packages/cli/__tests__/__system__/define/urimap-client/cli.define.urimap.client.system.test.ts

@@ -11,18 +11,8 @@
 
 import { ITestEnvironment, TestEnvironment, runCliScript } from "@zowe/cli-test-utils";
 import { ITestPropertiesSchema } from "../../../__src__/ITestPropertiesSchema";
-import { Session } from "@zowe/imperative";
 
 let TEST_ENVIRONMENT: ITestEnvironment<ITestPropertiesSchema>;
-let regionName: string;
-let csdGroup: string;
-let host: string;
-let port: number;
-let user: string;
-let password: string;
-let protocol: string;
-let rejectUnauthorized: boolean;
-let session: Session;
 let certificate: string;
 
 describe("CICS define urimap-client command", () => {
@@ -33,25 +23,7 @@ describe("CICS define urimap-client command", () => {
       installPlugin: true,
       tempProfileTypes: ["cics"]
     });
-    const cicsProperties = TEST_ENVIRONMENT.systemTestProperties.cics;
-    csdGroup = TEST_ENVIRONMENT.systemTestProperties.cmci.csdGroup;
-    regionName = TEST_ENVIRONMENT.systemTestProperties.cmci.regionName;
-    host = TEST_ENVIRONMENT.systemTestProperties.cics.host;
-    port = TEST_ENVIRONMENT.systemTestProperties.cics.port;
-    user = TEST_ENVIRONMENT.systemTestProperties.cics.user;
-    password = TEST_ENVIRONMENT.systemTestProperties.cics.password;
-    protocol = TEST_ENVIRONMENT.systemTestProperties.cics.protocol;
-    rejectUnauthorized = TEST_ENVIRONMENT.systemTestProperties.cics.rejectUnauthorized;
     certificate = TEST_ENVIRONMENT.systemTestProperties.urimap.certificate;
-    session = new Session({
-      type: "basic",
-      hostname: cicsProperties.host,
-      port: cicsProperties.port,
-      user: cicsProperties.user,
-      password: cicsProperties.password,
-      rejectUnauthorized: cicsProperties.rejectUnauthorized || false,
-      protocol: cicsProperties.protocol as any || "https",
-    });
   });
 
   afterAll(async () => {

packages/cli/__tests__/__system__/define/urimap-pipeline/cli.define.urimap.pipeline.system.test.ts

@@ -11,18 +11,8 @@
 
 import { ITestEnvironment, TestEnvironment, runCliScript } from "@zowe/cli-test-utils";
 import { ITestPropertiesSchema } from "../../../__src__/ITestPropertiesSchema";
-import { Session } from "@zowe/imperative";
 
 let TEST_ENVIRONMENT: ITestEnvironment<ITestPropertiesSchema>;
-let regionName: string;
-let csdGroup: string;
-let host: string;
-let port: number;
-let user: string;
-let password: string;
-let protocol: string;
-let rejectUnauthorized: boolean;
-let session: Session;
 
 describe("CICS define urimap-pipeline command", () => {
 
@@ -32,24 +22,6 @@ describe("CICS define urimap-pipeline command", () => {
       installPlugin: true,
       tempProfileTypes: ["cics"]
     });
-    const cicsProperties = TEST_ENVIRONMENT.systemTestProperties.cics;
-    csdGroup = TEST_ENVIRONMENT.systemTestProperties.cmci.csdGroup;
-    regionName = TEST_ENVIRONMENT.systemTestProperties.cmci.regionName;
-    host = TEST_ENVIRONMENT.systemTestProperties.cics.host;
-    port = TEST_ENVIRONMENT.systemTestProperties.cics.port;
-    user = TEST_ENVIRONMENT.systemTestProperties.cics.user;
-    password = TEST_ENVIRONMENT.systemTestProperties.cics.password;
-    protocol = TEST_ENVIRONMENT.systemTestProperties.cics.protocol;
-    rejectUnauthorized = TEST_ENVIRONMENT.systemTestProperties.cics.rejectUnauthorized;
-    session = new Session({
-      type: "basic",
-      hostname: cicsProperties.host,
-      port: cicsProperties.port,
-      user: cicsProperties.user,
-      password: cicsProperties.password,
-      rejectUnauthorized: cicsProperties.rejectUnauthorized || false,
-      protocol: cicsProperties.protocol as any || "https",
-    });
   });
 
   afterAll(async () => {