@provartesting/provardx-cli 0.0.3 → 0.0.5-beta

package/oclif.manifest.json

@@ -1,143 +1,411 @@
 {
-  "version": "0.0.3",
   "commands": {
-    "sf:provar:config:generate": {
-      "id": "sf:provar:config:generate",
-      "summary": "Summary of a command.",
-      "description": "Generate a boilerplate property file.",
-      "strict": true,
-      "pluginName": "@provartesting/provardx-cli",
-      "pluginAlias": "@provartesting/provardx-cli",
-      "pluginType": "core",
+    "provar:automation:config:generate": {
       "aliases": [],
+      "args": {},
+      "description": "Generates a boilerplate ProvarDX properties file.",
       "examples": [
-        "Generates the boiler plate properties.json at the given path :\n<%= config.bin %> <%= command.id %> --properties-file 'propertiesFile path'"
+        "Generates a boilerplate ProvarDX properties file at the given path :\n<%= config.bin %> <%= command.id %> --properties-file 'propertiesFile path'"
       ],
       "flags": {
         "json": {
-          "name": "json",
-          "type": "boolean",
           "description": "Format output as json.",
           "helpGroup": "GLOBAL",
-          "allowNo": false
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
         },
         "properties-file": {
-          "name": "properties-file",
-          "type": "option",
           "char": "p",
-          "summary": "Provardx-properties file path.",
+          "name": "properties-file",
           "required": true,
-          "multiple": false
+          "summary": "Provardx-properties file path.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         },
         "no-prompt": {
-          "name": "no-prompt",
-          "type": "boolean",
           "char": "n",
+          "name": "no-prompt",
           "summary": "Don't prompt to confirm overwriting of the properties file if it already exists and overwrite it by default.",
-          "allowNo": false
+          "allowNo": false,
+          "type": "boolean"
         }
       },
-      "args": {}
-    },
-    "sf:provar:config:get": {
-      "id": "sf:provar:config:get",
-      "summary": "getting values for different properties inside dx properties.json",
-      "description": "Getting values for different properties inside PROPERTIES_FILE_PATH loaded under .sf/config.json file",
-      "strict": false,
-      "pluginName": "@provartesting/provardx-cli",
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "provar:automation:config:generate",
       "pluginAlias": "@provartesting/provardx-cli",
+      "pluginName": "@provartesting/provardx-cli",
       "pluginType": "core",
+      "strict": true,
+      "summary": "Generates a boilerplate ProvarDX properties file.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "provar",
+        "automation",
+        "config",
+        "generate.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "provar:automation:config:generate",
+        "automation:provar:config:generate",
+        "automation:config:provar:generate",
+        "automation:config:generate:provar",
+        "provar:config:automation:generate",
+        "config:provar:automation:generate",
+        "config:automation:provar:generate",
+        "config:automation:generate:provar",
+        "provar:config:generate:automation",
+        "config:provar:generate:automation",
+        "config:generate:provar:automation",
+        "config:generate:automation:provar",
+        "provar:automation:generate:config",
+        "automation:provar:generate:config",
+        "automation:generate:provar:config",
+        "automation:generate:config:provar",
+        "provar:generate:automation:config",
+        "generate:provar:automation:config",
+        "generate:automation:provar:config",
+        "generate:automation:config:provar",
+        "provar:generate:config:automation",
+        "generate:provar:config:automation",
+        "generate:config:provar:automation",
+        "generate:config:automation:provar"
+      ]
+    },
+    "provar:automation:config:get": {
       "aliases": [],
+      "args": {},
+      "description": "Retrieves a value from the loaded properties file.",
       "examples": [
-        "gets the value for the provided property as a key from properties.json loaded inside config.json\n<%= config.bin %> <%= command.id %> 'key'"
+        "Retrieves a value from the loaded properties file\n<%= config.bin %> <%= command.id %> 'key'"
       ],
       "flags": {
         "json": {
-          "name": "json",
-          "type": "boolean",
           "description": "Format output as json.",
           "helpGroup": "GLOBAL",
-          "allowNo": false
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
-      "args": {}
-    },
-    "sf:provar:config:load": {
-      "id": "sf:provar:config:load",
-      "summary": "Loading provardx-properties.json into system environment variables.",
-      "description": "Loading after internally validating the provardx-properties.json file generated via config generate command",
-      "strict": true,
-      "pluginName": "@provartesting/provardx-cli",
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "provar:automation:config:get",
       "pluginAlias": "@provartesting/provardx-cli",
+      "pluginName": "@provartesting/provardx-cli",
       "pluginType": "core",
+      "strict": false,
+      "summary": "Retrieves a value from the loaded properties file.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "provar",
+        "automation",
+        "config",
+        "get.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "provar:automation:config:get",
+        "automation:provar:config:get",
+        "automation:config:provar:get",
+        "automation:config:get:provar",
+        "provar:config:automation:get",
+        "config:provar:automation:get",
+        "config:automation:provar:get",
+        "config:automation:get:provar",
+        "provar:config:get:automation",
+        "config:provar:get:automation",
+        "config:get:provar:automation",
+        "config:get:automation:provar",
+        "provar:automation:get:config",
+        "automation:provar:get:config",
+        "automation:get:provar:config",
+        "automation:get:config:provar",
+        "provar:get:automation:config",
+        "get:provar:automation:config",
+        "get:automation:provar:config",
+        "get:automation:config:provar",
+        "provar:get:config:automation",
+        "get:provar:config:automation",
+        "get:config:provar:automation",
+        "get:config:automation:provar"
+      ]
+    },
+    "provar:automation:config:load": {
       "aliases": [],
+      "args": {},
+      "description": "Validates and loads a ProvarDX properties file for later use.",
       "examples": [
-        "loads the properties.json at the given path\n<%= config.bin %> <%= command.id %> --properties-file 'propertiesFile path'"
+        "Validates and loads a ProvarDX properties file for later use at the given path\n<%= config.bin %> <%= command.id %> --properties-file 'propertiesFile path'"
       ],
       "flags": {
         "json": {
-          "name": "json",
-          "type": "boolean",
           "description": "Format output as json.",
           "helpGroup": "GLOBAL",
-          "allowNo": false
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
         },
         "properties-file": {
-          "name": "properties-file",
-          "type": "option",
           "char": "p",
-          "summary": "Path of the properties file to be loaded.",
+          "name": "properties-file",
           "required": true,
-          "multiple": false
+          "summary": "Path of the properties file to be loaded.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
-      "args": {}
-    },
-    "sf:provar:config:set": {
-      "id": "sf:provar:config:set",
-      "summary": "Setting different properties inside dx-properties.json",
-      "description": "Setting different properties inside dx-properties.json loaded under .sf/config.json file",
-      "strict": false,
-      "pluginName": "@provartesting/provardx-cli",
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "provar:automation:config:load",
       "pluginAlias": "@provartesting/provardx-cli",
+      "pluginName": "@provartesting/provardx-cli",
       "pluginType": "core",
+      "strict": true,
+      "summary": "Validates and loads a ProvarDX properties file for later use.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "provar",
+        "automation",
+        "config",
+        "load.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "provar:automation:config:load",
+        "automation:provar:config:load",
+        "automation:config:provar:load",
+        "automation:config:load:provar",
+        "provar:config:automation:load",
+        "config:provar:automation:load",
+        "config:automation:provar:load",
+        "config:automation:load:provar",
+        "provar:config:load:automation",
+        "config:provar:load:automation",
+        "config:load:provar:automation",
+        "config:load:automation:provar",
+        "provar:automation:load:config",
+        "automation:provar:load:config",
+        "automation:load:provar:config",
+        "automation:load:config:provar",
+        "provar:load:automation:config",
+        "load:provar:automation:config",
+        "load:automation:provar:config",
+        "load:automation:config:provar",
+        "provar:load:config:automation",
+        "load:provar:config:automation",
+        "load:config:provar:automation",
+        "load:config:automation:provar"
+      ]
+    },
+    "provar:automation:config:set": {
       "aliases": [],
+      "args": {},
+      "description": "Sets a property in the loaded properties file.",
       "examples": [
-        "sets the provided properties with resp. values as key=value in properties.json\n<%= config.bin %> <%= command.id %> 'key'='value'"
+        "Sets a property in the loaded properties file with resp. values\n<%= config.bin %> <%= command.id %> 'key'='value'"
       ],
       "flags": {
         "json": {
-          "name": "json",
-          "type": "boolean",
           "description": "Format output as json.",
           "helpGroup": "GLOBAL",
-          "allowNo": false
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
-      "args": {}
-    },
-    "sf:provar:config:validate": {
-      "id": "sf:provar:config:validate",
-      "summary": "Validate the loaded provardx-properties.json against schema.",
-      "description": "Validating provardx-properties.json against the schema for all the needed properties with their expected values.",
-      "strict": true,
-      "pluginName": "@provartesting/provardx-cli",
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "provar:automation:config:set",
       "pluginAlias": "@provartesting/provardx-cli",
+      "pluginName": "@provartesting/provardx-cli",
       "pluginType": "core",
+      "strict": false,
+      "summary": "Sets a property in the loaded properties file.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "provar",
+        "automation",
+        "config",
+        "set.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "provar:automation:config:set",
+        "automation:provar:config:set",
+        "automation:config:provar:set",
+        "automation:config:set:provar",
+        "provar:config:automation:set",
+        "config:provar:automation:set",
+        "config:automation:provar:set",
+        "config:automation:set:provar",
+        "provar:config:set:automation",
+        "config:provar:set:automation",
+        "config:set:provar:automation",
+        "config:set:automation:provar",
+        "provar:automation:set:config",
+        "automation:provar:set:config",
+        "automation:set:provar:config",
+        "automation:set:config:provar",
+        "provar:set:automation:config",
+        "set:provar:automation:config",
+        "set:automation:provar:config",
+        "set:automation:config:provar",
+        "provar:set:config:automation",
+        "set:provar:config:automation",
+        "set:config:provar:automation",
+        "set:config:automation:provar"
+      ]
+    },
+    "provar:automation:config:validate": {
       "aliases": [],
+      "args": {},
+      "description": "Checks if the loaded properties file has all the required properties set.",
       "examples": [
-        "Validate the loaded provardx-properties.json loaded under environment variables :\n<%= config.bin %> <%= command.id %>'"
+        "Checks if the loaded properties file has all the required properties set\n<%= config.bin %> <%= command.id %>'"
       ],
       "flags": {
         "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
           "name": "json",
-          "type": "boolean",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "provar:automation:config:validate",
+      "pluginAlias": "@provartesting/provardx-cli",
+      "pluginName": "@provartesting/provardx-cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Checks if the loaded properties file has all the required properties set.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "provar",
+        "automation",
+        "config",
+        "validate.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "provar:automation:config:validate",
+        "automation:provar:config:validate",
+        "automation:config:provar:validate",
+        "automation:config:validate:provar",
+        "provar:config:automation:validate",
+        "config:provar:automation:validate",
+        "config:automation:provar:validate",
+        "config:automation:validate:provar",
+        "provar:config:validate:automation",
+        "config:provar:validate:automation",
+        "config:validate:provar:automation",
+        "config:validate:automation:provar",
+        "provar:automation:validate:config",
+        "automation:provar:validate:config",
+        "automation:validate:provar:config",
+        "automation:validate:config:provar",
+        "provar:validate:automation:config",
+        "validate:provar:automation:config",
+        "validate:automation:provar:config",
+        "validate:automation:config:provar",
+        "provar:validate:config:automation",
+        "validate:provar:config:automation",
+        "validate:config:provar:automation",
+        "validate:config:automation:provar"
+      ]
+    },
+    "provar:automation:metadata:download": {
+      "aliases": [],
+      "args": {},
+      "description": "Download any required metadata for a specified Provar Salesforce connection.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {
+        "json": {
           "description": "Format output as json.",
           "helpGroup": "GLOBAL",
-          "allowNo": false
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "connections": {
+          "char": "c",
+          "name": "connections",
+          "required": true,
+          "summary": "Comma-separated list of names of Provar Salesforce connections to use, as defined in the project.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
-      "args": {}
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "provar:automation:metadata:download",
+      "pluginAlias": "@provartesting/provardx-cli",
+      "pluginName": "@provartesting/provardx-cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Download any required metadata for a specified Provar Salesforce connection.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "provar",
+        "automation",
+        "metadata",
+        "download.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "provar:automation:metadata:download",
+        "automation:provar:metadata:download",
+        "automation:metadata:provar:download",
+        "automation:metadata:download:provar",
+        "provar:metadata:automation:download",
+        "metadata:provar:automation:download",
+        "metadata:automation:provar:download",
+        "metadata:automation:download:provar",
+        "provar:metadata:download:automation",
+        "metadata:provar:download:automation",
+        "metadata:download:provar:automation",
+        "metadata:download:automation:provar",
+        "provar:automation:download:metadata",
+        "automation:provar:download:metadata",
+        "automation:download:provar:metadata",
+        "automation:download:metadata:provar",
+        "provar:download:automation:metadata",
+        "download:provar:automation:metadata",
+        "download:automation:provar:metadata",
+        "download:automation:metadata:provar",
+        "provar:download:metadata:automation",
+        "download:provar:metadata:automation",
+        "download:metadata:provar:automation",
+        "download:metadata:automation:provar"
+      ]
     }
-  }
+  },
+  "version": "0.0.5-beta"
 }

package/package.json

@@ -1,43 +1,24 @@
 {
   "name": "@provartesting/provardx-cli",
   "description": "A plugin for the Salesforce CLI to orchestrate testing activities and report quality metrics to Provar Manager",
-  "version": "0.0.3",
+  "version": "0.0.5-beta",
   "license": "BSD-3-Clause",
   "dependencies": {
-    "@oclif/core": "^2.11.8",
-    "@salesforce/core": "^5.2.10",
-    "@salesforce/kit": "^3.0.14",
-    "@salesforce/sf-plugins-core": "^3.1.14",
-    "mochawesome": "^7.1.3",
-    "jsonschema": "^1.4.1",
-    "tslib": "^2"
+    "@oclif/core": "^3.18.1",
+    "@salesforce/core": "^6.5.1",
+    "@salesforce/kit": "^3.0.15",
+    "@salesforce/sf-plugins-core": "^7.1.4",
+    "@salesforce/ts-types": "^2.0.9",
+    "cli-ux": "^6.0.9",
+    "jsonschema": "^1.4.1"
   },
   "devDependencies": {
-    "@salesforce/cli-plugins-testkit": "^5.0.2",
-    "@salesforce/dev-config": "^4.0.1",
-    "@salesforce/dev-scripts": "^5.7.0",
-    "@salesforce/prettier-config": "^0.0.3",
-    "@salesforce/ts-sinon": "^1.4.18",
-    "@swc/core": "^1.3.19",
-    "@types/chai": "^4.3.10",
-    "@types/inquirer": "^9.0.3",
-    "@types/mocha": "^10.0.4",
-    "@typescript-eslint/eslint-plugin": "^5.62.0",
-    "@typescript-eslint/parser": "^5.62.0",
-    "chai": "^4.3.10",
-    "eslint": "^8.50.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-config-salesforce": "^2.0.2",
-    "eslint-config-salesforce-typescript": "^1.1.2",
-    "eslint-plugin-import": "2.28.1",
-    "eslint-plugin-jsdoc": "^46.4.6",
-    "eslint-plugin-sf-plugin": "^1.16.2",
-    "husky": "^7.0.4",
-    "mocha": "^9.2.2",
-    "nyc": "^15.1.0",
-    "oclif": "^3.17.2",
-    "prettier": "^2.8.8",
-    "pretty-quick": "^3.1.3",
+    "@oclif/plugin-command-snapshot": "^5.0.2",
+    "@salesforce/cli-plugins-testkit": "^5.1.7",
+    "@salesforce/dev-scripts": "^8.3.0",
+    "eslint-plugin-sf-plugin": "^1.17.2",
+    "mochawesome": "^7.1.3",
+    "oclif": "^4.3.4",
     "shx": "0.3.4",
     "sinon": "10.0.0",
     "ts-node": "^10.9.1",
@@ -45,7 +26,7 @@
     "wireit": "^0.14.0"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=18.0.0"
   },
   "files": [
     "/lib",
@@ -55,13 +36,12 @@
   "keywords": [
     "force",
     "salesforce",
-    "sfdx",
     "salesforcedx",
-    "sfdx-plugin",
+    "sf",
     "sf-plugin",
-    "sf"
+    "sfdx",
+    "sfdx-plugin"
   ],
-  "main": "lib/index.js",
   "oclif": {
     "commands": "./lib/commands",
     "bin": "sf",
@@ -70,20 +50,26 @@
       "@oclif/plugin-help"
     ],
     "topics": {
-      "sf": {
-        "description": "commands to automate salesforce",
+      "provar": {
+        "description": "CLI commands to interact with Provar.",
         "subtopics": {
-          "provar": {
-            "description": "commands to manipulate properties file & automate salesforce using provardx",
+          "automation": {
+            "description": "These commands are used to interact with Provar Automation.",
             "subtopics": {
               "config": {
-                "description": "commands to generate and manipulate provardx-properties file"
+                "description": "commands to generate and manipulate provardx-properties file."
+              },
+              "subtopics": {
+                "metadata": {
+                  "description": "commands to download metadata for required connections."
+                }
               }
             }
           }
         }
       }
-    }
+    },
+    "flexibleTaxonomy": true
   },
   "scripts": {
     "build": "wireit",
@@ -147,9 +133,10 @@
       "output": []
     },
     "test:compile": {
-      "command": "tsc -p \"./test\" --pretty ",
+      "command": "tsc -p \"./test\" --pretty",
       "files": [
-        "test/**/*.ts"
+        "test/**/*.ts",
+        "**/tsconfig.json"
       ],
       "output": []
     },
@@ -204,5 +191,7 @@
       ],
       "output": []
     }
-  }
-}
+  },
+  "exports": "./lib/index.js",
+  "type": "module"
+}