@salesforce/plugin-settings 1.4.32 → 1.4.34

package/README.md

@@ -107,7 +107,7 @@ EXAMPLES
     $ sf alias list
 ```
 
-_See code: [src/commands/alias/list.ts](https://github.com/salesforcecli/plugin-settings/blob/1.4.32/src/commands/alias/list.ts)_
+_See code: [src/commands/alias/list.ts](https://github.com/salesforcecli/plugin-settings/blob/1.4.34/src/commands/alias/list.ts)_
 
 ## `sf alias set`
 
@@ -155,7 +155,7 @@ EXAMPLES
     $ sf alias set my-scratch-org test-ss0xut7txzxf@example.com
 ```
 
-_See code: [src/commands/alias/set.ts](https://github.com/salesforcecli/plugin-settings/blob/1.4.32/src/commands/alias/set.ts)_
+_See code: [src/commands/alias/set.ts](https://github.com/salesforcecli/plugin-settings/blob/1.4.34/src/commands/alias/set.ts)_
 
 ## `sf alias unset`
 
@@ -194,7 +194,7 @@ EXAMPLES
     $ sf alias unset --all [--no-prompt]
 ```
 
-_See code: [src/commands/alias/unset.ts](https://github.com/salesforcecli/plugin-settings/blob/1.4.32/src/commands/alias/unset.ts)_
+_See code: [src/commands/alias/unset.ts](https://github.com/salesforcecli/plugin-settings/blob/1.4.34/src/commands/alias/unset.ts)_
 
 ## `sf config get`
 
@@ -213,9 +213,10 @@ GLOBAL FLAGS
 DESCRIPTION
   Get the value of a configuration variable.
 
-  Run "sf config list" to see all the configuration variables you've set. Global configuration variable are always
-  displayed; local ones are displayed if you run the command in a project directory. Run "sf config set" to set a
-  configuration variable.
+  Run "sf config list" to see the configuration variables you've already set and their level (local or global).
+
+  Run "sf config set" to set a configuration variable. For the full list of available configuration variables, see
+  https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_dev_cli_config_values.htm.
 
 ALIASES
   $ sf force config get
@@ -230,7 +231,7 @@ EXAMPLES
     $ sf config get target-org api-version --verbose
 ```
 
-_See code: [src/commands/config/get.ts](https://github.com/salesforcecli/plugin-settings/blob/1.4.32/src/commands/config/get.ts)_
+_See code: [src/commands/config/get.ts](https://github.com/salesforcecli/plugin-settings/blob/1.4.34/src/commands/config/get.ts)_
 
 ## `sf config list`
 
@@ -246,19 +247,30 @@ GLOBAL FLAGS
 DESCRIPTION
   List the configuration variables that you've previously set.
 
-  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.
+  A config variable can be global or local, depending on whether you used the --global flag when you set it. Local
+  config variables apply only to the current project and override global config variables, which apply to all projects.
+  You can set all config variables as environment variables. Environment variables override their equivalent local and
+  global config variables.
+
+  The output of this command takes into account your current context. For example, let's say you run this command from a
+  Salesforce DX project in which you've locally set the "target-org" config variable. The command displays the local
+  value, even if you've also set "target-org" globally. If you haven't set the config variable locally, then the global
+  value is displayed, if set. If you set the SF_TARGET_ORG environment variable, it's displayed as such and overrides
+  any locally or globally set "target-org" config variable.
+
+  For the full list of available configuration variables, see
+  https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_dev_cli_config_values.htm.
 
 ALIASES
   $ sf force config list
 
 EXAMPLES
-  List both global configuration variables and those local to your project:
+  List the global and local configuration variables that apply to your current context:
 
     $ sf config list
 ```
 
-_See code: [src/commands/config/list.ts](https://github.com/salesforcecli/plugin-settings/blob/1.4.32/src/commands/config/list.ts)_
+_See code: [src/commands/config/list.ts](https://github.com/salesforcecli/plugin-settings/blob/1.4.34/src/commands/config/list.ts)_
 
 ## `sf config set`
 
@@ -292,29 +304,30 @@ DESCRIPTION
 
   Run "sf config list" to see the configuration variables you've already set and their level (local or global).
 
+  If you're setting a single config variable, you don't need to use an equal sign between the variable and value. But
+  you must use the equal sign if setting multiple config variables.
+
+  For the full list of available configuration variables, see
+  https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_dev_cli_config_values.htm.
+
 ALIASES
   $ sf force config set
 
 EXAMPLES
   Set the local target-org configuration variable to an org username:
 
-    $ sf config set target-org=me@my.org
+    $ sf config set target-org me@my.org
 
   Set the local target-org configuration variable to an alias:
 
-    $ sf config set target-org=my-scratch-org
-
-  Set the global target-org configuration variable:
+    $ sf config set target-org my-scratch-org
 
-    $ sf config set --global target-org=my-scratch-org
+  Set the global target-org and target-dev-hub configuration variables using aliases:
 
-  Set a single configuration variable without using an equal sign; this syntax doesn't work when setting multiple
-  configuration variables:
-
-    $ sf config set target-org me@my.com
+    $ sf config set --global target-org=my-scratch-org target-dev-hub=my-dev-hub
 ```
 
-_See code: [src/commands/config/set.ts](https://github.com/salesforcecli/plugin-settings/blob/1.4.32/src/commands/config/set.ts)_
+_See code: [src/commands/config/set.ts](https://github.com/salesforcecli/plugin-settings/blob/1.4.34/src/commands/config/set.ts)_
 
 ## `sf config unset`
 
@@ -325,8 +338,7 @@ USAGE
   $ sf config unset [--json] [-g]
 
 FLAGS
-  -g, --global  Unset the configuration variables globally, so they can no longer be used from any Salesforce DX
-                project.
+  -g, --global  Unset the configuration variables globally.
 
 GLOBAL FLAGS
   --json  Format output as json.
@@ -337,6 +349,9 @@ DESCRIPTION
   Local configuration variables apply only to your current project. Global configuration variables apply in any
   Salesforce DX project.
 
+  For the full list of available configuration variables, see
+  https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_dev_cli_config_values.htm.
+
 ALIASES
   $ sf force config unset
 
@@ -350,6 +365,6 @@ EXAMPLES
     $ sf config unset target-org api-version --global
 ```
 
-_See code: [src/commands/config/unset.ts](https://github.com/salesforcecli/plugin-settings/blob/1.4.32/src/commands/config/unset.ts)_
+_See code: [src/commands/config/unset.ts](https://github.com/salesforcecli/plugin-settings/blob/1.4.34/src/commands/config/unset.ts)_
 
 <!-- commandsstop -->

package/messages/config.get.md

@@ -4,7 +4,9 @@ Get the value of a configuration variable.
 
 # description
 
-Run "sf config list" to see all the configuration variables you've set. Global configuration variable are always displayed; local ones are displayed if you run the command in a project directory. Run "sf config set" to set a configuration variable.
+Run "sf config list" to see the configuration variables you've already set and their level (local or global).
+
+Run "sf config set" to set a configuration variable. For the full list of available configuration variables, see https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_dev_cli_config_values.htm.
 
 # examples
 

package/messages/config.list.md

@@ -4,10 +4,14 @@ List the configuration variables that you've previously set.
 
 # description
 
-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.
+A config variable can be global or local, depending on whether you used the --global flag when you set it. Local config variables apply only to the current project and override global config variables, which apply to all projects.  You can set all config variables as environment variables. Environment variables override their equivalent local and global config variables.
+
+The output of this command takes into account your current context. For example, let's say you run this command from a Salesforce DX project in which you've locally set the "target-org" config variable. The command displays the local value, even if you've also set "target-org" globally. If you haven't set the config variable locally, then the global value is displayed, if set. If you set the SF_TARGET_ORG environment variable, it's displayed as such and overrides any locally or globally set "target-org" config variable. 
+
+For the full list of available configuration variables, see https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_dev_cli_config_values.htm.
 
 # examples
 
-- List both global configuration variables and those local to your project:
+- List the global and local configuration variables that apply to your current context:
 
   $ <%= config.bin %> <%= command.id %>

package/messages/config.set.md

@@ -16,23 +16,23 @@ The resolution order if you've set a flag value in multiple ways is as follows:
 
 Run "sf config list" to see the configuration variables you've already set and their level (local or global).
 
+If you're setting a single config variable, you don't need to use an equal sign between the variable and value. But you must use the equal sign if setting multiple config variables.
+
+For the full list of available configuration variables, see https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_dev_cli_config_values.htm.
+
 # examples
 
 - Set the local target-org configuration variable to an org username:
 
-  <%= config.bin %> <%= command.id %> target-org=me@my.org
+  <%= config.bin %> <%= command.id %> target-org me@my.org
 
 - Set the local target-org configuration variable to an alias:
 
-  <%= config.bin %> <%= command.id %> target-org=my-scratch-org
-
-- Set the global target-org configuration variable:
-
-  <%= config.bin %> <%= command.id %> --global target-org=my-scratch-org
+  <%= config.bin %> <%= command.id %> target-org my-scratch-org
 
-- Set a single configuration variable without using an equal sign; this syntax doesn't work when setting multiple configuration variables:
+- Set the global target-org and target-dev-hub configuration variables using aliases:
 
-  <%= config.bin %> <%= command.id %> target-org me@my.com
+  <%= config.bin %> <%= command.id %> --global target-org=my-scratch-org target-dev-hub=my-dev-hub
 
 # flags.global.summary
 

package/messages/config.unset.md

@@ -6,6 +6,8 @@ Unset local or global configuration variables.
 
 Local configuration variables apply only to your current project. Global configuration variables apply in any Salesforce DX project.
 
+For the full list of available configuration variables, see https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_dev_cli_config_values.htm.
+
 # examples
 
 - Unset the local "target-org" configuration variable:
@@ -18,7 +20,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 Salesforce DX project.
+Unset the configuration variables globally.
 
 # error.NoConfigKeysFound
 

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.4.32",
+  "version": "1.4.34",
   "commands": {
     "alias:list": {
       "id": "alias:list",
@@ -136,7 +136,7 @@
     "config:get": {
       "id": "config:get",
       "summary": "Get the value of a configuration variable.",
-      "description": "Run \"sf config list\" to see all the configuration variables you've set. Global configuration variable are always displayed; local ones are displayed if you run the command in a project directory. Run \"sf config set\" to set a configuration variable.",
+      "description": "Run \"sf config list\" to see the configuration variables you've already set and their level (local or global).\n\nRun \"sf config set\" to set a configuration variable. For the full list of available configuration variables, see https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_dev_cli_config_values.htm.",
       "strict": false,
       "pluginName": "@salesforce/plugin-settings",
       "pluginAlias": "@salesforce/plugin-settings",
@@ -218,7 +218,7 @@
     "config:list": {
       "id": "config:list",
       "summary": "List the configuration variables that you've previously set.",
-      "description": "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.",
+      "description": "A config variable can be global or local, depending on whether you used the --global flag when you set it. Local config variables apply only to the current project and override global config variables, which apply to all projects.  You can set all config variables as environment variables. Environment variables override their equivalent local and global config variables.\n\nThe output of this command takes into account your current context. For example, let's say you run this command from a Salesforce DX project in which you've locally set the \"target-org\" config variable. The command displays the local value, even if you've also set \"target-org\" globally. If you haven't set the config variable locally, then the global value is displayed, if set. If you set the SF_TARGET_ORG environment variable, it's displayed as such and overrides any locally or globally set \"target-org\" config variable. \n\nFor the full list of available configuration variables, see https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_dev_cli_config_values.htm.",
       "strict": true,
       "pluginName": "@salesforce/plugin-settings",
       "pluginAlias": "@salesforce/plugin-settings",
@@ -227,7 +227,7 @@
         "force:config:list"
       ],
       "examples": [
-        "List both global configuration variables and those local to your project:\n$ <%= config.bin %> <%= command.id %>"
+        "List the global and local configuration variables that apply to your current context:\n$ <%= config.bin %> <%= command.id %>"
       ],
       "deprecateAliases": true,
       "flags": {
@@ -255,7 +255,7 @@
     "config:set": {
       "id": "config:set",
       "summary": "Set one or more configuration variables, such as your default org.",
-      "description": "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.\n\nLocal configuration variables apply only to your current project. Global variables, specified with the --global flag, apply in any Salesforce DX project.\n\nThe resolution order if you've set a flag value in multiple ways is as follows:\n\n    1. Flag value specified at the command line.\n    2. Local (project-level) configuration variable.\n    3. Global configuration variable.\n\nRun \"sf config list\" to see the configuration variables you've already set and their level (local or global).",
+      "description": "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.\n\nLocal configuration variables apply only to your current project. Global variables, specified with the --global flag, apply in any Salesforce DX project.\n\nThe resolution order if you've set a flag value in multiple ways is as follows:\n\n    1. Flag value specified at the command line.\n    2. Local (project-level) configuration variable.\n    3. Global configuration variable.\n\nRun \"sf config list\" to see the configuration variables you've already set and their level (local or global).\n\nIf you're setting a single config variable, you don't need to use an equal sign between the variable and value. But you must use the equal sign if setting multiple config variables.\n\nFor the full list of available configuration variables, see https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_dev_cli_config_values.htm.",
       "strict": false,
       "pluginName": "@salesforce/plugin-settings",
       "pluginAlias": "@salesforce/plugin-settings",
@@ -264,10 +264,9 @@
         "force:config:set"
       ],
       "examples": [
-        "Set the local target-org configuration variable to an org username:\n<%= config.bin %> <%= command.id %> target-org=me@my.org",
-        "Set the local target-org configuration variable to an alias:\n<%= config.bin %> <%= command.id %> target-org=my-scratch-org",
-        "Set the global target-org configuration variable:\n<%= config.bin %> <%= command.id %> --global target-org=my-scratch-org",
-        "Set a single configuration variable without using an equal sign; this syntax doesn't work when setting multiple configuration variables:\n<%= config.bin %> <%= command.id %> target-org me@my.com"
+        "Set the local target-org configuration variable to an org username:\n<%= config.bin %> <%= command.id %> target-org me@my.org",
+        "Set the local target-org configuration variable to an alias:\n<%= config.bin %> <%= command.id %> target-org my-scratch-org",
+        "Set the global target-org and target-dev-hub configuration variables using aliases:\n<%= config.bin %> <%= command.id %> --global target-org=my-scratch-org target-dev-hub=my-dev-hub"
       ],
       "deprecateAliases": true,
       "flags": {
@@ -340,7 +339,7 @@
     "config:unset": {
       "id": "config:unset",
       "summary": "Unset local or global configuration variables.",
-      "description": "Local configuration variables apply only to your current project. Global configuration variables apply in any Salesforce DX project.",
+      "description": "Local configuration variables apply only to your current project. Global configuration variables apply in any Salesforce DX project.\n\nFor the full list of available configuration variables, see https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_dev_cli_config_values.htm.",
       "strict": false,
       "pluginName": "@salesforce/plugin-settings",
       "pluginAlias": "@salesforce/plugin-settings",
@@ -376,7 +375,7 @@
           "name": "global",
           "type": "boolean",
           "char": "g",
-          "summary": "Unset the configuration variables globally, so they can no longer be used from any Salesforce DX project.",
+          "summary": "Unset the configuration variables globally.",
           "allowNo": false,
           "deprecateAliases": true
         }

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@salesforce/plugin-settings",
     "description": "configure the Salesforce CLI",
-    "version": "1.4.32",
+    "version": "1.4.34",
     "author": "Salesforce",
     "bugs": "https://github.com/forcedotcom/cli/issues",
     "dependencies": {
@@ -13,24 +13,24 @@
     },
     "devDependencies": {
         "@oclif/plugin-command-snapshot": "^4.0.14",
-        "@oclif/test": "^2.5.5",
-        "@salesforce/cli-plugins-testkit": "^4.3.4",
+        "@oclif/test": "^2.5.6",
+        "@salesforce/cli-plugins-testkit": "^4.4.7",
         "@salesforce/dev-config": "^4.0.1",
-        "@salesforce/dev-scripts": "^5.10.0",
+        "@salesforce/dev-scripts": "^5.11.0",
         "@salesforce/kit": "^3.0.11",
-        "@salesforce/plugin-command-reference": "^3.0.33",
-        "@salesforce/plugin-deploy-retrieve": "^1.17.11",
+        "@salesforce/plugin-command-reference": "^3.0.40",
+        "@salesforce/plugin-deploy-retrieve": "^1.18.7",
         "@salesforce/prettier-config": "^0.0.3",
-        "@salesforce/ts-sinon": "^1.4.15",
+        "@salesforce/ts-sinon": "^1.4.17",
         "@salesforce/ts-types": "^2.0.6",
         "@swc/core": "^1.3.27",
         "@types/fast-levenshtein": "^0.0.2",
         "@types/fs-extra": "^9.0.13",
-        "@types/shelljs": "^0.8.12",
+        "@types/shelljs": "^0.8.13",
         "@typescript-eslint/eslint-plugin": "^5.62.0",
         "@typescript-eslint/parser": "^5.62.0",
-        "chai": "^4.3.8",
-        "eslint": "^8.50.0",
+        "chai": "^4.3.10",
+        "eslint": "^8.51.0",
         "eslint-config-prettier": "^8.10.0",
         "eslint-config-salesforce": "^2.0.2",
         "eslint-config-salesforce-license": "^0.2.0",
@@ -38,7 +38,7 @@
         "eslint-plugin-header": "^3.1.1",
         "eslint-plugin-import": "^2.28.1",
         "eslint-plugin-jsdoc": "^43.0.5",
-        "eslint-plugin-sf-plugin": "^1.16.0",
+        "eslint-plugin-sf-plugin": "^1.16.9",
         "fs-extra": "^10.1.0",
         "husky": "^7.0.4",
         "mocha": "^9.2.2",
@@ -228,7 +228,7 @@
         }
     },
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-settings/1.4.32.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-settings/1.4.32.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-settings/1.4.34.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-settings/1.4.34.sig"
     }
 }