fix: emit warning if config var is unset

messages/config.md

@@ -151,6 +151,10 @@ A valid repository URL or directory for the custom org metadata templates.
 
 A valid repository URL or directory for the custom org metadata templates.
 
+# org-capitalize-record-types
+
+Whether record types are capitalized on scrach org creation.
+
 # invalidId
 
 The given id %s is not a valid 15 or 18 character Salesforce ID.

src/org/orgConfigProperties.ts

@@ -57,7 +57,7 @@ export enum OrgConfigProperties {
 export const ORG_CONFIG_ALLOWED_PROPERTIES = [
   {
     key: OrgConfigProperties.ORG_CAPITALIZE_RECORD_TYPES,
-    description: messages.getMessage(OrgConfigProperties.ORG_CUSTOM_METADATA_TEMPLATES),
+    description: messages.getMessage(OrgConfigProperties.ORG_CAPITALIZE_RECORD_TYPES),
   },
   {
     key: OrgConfigProperties.ORG_CUSTOM_METADATA_TEMPLATES,

src/org/scratchOrgCreate.ts

@@ -4,7 +4,7 @@
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-import { Duration, toBoolean } from '@salesforce/kit';
+import { Duration } from '@salesforce/kit';
 import { ensureString } from '@salesforce/ts-types';
 import { Messages } from '../messages';
 import { Logger } from '../logger/logger';
@@ -150,7 +150,12 @@ export const scratchOrgResume = async (jobId: string): Promise<ScratchOrgCreateR
   const configAggregator = await ConfigAggregator.create();
 
   await emit({ stage: 'deploy settings', scratchOrgInfo: soi });
-  const settingsGenerator = new SettingsGenerator();
+
+  const capitalizeRecordTypes = await getCapitalizeRecordTypesConfig();
+
+  const settingsGenerator = new SettingsGenerator({
+    capitalizeRecordTypes,
+  });
   await settingsGenerator.extract({ ...soi, ...definitionjson });
   const [authInfo] = await Promise.all([
     resolveUrl(scratchOrgAuthInfo),
@@ -228,11 +233,11 @@ export const scratchOrgCreate = async (options: ScratchOrgCreateOptions): Promis
     ignoreAncestorIds,
   });
 
+  const capitalizeRecordTypes = await getCapitalizeRecordTypesConfig();
+
   // gets the scratch org settings (will use in both signup paths AND to deploy the settings)
   const settingsGenerator = new SettingsGenerator({
-    capitalizeRecordTypes: toBoolean(
-      (await ConfigAggregator.create()).getInfo('org-capitalize-record-types').value ?? true
-    ),
+    capitalizeRecordTypes,
   });
 
   const settings = await settingsGenerator.extract(scratchOrgInfo);
@@ -333,3 +338,8 @@ const getSignupTargetLoginUrl = async (): Promise<string | undefined> => {
     // a project isn't required for org:create
   }
 };
+
+async function getCapitalizeRecordTypesConfig(): Promise<boolean | undefined> {
+  const configAgg = await ConfigAggregator.create();
+  return configAgg.getInfo('org-capitalize-record-types').value as boolean | undefined;
+}

src/org/scratchOrgSettingsGenerator.ts

@@ -16,6 +16,7 @@ import { StatusResult } from '../status/types';
 import { PollingClient } from '../status/pollingClient';
 import { ZipWriter } from '../util/zipWriter';
 import { DirectoryWriter } from '../util/directoryWriter';
+import { Lifecycle } from '../lifecycleEvents';
 import { ScratchOrgInfo, ObjectSetting } from './scratchOrgTypes';
 import { Org } from './org';
 
@@ -210,7 +211,14 @@ export default class SettingsGenerator {
     capitalizeRecordTypes?: boolean;
   }) {
     this.logger = Logger.childFromRoot('SettingsGenerator');
-    this.capitalizeRecordTypes = options?.capitalizeRecordTypes ?? false;
+    if (options?.capitalizeRecordTypes === undefined) {
+      void Lifecycle.getInstance().emitWarning(
+        'record types will stop being capitalized by default in a future release.'
+      );
+      this.capitalizeRecordTypes = true;
+    } else {
+      this.capitalizeRecordTypes = options.capitalizeRecordTypes;
+    }
     // If SFDX_MDAPI_TEMP_DIR is set, copy settings to that dir for people to inspect.
     const mdApiTmpDir = options?.mdApiTmpDir ?? env.getString('SFDX_MDAPI_TEMP_DIR');
     this.shapeDirName = options?.shapeDirName ?? `shape_${Date.now()}`;