@broadcom/mat-analyze-for-zowe-cli 2.0.6 → 3.0.0

package/lib/healthCheck.Handler.js

@@ -21,26 +21,127 @@
  * INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF BROADCOM IS
  * EXPRESSLY ADVISED OF SUCH LOSS OR DAMAGE.
  */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.LifeCycleForSample = void 0;
 const imperative_1 = require("@zowe/imperative");
-class HealthCheckHandler {
-    process(params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            imperative_1.Logger.getImperativeLogger().debug("Invoked health check handler");
-            params.response.console.log("You would report problems identified by healthCheck.\n" +
-                "This handler is not currently called by Imperative, but\n" +
-                "its existence prevents a warning during plugin validation.");
-        });
+/**
+ * This class performs lifecycle functions for your plug-in. You are free to
+ * change the name of this class to reflect your plug-in and its actions.
+ *
+ * You only have to supply such a class if you specify the 'pluginLifeCycle'
+ * property in your IImperativeConfig definition for your plug-in. In this sample,
+ * that definition is supplied in src/pluginDef.ts.
+ */
+class LifeCycleForSample extends imperative_1.AbstractPluginLifeCycle {
+    /**
+     * This function will be called after a plug-in is installed.
+     * A plug-in can use this opportunity to perform a sanity test or to
+     * perform some additional setup which is specific to your plug-in.
+     *
+     * If your plug-in's postInstall function performs an asynchronous operation,
+     * its postInstall function should return a promise, allowing the CLI
+     * to await the postInstall function. Such a signature would be like this:
+     *
+     *      public async postInstall(): Promise<void>
+     *
+     * If it has no asynchronous operation, the postInstall function can be
+     * written as a synchronous function. That is the style which this trivial
+     * synchronous sample uses below.
+     *
+     * If you supply this class, you must supply this function. If you have nothing to
+     * do post-install, then simply return from the function.
+     */
+    postInstall() {
+        /* It is up to you to decide what actions are meaningful for you
+         * to perform immediately after your plug-in is installed.
+         *
+         * When all goes well, you probably should display nothing to the user.
+         */
+        // const somethingWeirdOccurred = true;
+        // if ( somethingWeirdOccurred ) {
+        //     /* If you display a message about a problem, you should also log the
+        //      * message to a file, so that the message can be found later.
+        //      *
+        //      * You can use a consoleLogger to display a message. The available logging
+        //      * levels can be found in the Zowe doc:
+        //      * https://docs.zowe.org/stable/user-guide/cli-configuringcli-ev/#setting-cli-log-levels
+        //      *
+        //      * Note that the user controls the logging level with the
+        //      * ZOWE_IMPERATIVE_LOG_LEVEL environment variable. When not set, the
+        //      * default log level is WARN. So by default, only messages displayed at
+        //      * the WARN, ERROR, and FATAL levels will be displayed (or logged).
+        //      */
+        //     const warnMsg = "Something weird happened in the sample plug-in's " +
+        //         "postInstall function. However, things should still work ok.";
+        //     Logger.getConsoleLogger().warn(warnMsg);
+        //     Logger.getImperativeLogger().warn(warnMsg);
+        // }
+        /* When you are unable to achieve your desired actions, you should throw
+         * an imperative error. The "zowe plugins install" command will catch
+         * that error, display it, and add some additional information.
+         *
+         * Your plug-in has already been installed. However, when you throw an
+         * error during your postInstall function, the 'zowe plugins install'
+         * command will exit with a non-zero exit code.
+         */
+        // const someBigProblemOccurred = false;
+        // if ( someBigProblemOccurred ) {
+        //     throw new ImperativeError({
+        //         msg: "Something awful happened in the sample plug-in's " +
+        //             "postInstall function. Thus, the plug-in could not be properly setup."
+        //     });
+        // }
+    }
+    /**
+     * This function will be called before a plug-in is uninstalled.
+     * This lifecycle hook is intended to replace the capability that used to
+     * be performed by the NPM pre-uninstall action before NPM removed that
+     * capability in NPM version 7.
+     * See https://docs.npmjs.com/cli/v9/using-npm/scripts#a-note-on-a-lack-of-npm-uninstall-scripts
+     *
+     * A plug-in can use this opportunity to revert any specialized setup that was
+     * established during the lifetime of your plug-in.
+     *
+     * If your plug-in's preUninstall function performs an asynchronous operation,
+     * its preUninstall function should return a promise, allowing the CLI
+     * framework to await the preUninstall function. Such a signature would be like this:
+     *
+     *      public async preUninstall(): Promise<void>
+     *
+     * If it has no asynchronous operation, the preUninstall function can be
+     * written as a synchronous function. That is the style which this trivial
+     * synchronous sample uses below.
+     *
+     * If you supply this class, you must supply this function. If you have nothing to
+     * do pre-uninstall, then simply return from the function.
+     */
+    preUninstall() {
+        /* The comments from the postInstall function also apply to the
+         * preUninstall function.
+         */
+        // const somethingWeirdOccurred = true;
+        // if ( somethingWeirdOccurred ) {
+        //     const warnMsg = "Something weird happened in the sample plug-in's " +
+        //         "preUninstall function that we thought you should know about.";
+        //     Logger.getConsoleLogger().warn(warnMsg);
+        //     Logger.getImperativeLogger().warn(warnMsg);
+        // }
+        /* When you throw an error during your preUninstall function, the
+         * 'zowe plugins uninstall' catches the error and still performs the
+         * uninstall operation that was requested by the user. If the actual
+         * uninstall operation succeeds, the command will exit with a zero
+         * exit code.
+         */
+        // const someBigProblemOccurred = false;
+        // if ( someBigProblemOccurred ) {
+        //     throw new ImperativeError({
+        //         msg: "Something awful happened during the sample plug-in's " +
+        //             "preUninstall function. Maybe you have to manually release " +
+        //             "some resource that was used by this plug-in."
+        //     });
+        // }
     }
 }
