Merge pull request #68 from salesforcecli/ew/add-alias-commands

Alias commands

Author: peternhale

.github/workflows/notify-slack-on-pr-open.yml

@@ -8,16 +8,16 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - name: Notify Slack on PR open
-      env: 
-        WEBHOOK_URL : ${{ secrets.CLI_TEAM_SLACK_WEBHOOK_URL }}
-        PULL_REQUEST_AUTHOR_ICON_URL : ${{ github.event.pull_request.user.avatar_url }}
-        PULL_REQUEST_AUTHOR_NAME : ${{ github.event.pull_request.user.login }}
-        PULL_REQUEST_AUTHOR_PROFILE_URL: ${{ github.event.pull_request.user.html_url }}
-        PULL_REQUEST_BASE_BRANCH_NAME : ${{ github.event.pull_request.base.ref }}
-        PULL_REQUEST_COMPARE_BRANCH_NAME : ${{ github.event.pull_request.head.ref }}
-        PULL_REQUEST_NUMBER : ${{ github.event.pull_request.number }}
-        PULL_REQUEST_REPO: ${{ github.event.pull_request.head.repo.name }}
-        PULL_REQUEST_TITLE : ${{ github.event.pull_request.title }}
-        PULL_REQUEST_URL : ${{ github.event.pull_request.html_url }}
-      uses: salesforcecli/github-workflows/.github/actions/prNotification@main
+      - name: Notify Slack on PR open
+        env:
+          WEBHOOK_URL: ${{ secrets.CLI_TEAM_SLACK_WEBHOOK_URL }}
+          PULL_REQUEST_AUTHOR_ICON_URL: ${{ github.event.pull_request.user.avatar_url }}
+          PULL_REQUEST_AUTHOR_NAME: ${{ github.event.pull_request.user.login }}
+          PULL_REQUEST_AUTHOR_PROFILE_URL: ${{ github.event.pull_request.user.html_url }}
+          PULL_REQUEST_BASE_BRANCH_NAME: ${{ github.event.pull_request.base.ref }}
+          PULL_REQUEST_COMPARE_BRANCH_NAME: ${{ github.event.pull_request.head.ref }}
+          PULL_REQUEST_NUMBER: ${{ github.event.pull_request.number }}
+          PULL_REQUEST_REPO: ${{ github.event.pull_request.head.repo.name }}
+          PULL_REQUEST_TITLE: ${{ github.event.pull_request.title }}
+          PULL_REQUEST_URL: ${{ github.event.pull_request.html_url }}
+        uses: salesforcecli/github-workflows/.github/actions/prNotification@main

command-snapshot.json

