feat: normalize config vars for sf (#543)

* feat: add metadata-rest-deploy

* feat: replace all sfdx config vars with sf appropriate ones

* chore: spelling

* chore: correct readme

* chore: correct deprecation note

* chore: update exports

* fix: update envVars too

* chore: remove org-metadata-rest-deploy

* chore: rebuild

Author: mdonnalley

.circleci/config.yml

@@ -133,8 +133,9 @@ workflows:
               node_version: [lts]
               external_project_git_url:
                 [
+                  # 'https://github.com/salesforcecli/plugin-config#v2',
+                  'https://github.com/salesforcecli/plugin-config#mdonnalley/update-tests',
                   'https://github.com/salesforcecli/plugin-alias',
-                  'https://github.com/salesforcecli/plugin-config#v2',
                   'https://github.com/salesforcecli/plugin-env',
                   'https://github.com/salesforcecli/plugin-login',
                   'https://github.com/salesforcecli/plugin-deploy-retrieve',

MIGRATING_V2-V3.md

@@ -63,7 +63,20 @@ info.aliases.getAll();
 
 - Moved `.sfdx/sfdx-config.json` to `.sf/config.json`
 - Removed `Config.<config key name>`
-- Deprecated `DEFAULT_USERNAME` and `DEFAULT_DEV_HUB_USERNAME`
+- Deprecated the following:
+
+| Deprecated Config Var                            | New Config Var                                      |
+| ------------------------------------------------ | --------------------------------------------------- |
+| `SfdxPropertyKeys.API_VERSION`                   | `OrgConfigProperties.ORG_API_VERSION`               |
+| `SfdxPropertyKeys.CUSTOM_ORG_METADATA_TEMPLATES` | `OrgConfigProperties.ORG_CUSTOM_METADATA_TEMPLATES` |
+| `SfdxPropertyKeys.DEFAULT_DEV_HUB_USERNAME`      | `OrgConfigProperties.TARGET_DEV_HUB`                |
+| `SfdxPropertyKeys.DEFAULT_USERNAME`              | `OrgConfigProperties.TARGET_ORG`                    |
+| `SfdxPropertyKeys.DISABLE_TELEMETRY`             | `SfConfigProperties.DISABLE_TELEMETRY`              |
+| `SfdxPropertyKeys.INSTANCE_URL`                  | `OrgConfigProperties.ORG_INSTANCE_URL`              |
+| `SfdxPropertyKeys.ISV_DEBUGGER_SID`              | `OrgConfigProperties.ORG_ISV_DEBUGGER_SID`          |
+| `SfdxPropertyKeys.ISV_DEBUGGER_URL`              | `OrgConfigProperties.ORG_ISV_DEBUGGER_URL`          |
+| `SfdxPropertyKeys.MAX_QUERY_LIMIT`               | `OrgConfigProperties.ORG_MAX_QUERY_LIMIT`           |
+| `SfdxPropertyKeys.REST_DEPLOY`                   | REMOVED                                             |
 
 ### Why
 
@@ -81,6 +94,12 @@ Config.update(true, Config.API_VERSION, '49.0');
 Config.update(true, SfdxPropertyKeys.API_VERSION, '49.0');
 ```
 
+OR
+
+```typescript
+Config.update(true, OrgConfigProperties.ORG_API_VERSION, '49.0');
+```
+
 ## ConfigStore, ConfigFile, AuthInfo, and Encrypting Values
 
 ### What

messages/config.md

@@ -75,11 +75,11 @@ In sfdx-project.json, indicate only one package directory (path) as the default.
 
 The sfdx-project.json file must include one, and only one, default package directory (path). Because your sfdx-project.json file contains only one package directory, it must be the default. Remove the `"default": false` key and try again.
 
-# targetOrg
+# target-org
 
 Username or alias of the org that all commands run against by default. (sf only)
 
-# targetDevHub
+# target-dev-hub
 
 Username or alias of your default Dev Hub org. (sf only)
 
@@ -93,28 +93,52 @@ Username or alias of your default Dev Hub org. (sfdx only)
 
 # isvDebuggerSid
 
-ISV debugger SID
+ISV debugger SID (sfdx only)
 
 # isvDebuggerUrl
 
-ISV debugger URL
+ISV debugger URL (sfdx only)
+
+# org-isv-debugger-sid
+
+ISV debugger SID.
+
+# org-isv-debugger-url
+
+ISV debugger URL.
 
 # apiVersion
 
+API version of your project. Default: API version of your Dev Hub org. (sfdx only)
+
+# org-api-version
+
 API version of your project. Default: API version of your Dev Hub org.
 
 # disableTelemetry
 
-Disables the collection of usage and user environment information, etc. Default: true.
+Disables the collection of usage and user environment information, etc. Default: false. (sfdx only)
+
+# disable-telemetry
+
+Disables the collection of usage and user environment information, etc. Default: false.
 
 # maxQueryLimit
 
+Maximum number of Salesforce records returned by a CLI command. Default: 10,000. (sfdx only)
+
+# org-max-query-limit
+
 Maximum number of Salesforce records returned by a CLI command. Default: 10,000.
 
 # restDeploy
 
-Whether deployments use the Metadata REST API (true) or SOAP API (false, default value).
+Whether deployments use the Metadata REST API (true) or SOAP API (false, default value). (sfdx only)
 
 # instanceUrl
 
+URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com. (sfdx only)
+
+# org-instance-url
+
 URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com.

messages/envVars.md

@@ -174,7 +174,7 @@ Username or alias of your default Dev Hub org. Overrides the target-dev-hub conf
 
 Specifies an access token when using a login command that uses access tokens.
 
-# sfApiVersion
+# sfOrgApiVersion
 
 API version for a specific project or all projects. Default value is the API version of your Dev Hub. Overrides the apiVersion configuration variable.
 
@@ -218,7 +218,7 @@ Time, in seconds, that Salesforce CLI waits for the Lightning Experience custom
 
 Set to true to scope Apex test results to the classes entered during a test run when running the Apex test commands.
 
-# sfInstanceUrl
+# sfOrgInstanceUrl
 
 URL of the Salesforce instance that is hosting your org. Default value is https://login.salesforce.com. Overrides the instanceUrl configuration variable.
 
@@ -238,7 +238,7 @@ The default rotation period for logs. Example '1d' will rotate logs daily (at mi
 
 The number of backup rotated log files to keep. Example: '3' will have the base sf.log file, and the past 3 (period) log files.
 
-# sfMaxQueryLimit
+# sfOrgMaxQueryLimit
 
 Maximum number of Salesforce records returned by a CLI command. Default value is 10,000. Overrides the maxQueryLimit configuration variable.
 

src/config/config.ts

@@ -40,6 +40,7 @@ const messages = Messages.load('@salesforce/core', 'config', [
   'maxQueryLimit',
   'restDeploy',
   'instanceUrl',
+  'disable-telemetry',
 ]);
 
 const log = Logger.childFromRoot('core:config');
@@ -104,6 +105,24 @@ export interface ConfigPropertyMetaInput {
   failedMessage: string | ((value: ConfigValue) => string);
 }
 
+export enum SfConfigProperties {
+  /**
+   * Disables telemetry reporting
+   */
+  DISABLE_TELEMETRY = 'disable-telemetry',
+}
+
+export const SF_ALLOWED_PROPERTIES = [
+  {
+    key: SfConfigProperties.DISABLE_TELEMETRY,
+    description: messages.getMessage(SfConfigProperties.DISABLE_TELEMETRY),
+    input: {
+      validator: (value: ConfigValue) => value == null || ['true', 'false'].includes(value.toString()),
+      failedMessage: messages.getMessage('invalidBooleanConfigValue'),
+    },
+  },
+];
+
 export enum SfdxPropertyKeys {
   /**
    * Username associated with the default dev hub org.
@@ -123,45 +142,63 @@ export enum SfdxPropertyKeys {
 
   /**
    * The sid for the debugger configuration.
+   *
+   * @deprecated Replaced by OrgConfigProperties.ORG_ISV_DEBUGGER_SID in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
    */
   ISV_DEBUGGER_SID = 'isvDebuggerSid',
 
   /**
    * The url for the debugger configuration.
+   *
+   * @deprecated Replaced by OrgConfigProperties.ORG_ISV_DEBUGGER_URL in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
    */
   ISV_DEBUGGER_URL = 'isvDebuggerUrl',
 
   /**
    * The api version
+   *
+   * @deprecated Replaced by OrgConfigProperties.ORG_API_VERSION in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
    */
   API_VERSION = 'apiVersion',
 
   /**
    * Disables telemetry reporting
+   *
+   * @deprecated Replaced by SfPropertyKeys.DISABLE_TELEMETRY in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
    */
   DISABLE_TELEMETRY = 'disableTelemetry',
 
   /**
    * Custom templates repo or local location.
+   *
+   * @deprecated Replaced by OrgConfigProperties.ORG_CUSTOM_METADATA_TEMPLATES in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
    */
   CUSTOM_ORG_METADATA_TEMPLATES = 'customOrgMetadataTemplates',
 
   /**
    * allows users to override the 10,000 result query limit
+   *
+   * @deprecated Replaced by OrgConfigProperties.ORG_MAX_QUERY_LIMIT in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
    */
   MAX_QUERY_LIMIT = 'maxQueryLimit',
 
-  /** */
+  /**
+   * @deprecated
+   */
   REST_DEPLOY = 'restDeploy',
 
-  /** */
+  /**
+   * @deprecated Replaced by OrgConfigProperties.ORG_INSTANCE_URL in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
+   */
   INSTANCE_URL = 'instanceUrl',
 }
 
 export const SFDX_ALLOWED_PROPERTIES = [
   {
     key: SfdxPropertyKeys.INSTANCE_URL,
     description: messages.getMessage(SfdxPropertyKeys.INSTANCE_URL),
+    newKey: OrgConfigProperties.ORG_INSTANCE_URL,
+    deprecated: true,
     input: {
       // If a value is provided validate it otherwise no value is unset.
       validator: (value: ConfigValue) => {
@@ -179,6 +216,8 @@ export const SFDX_ALLOWED_PROPERTIES = [
   },
   {
     key: SfdxPropertyKeys.API_VERSION,
+    newKey: OrgConfigProperties.ORG_API_VERSION,
+    deprecated: true,
     description: messages.getMessage(SfdxPropertyKeys.API_VERSION),
     hidden: true,
     input: {
@@ -203,6 +242,8 @@ export const SFDX_ALLOWED_PROPERTIES = [
   },
   {
     key: SfdxPropertyKeys.ISV_DEBUGGER_SID,
+    newKey: OrgConfigProperties.ORG_ISV_DEBUGGER_SID,
+    deprecated: true,
     description: messages.getMessage(SfdxPropertyKeys.ISV_DEBUGGER_SID),
     encrypted: true,
     input: {
@@ -213,6 +254,8 @@ export const SFDX_ALLOWED_PROPERTIES = [
   },
   {
     key: SfdxPropertyKeys.ISV_DEBUGGER_URL,
+    newKey: OrgConfigProperties.ORG_ISV_DEBUGGER_URL,
+    deprecated: true,
     description: messages.getMessage(SfdxPropertyKeys.ISV_DEBUGGER_URL),
     input: {
       // If a value is provided validate it otherwise no value is unset.
@@ -222,17 +265,20 @@ export const SFDX_ALLOWED_PROPERTIES = [
   },
   {
     key: SfdxPropertyKeys.DISABLE_TELEMETRY,
+    newKey: SfConfigProperties.DISABLE_TELEMETRY,
+    deprecated: true,
     description: messages.getMessage(SfdxPropertyKeys.DISABLE_TELEMETRY),
     input: {
       validator: (value: ConfigValue) => value == null || ['true', 'false'].includes(value.toString()),
       failedMessage: messages.getMessage('invalidBooleanConfigValue'),
     },
   },
-  // This should be brought in by a plugin, but there isn't a way to do that right now.
   {
     key: SfdxPropertyKeys.REST_DEPLOY,
     description: messages.getMessage(SfdxPropertyKeys.REST_DEPLOY),
     hidden: true,
+    newKey: 'org-metadata-rest-deploy',
+    deprecated: true,
     input: {
       validator: (value: ConfigValue) => value != null && ['true', 'false'].includes(value.toString()),
       failedMessage: messages.getMessage('invalidBooleanConfigValue'),
@@ -241,6 +287,8 @@ export const SFDX_ALLOWED_PROPERTIES = [
   {
     key: SfdxPropertyKeys.MAX_QUERY_LIMIT,
     description: messages.getMessage(SfdxPropertyKeys.MAX_QUERY_LIMIT),
+    hidden: true,
+    newKey: OrgConfigProperties.ORG_MAX_QUERY_LIMIT,
     input: {
       // the bit shift will remove the negative bit, and any decimal numbers
       // then the parseFloat will handle converting it to a number from a string
@@ -272,6 +320,7 @@ export type ConfigProperties = { [index: string]: JsonPrimitive };
 export class Config extends ConfigFile<ConfigFile.Options, ConfigProperties> {
   private static allowedProperties: ConfigPropertyMeta[] = [
     ...SFDX_ALLOWED_PROPERTIES,
+    ...SF_ALLOWED_PROPERTIES,
     ...ORG_CONFIG_ALLOWED_PROPERTIES,
   ];
 

src/config/envVars.ts

@@ -58,7 +58,7 @@ export enum EnvironmentVariable {
   'SF_TARGET_ORG' = 'SF_TARGET_ORG',
   'SF_TARGET_DEV_HUB' = 'SF_TARGET_DEV_HUB',
   'SF_ACCESS_TOKEN' = 'SF_ACCESS_TOKEN',
-  'SF_API_VERSION' = 'SF_API_VERSION',
+  'SF_ORG_API_VERSION' = 'SF_ORG_API_VERSION',
   'SF_AUDIENCE_URL' = 'SF_AUDIENCE_URL',
   'SF_CODE_COVERAGE_REQUIREMENT' = 'SF_CODE_COVERAGE_REQUIREMENT',
   'SF_CONTENT_TYPE' = 'SF_CONTENT_TYPE',
@@ -69,12 +69,12 @@ export enum EnvironmentVariable {
   'SF_DNS_TIMEOUT' = 'SF_DNS_TIMEOUT',
   'SF_DOMAIN_RETRY' = 'SF_DOMAIN_RETRY',
   'SF_IMPROVED_CODE_COVERAGE' = 'SF_IMPROVED_CODE_COVERAGE',
-  'SF_INSTANCE_URL' = 'SF_INSTANCE_URL',
+  'SF_ORG_INSTANCE_URL' = 'SF_ORG_INSTANCE_URL',
   'SF_JSON_TO_STDOUT' = 'SF_JSON_TO_STDOUT',
   'SF_LOG_LEVEL' = 'SF_LOG_LEVEL',
   'SF_LOG_ROTATION_COUNT' = 'SF_LOG_ROTATION_COUNT',
   'SF_LOG_ROTATION_PERIOD' = 'SF_LOG_ROTATION_PERIOD',
-  'SF_MAX_QUERY_LIMIT' = 'SF_MAX_QUERY_LIMIT',
+  'SF_ORG_MAX_QUERY_LIMIT' = 'SF_ORG_MAX_QUERY_LIMIT',
   'SF_MDAPI_TEMP_DIR' = 'SF_MDAPI_TEMP_DIR',
   'SF_NPM_REGISTRY' = 'SF_NPM_REGISTRY',
   'SF_PRECOMPILE_ENABLE' = 'SF_PRECOMPILE_ENABLE',
@@ -137,7 +137,7 @@ export const SUPPORTED_ENV_VARS: EnvType = {
   },
   [EnvironmentVariable.SFDX_API_VERSION]: {
     description: getMessage(EnvironmentVariable.SFDX_API_VERSION),
-    synonymOf: EnvironmentVariable.SF_API_VERSION,
+    synonymOf: EnvironmentVariable.SF_ORG_API_VERSION,
   },
   [EnvironmentVariable.SFDX_AUDIENCE_URL]: {
     description: getMessage(EnvironmentVariable.SFDX_AUDIENCE_URL),
@@ -189,7 +189,7 @@ export const SUPPORTED_ENV_VARS: EnvType = {
   },
   [EnvironmentVariable.SFDX_INSTANCE_URL]: {
     description: getMessage(EnvironmentVariable.SFDX_INSTANCE_URL),
-    synonymOf: EnvironmentVariable.SF_INSTANCE_URL,
+    synonymOf: EnvironmentVariable.SF_ORG_INSTANCE_URL,
   },
   [EnvironmentVariable.SFDX_JSON_TO_STDOUT]: {
     description: getMessage(EnvironmentVariable.SFDX_JSON_TO_STDOUT),
@@ -209,7 +209,7 @@ export const SUPPORTED_ENV_VARS: EnvType = {
   },
   [EnvironmentVariable.SFDX_MAX_QUERY_LIMIT]: {
     description: getMessage(EnvironmentVariable.SFDX_MAX_QUERY_LIMIT),
-    synonymOf: EnvironmentVariable.SF_MAX_QUERY_LIMIT,
+    synonymOf: EnvironmentVariable.SF_ORG_MAX_QUERY_LIMIT,
   },
   [EnvironmentVariable.SFDX_MDAPI_TEMP_DIR]: {
     description: getMessage(EnvironmentVariable.SFDX_MDAPI_TEMP_DIR),
@@ -282,8 +282,8 @@ export const SUPPORTED_ENV_VARS: EnvType = {
     description: getMessage(EnvironmentVariable.SF_ACCESS_TOKEN),
     synonymOf: null,
   },
-  [EnvironmentVariable.SF_API_VERSION]: {
-    description: getMessage(EnvironmentVariable.SF_API_VERSION),
+  [EnvironmentVariable.SF_ORG_API_VERSION]: {
+    description: getMessage(EnvironmentVariable.SF_ORG_API_VERSION),
     synonymOf: null,
   },
   [EnvironmentVariable.SF_AUDIENCE_URL]: {
@@ -326,8 +326,8 @@ export const SUPPORTED_ENV_VARS: EnvType = {
     description: getMessage(EnvironmentVariable.SF_IMPROVED_CODE_COVERAGE),
     synonymOf: null,
   },
-  [EnvironmentVariable.SF_INSTANCE_URL]: {
-    description: getMessage(EnvironmentVariable.SF_INSTANCE_URL),
+  [EnvironmentVariable.SF_ORG_INSTANCE_URL]: {
+    description: getMessage(EnvironmentVariable.SF_ORG_INSTANCE_URL),
     synonymOf: null,
   },
   [EnvironmentVariable.SF_JSON_TO_STDOUT]: {
@@ -346,8 +346,8 @@ export const SUPPORTED_ENV_VARS: EnvType = {
     description: getMessage(EnvironmentVariable.SF_LOG_ROTATION_PERIOD),
     synonymOf: null,
   },
-  [EnvironmentVariable.SF_MAX_QUERY_LIMIT]: {
-    description: getMessage(EnvironmentVariable.SF_MAX_QUERY_LIMIT),
+  [EnvironmentVariable.SF_ORG_MAX_QUERY_LIMIT]: {
+    description: getMessage(EnvironmentVariable.SF_ORG_MAX_QUERY_LIMIT),
     synonymOf: null,
   },
   [EnvironmentVariable.SF_MDAPI_TEMP_DIR]: {