@provartesting/provardx-cli 0.0.1

package/oclif.manifest.json

@@ -0,0 +1,143 @@
+{
+  "version": "0.0.1",
+  "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",
+      "aliases": [],
+      "examples": [
+        "Generates the boiler plate properties.json 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
+        },
+        "properties-file": {
+          "name": "properties-file",
+          "type": "option",
+          "char": "p",
+          "summary": "Provardx-properties file path.",
+          "required": true,
+          "multiple": false
+        },
+        "no-prompt": {
+          "name": "no-prompt",
+          "type": "boolean",
+          "char": "n",
+          "summary": "Don't prompt to confirm overwriting of the properties file if it already exists and overwrite it by default.",
+          "allowNo": false
+        }
+      },
+      "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",
+      "pluginAlias": "@provartesting/provardx-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "gets the value for the provided property as a key from properties.json loaded inside config.json\n<%= config.bin %> <%= command.id %> 'key'"
+      ],
+      "flags": {
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "allowNo": false
+        }
+      },
+      "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",
+      "pluginAlias": "@provartesting/provardx-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "loads the properties.json 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
+        },
+        "properties-file": {
+          "name": "properties-file",
+          "type": "option",
+          "char": "p",
+          "summary": "Path of the properties file to be loaded.",
+          "required": true,
+          "multiple": false
+        }
+      },
+      "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",
+      "pluginAlias": "@provartesting/provardx-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "sets the provided properties with resp. values as key=value in properties.json\n<%= config.bin %> <%= command.id %> 'key'='value'"
+      ],
+      "flags": {
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "allowNo": false
+        }
+      },
+      "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",
+      "pluginAlias": "@provartesting/provardx-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "Validate the loaded provardx-properties.json loaded under environment variables :\n<%= config.bin %> <%= command.id %>'"
+      ],
+      "flags": {
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "allowNo": false
+        }
+      },
+      "args": {}
+    }
+  }
+}

package/package.json

@@ -0,0 +1,214 @@
+{
+  "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.1",
+  "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"
+  },
+  "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",
+    "shx": "0.3.4",
+    "sinon": "10.0.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.1.6",
+    "wireit": "^0.14.0"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "files": [
+    "/lib",
+    "/messages",
+    "/oclif.manifest.json"
+  ],
+  "keywords": [
+    "force",
+    "salesforce",
+    "sfdx",
+    "salesforcedx",
+    "sfdx-plugin",
+    "sf-plugin",
+    "sf"
+  ],
+  "license": "BSD-3-Clause",
+  "main": "lib/index.js",
+  "oclif": {
+    "commands": "./lib/commands",
+    "bin": "sf",
+    "topicSeparator": " ",
+    "devPlugins": [
+      "@oclif/plugin-help"
+    ],
+    "topics": {
+      "sf": {
+        "description": "commands to automate salesforce",
+        "subtopics": {
+          "provar": {
+            "description": "commands to manipulate properties file & automate salesforce using provardx",
+            "subtopics": {
+              "config": {
+                "description": "commands to generate and manipulate provardx-properties file"
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "scripts": {
+    "build": "wireit",
+    "clean": "sf-clean",
+    "clean-all": "sf-clean all",
+    "clean:lib": "shx rm -rf lib && shx rm -rf coverage && shx rm -rf .nyc_output && shx rm -f oclif.manifest.json",
+    "compile": "wireit",
+    "docs": "sf-docs",
+    "format": "wireit",
+    "lint": "wireit",
+    "postinstall": "yarn husky install",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "prepack": "sf-prepack",
+    "test": "wireit",
+    "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 600000 --reporter mochawesome",
+    "test:only": "wireit",
+    "version": "oclif readme"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "wireit": {
+    "build": {
+      "dependencies": [
+        "compile",
+        "lint"
+      ]
+    },
+    "compile": {
+      "command": "tsc -p . --pretty --incremental",
+      "files": [
+        "src/**/*.ts",
+        "**/tsconfig.json",
+        "messages/**"
+      ],
+      "output": [
+        "lib/**",
+        "*.tsbuildinfo"
+      ],
+      "clean": "if-file-deleted"
+    },
+    "format": {
+      "command": "prettier --write \"+(src|test|schemas)/**/*.+(ts|js|json)|command-snapshot.json\"",
+      "files": [
+        "src/**/*.ts",
+        "test/**/*.ts",
+        "schemas/**/*.json",
+        "command-snapshot.json",
+        ".prettier*"
+      ],
+      "output": []
+    },
+    "lint": {
+      "command": "eslint src test --color --cache --cache-location .eslintcache",
+      "files": [
+        "src/**/*.ts",
+        "test/**/*.ts",
+        "messages/**",
+        "**/.eslint*",
+        "**/tsconfig.json"
+      ],
+      "output": []
+    },
+    "test:compile": {
+      "command": "tsc -p \"./test\" --pretty ",
+      "files": [
+        "test/**/*.ts"
+      ],
+      "output": []
+    },
+    "test": {
+      "dependencies": [
+        "test:compile",
+        "test:only",
+        "lint"
+      ]
+    },
+    "test:only": {
+      "command": "nyc mocha \"test/**/*.test.ts\"",
+      "env": {
+        "FORCE_COLOR": "2"
+      },
+      "files": [
+        "test/**/*.ts",
+        "src/**/*.ts",
+        "**/tsconfig.json",
+        ".mocha*",
+        "!*.nut.ts",
+        ".nycrc"
+      ],
+      "output": []
+    },
+    "test:command-reference": {
+      "command": "\"./bin/dev\" commandreference:generate --erroronwarnings",
+      "files": [
+        "src/**/*.ts",
+        "messages/**",
+        "package.json"
+      ],
+      "output": [
+        "tmp/root"
+      ]
+    },
+    "test:deprecation-policy": {
+      "command": "\"./bin/dev\" snapshot:compare",
+      "files": [
+        "src/**/*.ts"
+      ],
+      "output": [],
+      "dependencies": [
+        "compile"
+      ]
+    },
+    "test:json-schema": {
+      "command": "\"./bin/dev\" schema:compare",
+      "files": [
+        "src/**/*.ts",
+        "schemas"
+      ],
+      "output": []
+    }
+  },
+  "author": "Palak Bansal",
+  "directories": {
+    "lib": "lib",
+    "test": "test"
+  }
+}