@@ -1,4 +1,22 @@
 [
+  {
+    "command": "alias:list",
+    "plugin": "@salesforce/plugin-settings",
+    "flags": ["json"],
+    "alias": []
+  },
+  {
+    "command": "alias:set",
+    "plugin": "@salesforce/plugin-settings",
+    "flags": ["json"],
+    "alias": []
+  },
+  {
+    "command": "alias:unset",
+    "plugin": "@salesforce/plugin-settings",
+    "flags": ["all", "json", "no-prompt"],
+    "alias": []
+  },
   {
     "command": "config:get",
     "plugin": "@salesforce/plugin-settings",

messages/alias.list.md

@@ -0,0 +1,13 @@
+# summary
+
+List all aliases currently set on your local computer.
+
+# description
+
+Aliases are global, which means that you can use all the listed aliases in any Salesforce DX project on your computer.
+
+# examples
+
+- List all the aliases you've set:
+
+  <%= config.bin %> <%= command.id %>

messages/alias.set.md

@@ -0,0 +1,37 @@
+# summary
+
+Set one or more aliases on your local computer.
+
+# description
+
+Aliases are user-defined short names that make it easier to use the CLI. For example, users often set an alias for a scratch org usernames because they're long and unintuitive.  Check the --help of a CLI command to determine where you can use an alias.
+
+You can associate an alias with only one value at a time. If you set an alias multiple times, the alias points to the most recent value. Aliases are global; after you set an alias, you can use it in any Salesforce DX project on your computer.
+
+Use quotes to specify an alias value that contains spaces. You typically use an equal sign to set your alias, although you don't need it if you're setting a single alias in a command.
+
+# examples
+
+- Set an alias for a scratch org username:
+
+  <%= config.bin %> <%= command.id %> my-scratch-org=[email protected]
+
+- Set multiple aliases with a single command:
+
+  <%= config.bin %> <%= command.id %> my-scratch-org=[email protected] my-other-scratch-org=[email protected]
+
+- Set an alias that contains spaces:
+
+  <%= config.bin %> <%= command.id %> my-alias='alias with spaces'
+
+- Set a single alias without using an equal sign:
+
+  <%= config.bin %> <%= command.id %> my-scratch-org [email protected]
+
+# error.ArgumentsRequired
+
+You must provide one or more aliases to set. Use the --help flag to see examples.
+
+# error.ValueRequired
+
+You must provide a value when setting an alias. Use `sf alias unset my-alias-name` to remove existing aliases.

messages/alias.unset.md

@@ -0,0 +1,41 @@
+# summary
+
+Unset one or more aliases that are currently set on your local computer.
+
+# description
+
+Aliases are global, so when you unset one it's no longer available in any Salesforce DX project.
+
+# flags.all.summary
+
+Unset all currently set aliases.
+
+# flags.no-prompt.summary
+
+Don't prompt the user for confirmation when unsetting all aliases.
+
+# examples
+
+- Unset an alias:
+
+  <%= config.bin %> <%= command.id %> my-alias
+
+- Unset multiple aliases with a single command:
+
+  <%= config.bin %> <%= command.id %> my-alias my-other-alias
+
+- Unset all aliases:
+
+  <%= config.bin %> <%= command.id %> --all [--no-prompt]
+
+# error.NameRequired
+
+You must provide an alias name when unsetting an alias.
+
+# warning.NoAliasesSet
+
+The `--all` flag was passed, but no aliases are currently set. Exiting.
+
+# prompt.RemoveAllAliases
+
+Are you sure you want to unset all aliases?

messages/get.md renamed to messages/config.get.md

@@ -4,7 +4,7 @@ List the configuration variables that you've previously set.
 
 # description
 
-Global configuration variables apply to any directory and are always displayed. If you run this command from a project directory, local configuration variables are also displayed.
+Global configuration variables apply to any Salesforce DX project and are always displayed. If you run this command from a project directory, local configuration variables are also displayed.
 
 # examples
 

messages/list.md renamed to messages/config.list.md

@@ -6,7 +6,7 @@ Set one or more configuration variables, such as your default org.
 
 Use configuration variables to set CLI defaults, such as your default org or the API version you want the CLI to use. For example, if you set the "target-org" configuration variable, you don't need to specify it as a "sf deploy metadata" flag if you're deploying to your default org.
 
-Local configuration variables apply only to your current project. Global variables, specified with the --global flag, apply in any directory.
+Local configuration variables apply only to your current project. Global variables, specified with the --global flag, apply in any Salesforce DX project.
 
 The resolution order if you've set a flag value in multiple ways is as follows:
 
@@ -30,18 +30,18 @@ Run "sf config list" to see the configuration variables you've already set and t
 
   <%= config.bin %> <%= command.id %> --global target-org=my-scratch-org
 
-# flags.global.summary
-
-Set the configuration variables globally, so they can be used from any directory.
-
-# error.InvalidArgumentFormat
+- Set a single configuration variable without using an equal sign; this syntax doesn't work when setting multiple configuration variables:
 
-Set configuration variables with this format: key=value or key="value with spaces". Use the --help flag to view the available configuration variables.
+  <%= config.bin %> <%= command.id %> target-org [email protected]
 
-# error.DuplicateArgument
+# flags.global.summary
 
-Found duplicate argument %s. You can specify a configuration variable only one time in a single command execution. Remove the duplicate and try again.
+Set the configuration variables globally, so they can be used from any Salesforce DX project.
 
 # error.ArgumentsRequired
 
 You must provide one or more configuration variables to set. Use the --help flag to view the available configuration variables.
+
+# error.ValueRequired
+
+You must provide a value when setting a config. Use `sf config unset the-config-name` to unset existing configs.

messages/set.md renamed to messages/config.set.md

@@ -4,7 +4,7 @@ Unset local or global configuration variables.
 
 # description
 
-Local configuration variables apply only to your current project. Global configuration variables apply in any directory.
+Local configuration variables apply only to your current project. Global configuration variables apply in any Salesforce DX project.
 
 # examples
 
@@ -18,7 +18,7 @@ Local configuration variables apply only to your current project. Global configu
 
 # flags.global.summary
 
-Unset the configuration variables globally, so they can no longer be used from any directory.
+Unset the configuration variables globally, so they can no longer be used from any Salesforce DX project.
 
 # error.NoConfigKeysFound
 

messages/unset.md renamed to messages/config.unset.md

@@ -5,26 +5,26 @@
   "author": "Salesforce",
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "dependencies": {
-    "@oclif/core": "^1.16.5",
-    "@salesforce/core": "^3.30.8",
+    "@oclif/core": "^1.19.0",
+    "@salesforce/core": "^3.31.12",
     "@salesforce/sf-plugins-core": "^1.15.2",
     "tslib": "^2"
   },
   "devDependencies": {
-    "@oclif/plugin-command-snapshot": "^3.2.4",
-    "@oclif/test": "^2.2.3",
+    "@oclif/plugin-command-snapshot": "^3.2.5",
+    "@oclif/test": "^2.2.4",
     "@salesforce/cli-plugins-testkit": "^3.2.3",
     "@salesforce/dev-config": "^3.1.0",
     "@salesforce/dev-scripts": "^3.1.0",
-    "@salesforce/kit": "^1.6.1",
+    "@salesforce/kit": "^1.7.0",
     "@salesforce/plugin-command-reference": "^2.2.8",
     "@salesforce/prettier-config": "^0.0.2",
     "@salesforce/ts-sinon": "^1.4.0",
-    "@salesforce/ts-types": "^1.5.20",
+    "@salesforce/ts-types": "^1.5.21",
     "@types/fs-extra": "^9.0.13",
     "@types/shelljs": "^0.8.11",
-    "@typescript-eslint/eslint-plugin": "^5.40.0",
-    "@typescript-eslint/parser": "^5.40.0",
+    "@typescript-eslint/eslint-plugin": "^5.40.1",
+    "@typescript-eslint/parser": "^5.40.1",
     "chai": "^4.3.6",
     "eslint": "^8.25.0",
     "eslint-config-prettier": "^8.5.0",
@@ -33,7 +33,7 @@
     "eslint-config-salesforce-typescript": "^1.1.1",
     "eslint-plugin-header": "^3.1.1",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jsdoc": "^39.3.6",
+    "eslint-plugin-jsdoc": "^39.3.13",
     "eslint-plugin-sf-plugin": "^0.3.0",
     "fs-extra": "^10.1.0",
     "husky": "^7.0.4",
@@ -87,6 +87,9 @@
     "topics": {
       "config": {
         "description": "Commands to configure Salesforce CLI."
+      },
+      "alias": {
+        "description": "Use the alias commands to manage your aliases."
       }
     }
   },
@@ -110,10 +113,10 @@
     "test:command-reference": "./bin/dev commandreference:generate --erroronwarnings",
     "test:deprecation-policy": "./bin/dev snapshot:compare",
     "test:json-schema": "./bin/dev schema:compare",
-    "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel",
+    "test:nuts": "nyc mocha \"test/**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel",
     "version": "oclif readme"
   },
   "publishConfig": {
     "access": "public"
   }
-}
+}