-exports.default = HealthCheckHandler;
+exports.LifeCycleForSample = LifeCycleForSample;
+module.exports = LifeCycleForSample;
 //# sourceMappingURL=healthCheck.Handler.js.map

package/lib/healthCheck.Handler.js.map

@@ -1 +1 @@
-{"version":3,"file":"healthCheck.Handler.js","sourceRoot":"","sources":["../src/healthCheck.Handler.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;;;;;;;;;;;AAEH,iDAA6E;AAE7E,MAAqB,kBAAkB;IACxB,OAAO,CAAC,MAA0B;;YAC7C,mBAAM,CAAC,mBAAmB,EAAE,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC;YACnE,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,wDAAwD;gBAClF,2DAA2D;gBAC3D,4DAA4D,CAC7D,CAAC;QACJ,CAAC;KAAA;CACF;AARD,qCAQC"}
+{"version":3,"file":"healthCheck.Handler.js","sourceRoot":"","sources":["../src/healthCheck.Handler.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;;;AAEH,iDAAkF;AAElF;;;;;;;GAOG;AACH,MAAa,kBAAmB,SAAQ,oCAAuB;IAC7D;;;;;;;;;;;;;;;;;OAiBG;IACI,WAAW;QAChB;;;;WAIG;QAEH,uCAAuC;QACvC,kCAAkC;QAClC,2EAA2E;QAC3E,oEAAoE;QACpE,SAAS;QACT,iFAAiF;QACjF,8CAA8C;QAC9C,+FAA+F;QAC/F,SAAS;QACT,gEAAgE;QAChE,2EAA2E;QAC3E,8EAA8E;QAC9E,0EAA0E;QAC1E,UAAU;QACV,4EAA4E;QAC5E,yEAAyE;QACzE,+CAA+C;QAC/C,kDAAkD;QAClD,IAAI;QAEJ;;;;;;;WAOG;QACH,wCAAwC;QACxC,kCAAkC;QAClC,kCAAkC;QAClC,qEAAqE;QACrE,qFAAqF;QACrF,UAAU;QACV,IAAI;IACN,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACI,YAAY;QACjB;;WAEG;QACH,uCAAuC;QACvC,kCAAkC;QAClC,4EAA4E;QAC5E,0EAA0E;QAC1E,+CAA+C;QAC/C,kDAAkD;QAClD,IAAI;QAEJ;;;;;WAKG;QACH,wCAAwC;QACxC,kCAAkC;QAClC,kCAAkC;QAClC,yEAAyE;QACzE,6EAA6E;QAC7E,6DAA6D;QAC7D,UAAU;QACV,IAAI;IACN,CAAC;CACF;AAjHD,gDAiHC;AAED,MAAM,CAAC,OAAO,GAAG,kBAAkB,CAAC"}

package/lib/imperative.js

@@ -24,7 +24,7 @@
 const MATSession_1 = require("./cli/session/MATSession");
 const config = {
     commandModuleGlobs: ["**/cli/*/*.definition!(.d).*s"],
-    pluginHealthCheck: __dirname + "/healthCheck.Handler",
+    pluginLifeCycle: __dirname + "/healthCheck.Handler",
     pluginSummary: "Manage monitor profiles and analyze the measurement data using MAT",
     pluginAliases: ["mat"],
     rootCommandDescription: "The MAT Analyze plug-in for ZOWE CLI enables you to manage monitor profiles " +
@@ -51,7 +51,7 @@ const config = {
                         optionDefinition: MATSession_1.MATSession.MAT_REST_PORT,
                         type: "number"
                     },
-                    username: {
+                    user: {
                         optionDefinition: MATSession_1.MATSession.MAT_CLI_USERNAME,
                         type: "string",
                         secure: true
@@ -76,19 +76,6 @@ const config = {
                 },
                 required: [],
             },
-            createProfileExamples: [
-                {
-                    options: "matprofile --o http --H localhost --P 1234 --u user --pw pass --base-path \'API\\MAT\'",
-                    description: "Create a MAT profile called \'matprofile\' using your MAT configuration and REST API details, " +
-                        "with the MAT REST API server integrated with the Zowe API Mediation Layer"
-                },
-                {
-                    options: "matprofile --o http --H localhost --P 1234 --u user --pw pass --listingDir \'c:\\listings\'",
-                    description: "Create a MAT profile called \'matprofile\' using your MAT configuration and the details of the " +
-                        "MAT REST API server without integration with the Zowe API Mediation Layer," +
-                        "and define the \'c:\\listings\' directory to store program listings for instant analysis from your VS Code IDE"
-                },
-            ]
         }
     ]
 };

package/lib/imperative.js.map

@@ -1 +1 @@
-{"version":3,"file":"imperative.js","sourceRoot":"","sources":["../src/imperative.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAGH,yDAAsD;AAEtD,MAAM,MAAM,GAAsB;IAC9B,kBAAkB,EAAE,CAAC,+BAA+B,CAAC;IACrD,iBAAiB,EAAE,SAAS,GAAG,sBAAsB;IACrD,aAAa,EAAE,oEAAoE;IACnF,aAAa,EAAE,CAAC,KAAK,CAAC;IACtB,sBAAsB,EAAE,8EAA8E;QACtG,+EAA+E;IAC/E,kBAAkB,EAAE,kCAAkC;IACtD,IAAI,EAAE,KAAK;IACX,QAAQ,EAAE;QACN;YACE,IAAI,EAAE,KAAK;YACX,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,gCAAgC;gBACvC,WAAW,EAAE,iCAAiC;gBAC9C,UAAU,EAAE;oBACV,QAAQ,EAAE;wBACR,gBAAgB,EAAE,uBAAU,CAAC,iBAAiB;wBAC9C,IAAI,EAAE,QAAQ;qBACf;oBACD,QAAQ,EAAE;wBACR,gBAAgB,EAAE,uBAAU,CAAC,iBAAiB;wBAC9C,IAAI,EAAE,QAAQ;qBACf;oBACD,IAAI,EAAE;wBACJ,gBAAgB,EAAE,uBAAU,CAAC,aAAa;wBAC1C,IAAI,EAAE,QAAQ;qBACf;oBACD,QAAQ,EAAE;wBACR,gBAAgB,EAAE,uBAAU,CAAC,gBAAgB;wBAC7C,IAAI,EAAE,QAAQ;wBACd,MAAM,EAAE,IAAI;qBACb;oBACD,QAAQ,EAAE;wBACR,gBAAgB,EAAE,uBAAU,CAAC,gBAAgB;wBAC7C,IAAI,EAAE,QAAQ;wBACd,MAAM,EAAE,IAAI;qBACb;oBACD,QAAQ,EAAE;wBACR,gBAAgB,EAAE,uBAAU,CAAC,iBAAiB;wBAC9C,IAAI,EAAE,QAAQ;qBACf;oBACD,kBAAkB,EAAE;wBAClB,gBAAgB,EAAE,uBAAU,CAAC,2BAA2B;wBACxD,IAAI,EAAE,SAAS;qBAChB;oBACD,UAAU,EAAE;wBACV,gBAAgB,EAAE,uBAAU,CAAC,kBAAkB;wBAC/C,IAAI,EAAE,QAAQ;qBACf;iBACF;gBACD,QAAQ,EAAE,EAAE;aACb;YACD,qBAAqB,EAAE;gBACvB;oBACE,OAAO,EAAE,wFAAwF;oBACjG,WAAW,EAAE,gGAAgG;wBAC3G,2EAA2E;iBAC9E;gBACD;oBACE,OAAO,EAAE,6FAA6F;oBACtG,WAAW,EAAE,iGAAiG;wBAC5G,4EAA4E;wBAC5E,gHAAgH;iBACnH;aACA;SACF;KACJ;CACJ,CAAC;AAEF,iBAAS,MAAM,CAAC"}
+{"version":3,"file":"imperative.js","sourceRoot":"","sources":["../src/imperative.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAGH,yDAAsD;AAEtD,MAAM,MAAM,GAAsB;IAC9B,kBAAkB,EAAE,CAAC,+BAA+B,CAAC;IACrD,eAAe,EAAE,SAAS,GAAG,sBAAsB;IACnD,aAAa,EAAE,oEAAoE;IACnF,aAAa,EAAE,CAAC,KAAK,CAAC;IACtB,sBAAsB,EAAE,8EAA8E;QACtG,+EAA+E;IAC/E,kBAAkB,EAAE,kCAAkC;IACtD,IAAI,EAAE,KAAK;IACX,QAAQ,EAAE;QACN;YACE,IAAI,EAAE,KAAK;YACX,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,gCAAgC;gBACvC,WAAW,EAAE,iCAAiC;gBAC9C,UAAU,EAAE;oBACV,QAAQ,EAAE;wBACR,gBAAgB,EAAE,uBAAU,CAAC,iBAAiB;wBAC9C,IAAI,EAAE,QAAQ;qBACf;oBACD,QAAQ,EAAE;wBACR,gBAAgB,EAAE,uBAAU,CAAC,iBAAiB;wBAC9C,IAAI,EAAE,QAAQ;qBACf;oBACD,IAAI,EAAE;wBACJ,gBAAgB,EAAE,uBAAU,CAAC,aAAa;wBAC1C,IAAI,EAAE,QAAQ;qBACf;oBACD,IAAI,EAAE;wBACJ,gBAAgB,EAAE,uBAAU,CAAC,gBAAgB;wBAC7C,IAAI,EAAE,QAAQ;wBACd,MAAM,EAAE,IAAI;qBACb;oBACD,QAAQ,EAAE;wBACR,gBAAgB,EAAE,uBAAU,CAAC,gBAAgB;wBAC7C,IAAI,EAAE,QAAQ;wBACd,MAAM,EAAE,IAAI;qBACb;oBACD,QAAQ,EAAE;wBACR,gBAAgB,EAAE,uBAAU,CAAC,iBAAiB;wBAC9C,IAAI,EAAE,QAAQ;qBACf;oBACD,kBAAkB,EAAE;wBAClB,gBAAgB,EAAE,uBAAU,CAAC,2BAA2B;wBACxD,IAAI,EAAE,SAAS;qBAChB;oBACD,UAAU,EAAE;wBACV,gBAAgB,EAAE,uBAAU,CAAC,kBAAkB;wBAC/C,IAAI,EAAE,QAAQ;qBACf;iBACF;gBACD,QAAQ,EAAE,EAAE;aACb;SACF;KACJ;CACJ,CAAC;AAEF,iBAAS,MAAM,CAAC"}

package/lib/index.js

@@ -23,13 +23,17 @@
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /**

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;;;;;;;;;;;;AAEH;;;;;;;;GAQG;AACH,2DAAyC;AACzC,gDAA8B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;;;;;;;;;;;;;;;;AAEH;;;;;;;;GAQG;AACH,2DAAyC;AACzC,gDAA8B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@broadcom/mat-analyze-for-zowe-cli",
-  "version": "2.0.6",
+  "version": "3.0.0",
   "description": "MAT Analyze Plug-in for Zowe CLI",
   "author": "Broadcom",
   "license": "SEE LICENSE IN LICENSE",
@@ -16,7 +16,8 @@
     "clean": "rimraf lib",
     "watch": "tsc --pretty --watch",
     "prepublishOnly": "npm run build",
-    "lint": "tslint \"src/**/*.ts\"",
+    "lint": "eslint  \"src/**/*.ts\"",
+    "eslint-fix": "eslint --fix \"src/**/*.ts\"",
     "test": "npm run test:unit && npm run test:system",
     "test:system": "env-cmd __tests__/__resources__/env/system.env jest .*/__system__/.* --coverage false",
     "test:unit": "env-cmd __tests__/__resources__/env/unit.env jest --coverage --testPathIgnorePatterns \".*/__system__/.*\"",
@@ -29,44 +30,42 @@
     "configurationModule": "lib/imperative.js"
   },
   "dependencies": {
-    "@broadcom/endevor-for-zowe-cli": "7.3.0",
     "object-mapper": "6.2.0"
   },
   "peerDependencies": {
-    "@zowe/imperative": "^5.0.0"
+    "@zowe/imperative": "^8.0.0"
   },
   "devDependencies": {
-    "@types/config": "0.0.34",
-    "@types/fs-extra": "^9.0.0",
-    "@types/jest": "^24.0.9",
-    "@types/mustache": "^0.8.32",
-    "@types/node": "^14.0.1",
-    "@types/yargs": "8.0.2",
-    "@zowe/cli": "7.13.0",
-    "@zowe/cli-test-utils": "^7.16.3",
-    "@zowe/imperative": "^5.14.2",
-    "config": "^3.2.2",
-    "copyfiles": "2.2.0",
+    "@types/config": "3.3.4",
+    "@types/fs-extra": "^11.0.4",
+    "@types/jest": "^29.5.12",
+    "@types/mustache": "^4.2.5",
+    "@types/node": "^18.19.43",
+    "@types/yargs": "17.0.33",
+    "@zowe/cli": "^8.0.0",
+    "@zowe/cli-test-utils": "^8.0.0",
+    "@zowe/imperative": "^8.0.0",
+    "config": "^3.3.12",
+    "copyfiles": "2.4.1",
     "env-cmd": "^8.0.2",
-    "fs-extra": "^8.1.0",
-    "glob": "^7.1.3",
-    "jest": "^24.5.0",
-    "jest-cli": "^24.9.0",
-    "jest-environment-node": "^24.9.0",
+    "fs-extra": "^11.2.0",
+    "glob": "^9.3.5",
+    "jest": "^29.7.0",
+    "jest-cli": "^29.7.0",
+    "jest-environment-node": "^29.7.0",
     "jest-environment-node-debug": "^2.0.0",
-    "jest-html-reporter": "^3.3.0",
-    "jest-junit": "^6.3.0",
-    "jest-stare": "^2.2.0",
-    "js-yaml": "^3.13.1",
-    "rimraf": "^2.7.1",
-    "shebang-regex": "^2.0.0",
-    "ts-jest": "^24.2.0",
-    "ts-node": "^7.0.1",
-    "tslint": "^5.20.1",
-    "tslint-etc": "^1.10.0",
-    "tsutils": "^3.17.1",
-    "typescript": "^3.9.6",
-    "uuid": "^3.2.1"
+    "jest-html-reporter": "^3.10.2",
+    "jest-junit": "^16.0.0",
+    "jest-stare": "^2.5.2",
+    "js-yaml": "^4.1.0",
+    "rimraf": "^6.0.1",
+    "shebang-regex": "^4.0.0",
+    "ts-jest": "^29.2.4",
+    "ts-node": "^10.9.2",
+    "tsutils": "^3.21.0",
+    "typescript": "^5.5.4",
+    "typescript-eslint": "^8.1.0",
+    "uuid": "^10.0.0"
   },
   "jest": {
     "modulePathIgnorePatterns": [