@salesforce/cli 2.0.0-beta.0 → 2.0.0-qa.0

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.0.0-beta.0",
+  "version": "2.0.0-qa.0",
   "commands": {
     "cmdt:generate:field": {
       "id": "cmdt:generate:field",
@@ -848,14 +848,14 @@
     "dev:audit:messages": {
       "id": "dev:audit:messages",
       "summary": "Audit messages in a plugin's messages directory to locate unused messages and missing messages that have references in source code.",
-      "description": "Audit messages in a plugin's messages directory to locate unused messages and missing messages that have references in source code.",
       "strict": true,
       "pluginName": "@salesforce/plugin-dev",
       "pluginAlias": "@salesforce/plugin-dev",
       "pluginType": "jit",
       "aliases": [],
       "examples": [
-        "sf dev audit messages\nsf dev audit messages --json\nsf dev audit messages --messages-dir ./messages --source-dir ./src"
+        "Audit messages using default directories:\n<%= config.bin %> <%= command.id %>",
+        "Audit messages in the \"messages\" directory in the current working directory; the plugin's source directory is in \"src\":\n<%= config.bin %> <%= command.id %> --messages-dir ./messages --source-dir ./src"
       ],
       "flags": {
         "json": {
@@ -869,8 +869,7 @@
           "name": "project-dir",
           "type": "option",
           "char": "p",
-          "summary": "Location project where messages are to be audited.",
-          "description": "The project directory.",
+          "summary": "Location of the project where messages are to be audited.",
           "multiple": false,
           "default": ".",
           "aliases": [
@@ -881,8 +880,8 @@
           "name": "messages-dir",
           "type": "option",
           "char": "m",
-          "summary": "Location of the message bundle directory.",
-          "description": "The directory that holds the message bundle files. The default is the messages directory in the current working directory.",
+          "summary": "Directory that contains the plugin's message files.",
+          "description": "The default is the \"messages\" directory in the current working directory.",
           "multiple": false,
           "default": "messages",
           "aliases": [
@@ -893,8 +892,8 @@
           "name": "source-dir",
           "type": "option",
           "char": "s",
-          "summary": "Location of the plugin's source code.",
-          "description": "The directory that holds the plugin's source code. The default is the src directory in the current working directory.",
+          "summary": "Directory that contains the plugin's source code.",
+          "description": "The default is the \"src\" directory in the current working directory.",
           "multiple": false,
           "default": "src",
           "aliases": [
@@ -906,15 +905,15 @@
     },
     "dev:configure:repo": {
       "id": "dev:configure:repo",
-      "summary": "Configure github repo for Actions pipeline.",
-      "description": "Sets up labels and exempts the CLI bot for branch protection and PR rules",
+      "summary": "Configure a GitHub repo for the GitHub Actions pipeline.",
+      "description": "Sets up labels and exempts the CLI bot for branch protection and PR rules.",
       "strict": true,
       "pluginName": "@salesforce/plugin-dev",
       "pluginAlias": "@salesforce/plugin-dev",
       "pluginType": "jit",
       "aliases": [],
       "examples": [
-        "<%= config.bin %> <%= command.id %> -r salesforcecli/testPackageRelease"
+        "Configure the repo \"testPackageRelease\", with owner \"salesforcecli\", for GitHub Actions.\n<%= config.bin %> <%= command.id %> --repository salesforcecli/testPackageRelease"
       ],
       "flags": {
         "json": {
@@ -928,7 +927,7 @@
           "name": "repository",
           "type": "option",
           "char": "r",
-          "summary": "The github owner/repo",
+          "summary": "GitHub owner/repo for which you want to configure GitHub Actions.",
           "required": true,
           "multiple": false
         },
@@ -936,7 +935,7 @@
           "name": "dry-run",
           "type": "boolean",
           "char": "d",
-          "summary": "Make no changes",
+          "summary": "Make no changes.",
           "allowNo": false,
           "aliases": [
             "dryrun"
@@ -946,7 +945,7 @@
           "name": "bot",
           "type": "option",
           "char": "b",
-          "summary": "The github login/username for the bot.",
+          "summary": "GitHub login/username for the bot.",
           "multiple": false,
           "default": "SF-CLI-BOT"
         }
@@ -955,15 +954,16 @@
     },
     "dev:configure:secrets": {
       "id": "dev:configure:secrets",
-      "summary": "Ensures a repo has correct access to secrets based on its workflows",
-      "description": "Inspects a repo's yaml files and verifies that secrets required are available for the repo (either set at the repo level or shared via organization-level secrets).\n\nThis command requires scope:admin permissions to inspect the org secrets and admin access to the repo to inspect the repo secrets",
+      "summary": "Ensures a GitHub repo has correct access to secrets based on its workflows.",
+      "description": "Inspects a repo's yaml files and verifies that secrets required are available for the repo (either set at the repo level or shared via organization-level secrets).\n\nThis command requires scope:admin permissions to inspect the org secrets and admin access to the repo to inspect the repo secrets.",
       "strict": true,
       "pluginName": "@salesforce/plugin-dev",
       "pluginAlias": "@salesforce/plugin-dev",
       "pluginType": "jit",
       "aliases": [],
       "examples": [
-        "<%= config.bin %> <%= command.id %> -r salesforcecli/testPackageRelease"
+        "Ensure secrets access for the repo \"testPackageRelease\", with owner \"salesforcecli\":",
+        "<%= config.bin %> <%= command.id %> --repository salesforcecli/testPackageRelease"
       ],
       "flags": {
         "json": {
@@ -977,7 +977,7 @@
           "name": "repository",
           "type": "option",
           "char": "r",
-          "summary": "The github owner/repo",
+          "summary": "Github owner/repo.",
           "required": true,
           "multiple": false
         },
@@ -985,7 +985,7 @@
           "name": "dry-run",
           "type": "boolean",
           "char": "d",
-          "summary": "Make no changes",
+          "summary": "Make no changes.",
           "allowNo": false,
           "aliases": [
             "dryrun"
@@ -996,15 +996,16 @@
     },
     "dev:convert:messages": {
       "id": "dev:convert:messages",
-      "summary": "Convert a .json messages file",
+      "summary": "Convert a .json messages file into Markdown.",
       "strict": true,
       "pluginName": "@salesforce/plugin-dev",
       "pluginAlias": "@salesforce/plugin-dev",
       "pluginType": "jit",
       "aliases": [],
       "examples": [
-        "<%= config.bin %> <%= command.id %> --filename something.json",
-        "<%= config.bin %> <%= command.id %> --project-dir ./path/to/plugin --filename something.json"
+        "Convert the my-command.json message file into my-command.md with the standard messages headers:\n<%= config.bin %> <%= command.id %> --filename my-command.json",
+        "Similar to previous example, but specify the plugin project directory:",
+        "<%= config.bin %> <%= command.id %> --project-dir ./path/to/plugin --filename my-command.json"
       ],
       "flags": {
         "json": {
@@ -1018,8 +1019,7 @@
           "name": "project-dir",
           "type": "option",
           "char": "p",
-          "summary": "Location of the project whose messages are to be audited.",
-          "description": "Location of the project whose messages are to be audited.",
+          "summary": "Location of the project whose messages are to be converted.",
           "multiple": false,
           "default": ".",
           "aliases": [
@@ -1030,7 +1030,7 @@
           "name": "file-name",
           "type": "option",
           "char": "f",
-          "summary": "Filename to convert",
+          "summary": "Filename to convert.",
           "required": true,
           "multiple": true,
           "aliases": [

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/cli",
   "description": "The Salesforce CLI",
-  "version": "2.0.0-beta.0",
+  "version": "2.0.0-qa.0",
   "author": "Salesforce",
   "bin": {
     "sf": "./bin/run",
@@ -17,7 +17,8 @@
     "/bin",
     "/dist/**/*.js",
     "/oclif.manifest.json",
-    "/npm-shrinkwrap.json"
+    "/npm-shrinkwrap.json",
+    "/scripts/preinstall.js"
   ],
   "keywords": [
     "oclif",
@@ -27,16 +28,35 @@
   "license": "BSD-3-Clause",
   "main": "dist/index.js",
   "oclif": {
+    "additionalVersionFlags": [
+      "-v"
+    ],
+    "additionalHelpFlags": [
+      "-h"
+    ],
     "bin": "sf",
     "binAliases": [
       "sfdx"
     ],
-    "scope": "salesforce",
+    "commands": "./dist/commands",
     "dirname": "sf",
-    "topicSeparator": " ",
     "flexibleTaxonomy": true,
-    "commands": "./dist/commands",
     "helpClass": "./dist/help/sfHelp.js",
+    "hooks": {
+      "preupdate": "./dist/hooks/preupdate",
+      "command_incomplete": "./dist/hooks/incomplete",
+      "plugins:preinstall": "./dist/hooks/pluginsPreinstall.js"
+    },
+    "info": {
+      "releasenotes": {
+        "distTagUrl": "https://registry.npmjs.org/-/package/@salesforce/cli/dist-tags",
+        "releaseNotesPath": "https://github.com/forcedotcom/cli/tree/main/releasenotes/sf",
+        "releaseNotesFilename": "README.md"
+      }
+    },
+    "nsisCustomization": "scripts/nsis.nsi",
+    "scope": "salesforce",
+    "topicSeparator": " ",
     "plugins": [
       "@oclif/plugin-autocomplete",
       "@oclif/plugin-commands",
@@ -66,13 +86,13 @@
       "@salesforce/plugin-user"
     ],
     "jitPlugins": {
-      "@salesforce/plugin-custom-metadata": "2.1.15",
-      "@salesforce/plugin-community": "2.2.10",
-      "@salesforce/plugin-dev": "0.7.0",
+      "@salesforce/plugin-custom-metadata": "2.1.19",
+      "@salesforce/plugin-community": "2.2.11",
+      "@salesforce/plugin-dev": "0.7.4",
       "@salesforce/plugin-env": "2.1.8",
-      "@salesforce/plugin-functions": "1.21.7",
-      "@salesforce/plugin-packaging": "1.16.7",
-      "@salesforce/plugin-signups": "1.4.12",
+      "@salesforce/plugin-functions": "1.21.8",
+      "@salesforce/plugin-packaging": "1.16.10",
+      "@salesforce/plugin-signups": "1.4.14",
       "@salesforce/sfdx-plugin-lwc-test": "1.0.2",
       "@salesforce/sfdx-scanner": "3.11.0"
     },
@@ -80,11 +100,6 @@
       "@oclif/plugin-command-snapshot",
       "@salesforce/plugin-release-management"
     ],
-    "hooks": {
-      "preupdate": "./dist/hooks/preupdate",
-      "command_incomplete": "./dist/hooks/incomplete",
-      "plugins:preinstall": "./dist/hooks/pluginsPreinstall.js"
-    },
     "update": {
       "s3": {
         "bucket": "dfc-data-production",
@@ -94,57 +109,44 @@
         "host": "https://developer.salesforce.com"
       }
     },
-    "info": {
-      "releasenotes": {
-        "distTagUrl": "https://registry.npmjs.org/-/package/@salesforce/cli/dist-tags",
-        "releaseNotesPath": "https://github.com/forcedotcom/cli/tree/main/releasenotes/sf",
-        "releaseNotesFilename": "README.md"
-      }
-    },
     "macos": {
       "identifier": "com.salesforce.cli"
     },
     "windows": {
       "name": "Salesforce CLI",
       "keypath": "/tmp/windows-signing.pfx"
-    },
-    "additionalVersionFlags": [
-      "-v"
-    ],
-    "additionalHelpFlags": [
-      "-h"
-    ]
+    }
   },
   "dependencies": {
-    "@oclif/core": "2.8.2",
+    "@oclif/core": "^2.8.4",
     "@oclif/plugin-autocomplete": "2.1.9",
     "@oclif/plugin-commands": "2.2.14",
     "@oclif/plugin-help": "5.2.9",
     "@oclif/plugin-not-found": "2.3.23",
-    "@oclif/plugin-plugins": "2.4.6",
-    "@oclif/plugin-search": "0.0.16",
-    "@oclif/plugin-update": "3.1.12",
+    "@oclif/plugin-plugins": "2.4.7",
+    "@oclif/plugin-search": "0.0.17",
+    "@oclif/plugin-update": "3.1.13",
     "@oclif/plugin-version": "1.3.3",
-    "@oclif/plugin-warn-if-update-available": "2.0.35",
+    "@oclif/plugin-warn-if-update-available": "2.0.36",
     "@oclif/plugin-which": "2.2.19",
-    "@salesforce/core": "3.34.7",
-    "@salesforce/plugin-apex": "2.2.13",
-    "@salesforce/plugin-auth": "2.7.12",
-    "@salesforce/plugin-data": "2.3.10",
-    "@salesforce/plugin-deploy-retrieve": "1.8.16",
-    "@salesforce/plugin-info": "2.6.8",
+    "@salesforce/core": "3.36.0",
+    "@salesforce/plugin-apex": "2.2.15",
+    "@salesforce/plugin-auth": "2.7.14",
+    "@salesforce/plugin-data": "2.3.14",
+    "@salesforce/plugin-deploy-retrieve": "1.8.18",
+    "@salesforce/plugin-info": "2.6.10",
     "@salesforce/plugin-limits": "2.3.13",
-    "@salesforce/plugin-login": "1.2.5",
-    "@salesforce/plugin-org": "2.7.1",
-    "@salesforce/plugin-schema": "2.3.8",
-    "@salesforce/plugin-settings": "1.4.4",
-    "@salesforce/plugin-sobject": "0.1.17",
-    "@salesforce/plugin-source": "2.10.4",
-    "@salesforce/plugin-telemetry": "2.1.4",
-    "@salesforce/plugin-templates": "55.4.10",
-    "@salesforce/plugin-trust": "2.4.10",
-    "@salesforce/plugin-user": "2.3.8",
-    "@salesforce/sf-plugins-core": "2.2.9",
+    "@salesforce/plugin-login": "1.2.8",
+    "@salesforce/plugin-org": "2.7.3",
+    "@salesforce/plugin-schema": "2.3.10",
+    "@salesforce/plugin-settings": "1.4.6",
+    "@salesforce/plugin-sobject": "0.1.18",
+    "@salesforce/plugin-source": "2.10.7",
+    "@salesforce/plugin-telemetry": "2.2.0",
+    "@salesforce/plugin-templates": "55.4.13",
+    "@salesforce/plugin-trust": "2.4.12",
+    "@salesforce/plugin-user": "2.3.10",
+    "@salesforce/sf-plugins-core": "2.4.0",
     "debug": "^4.3.4",
     "semver": "^7.3.8",
     "tslib": "^2.4.1"
@@ -202,6 +204,7 @@
     "pack:verify": "sf-release cli:tarballs:verify --cli sf --windows-username-buffer 34",
     "pack:win": "oclif pack:win",
     "postpack": "rm -f oclif.manifest.json npm-shrinkwrap.json",
+    "preinstall": "node ./scripts/preinstall.js",
     "prepack": "sf-prepack",
     "prepare": "sf-install && yarn compile && yarn lint",
     "prepublishOnly": "npm shrinkwrap",
@@ -225,15 +228,15 @@
     "@oclif/plugin-command-snapshot": "^3.3.0",
     "@salesforce/dev-config": "^3.1.0",
     "@salesforce/dev-scripts": "^3.1.1",
-    "@salesforce/plugin-release-management": "^3.15.2",
+    "@salesforce/plugin-release-management": "^3.16.11",
     "@salesforce/prettier-config": "^0.0.2",
     "@salesforce/ts-sinon": "^1.4.6",
     "@types/debug": "^4.1.7",
-    "@typescript-eslint/eslint-plugin": "^5.58.0",
-    "@typescript-eslint/parser": "^5.58.0",
-    "aws-sdk": "^2.1359.0",
+    "@typescript-eslint/eslint-plugin": "^5.59.1",
+    "@typescript-eslint/parser": "^5.59.1",
+    "aws-sdk": "^2.1366.0",
     "chai": "^4.3.7",
-    "eslint": "^8.38.0",
+    "eslint": "^8.39.0",
     "eslint-config-oclif": "^3.1",
     "eslint-config-oclif-typescript": "^0.2.0",
     "eslint-config-prettier": "^8.7.0",
@@ -247,8 +250,8 @@
     "husky": "^7.0.4",
     "mocha": "^9.2.2",
     "nyc": "^15.1.0",
-    "oclif": "^3.8.1",
-    "prettier": "^2.8.5",
+    "oclif": "3.9.0-qa.2",
+    "prettier": "^2.8.8",
     "pretty-quick": "^3.1.3",
     "sinon": "^11.1.2",
     "ts-node": "^10.9.1",

package/scripts/preinstall.js

@@ -0,0 +1,17 @@
+const { execSync } = require('child_process');
+
+(() => {
+  const testCliNotVersion = (cli, version) => {
+    try {
+      return execSync(`${cli} --version`).toString('utf-8').includes(version);
+    } catch (e) {
+      // if cli isn't installed it'll throw, but that's ok for us
+      return false;
+    }
+  };
+  // test if sf v1 or sfdx is installed
+  if (testCliNotVersion('sfdx', 'sfdx-cli/7.')) {
+    // TODO: add a link to the docs
+    throw Error('Please uninstall sfdx');
+  }
+})();