CamelCase / CamelCasedProperties / CamelCasedPropertiesDeep / PascalCase / PascalCasedProperties / PascalCasedPropertiesDeep: Disable preserveConsecutiveUppercase option by default (#1130)

Author: som-sm

source/camel-case.d.ts

@@ -10,13 +10,13 @@ export type CamelCaseOptions = {
 	/**
 	Whether to preserved consecutive uppercase letter.
 
-	@default true
+	@default false
 	*/
 	preserveConsecutiveUppercase?: boolean;
 };
 
 export type DefaultCamelCaseOptions = {
-	preserveConsecutiveUppercase: true;
+	preserveConsecutiveUppercase: false;
 };
 
 /**

source/camel-cased-properties-deep.d.ts

@@ -41,10 +41,10 @@ const result: CamelCasedPropertiesDeep<UserWithFriends> = {
 	],
 };
 
-const preserveConsecutiveUppercase: CamelCasedPropertiesDeep<{fooBAR: { fooBARBiz: [{ fooBARBaz: string }] }}, {preserveConsecutiveUppercase: false}> = {
-	fooBar: {
-		fooBarBiz: [{
-			fooBarBaz: 'string',
+const preserveConsecutiveUppercase: CamelCasedPropertiesDeep<{fooBAR: {fooBARBiz: [{fooBARBaz: string}]}}, {preserveConsecutiveUppercase: true}> = {
+	fooBAR: {
+		fooBARBiz: [{
+			fooBARBaz: 'string',
 		}],
 	},
 };

source/camel-cased-properties.d.ts

@@ -23,8 +23,8 @@ const result: CamelCasedProperties<User> = {
 	userName: 'Tom',
 };
 
-const preserveConsecutiveUppercase: CamelCasedProperties<{fooBAR: string}, {preserveConsecutiveUppercase: false}> = {
-	fooBar: 'string',
+const preserveConsecutiveUppercase: CamelCasedProperties<{fooBAR: string}, {preserveConsecutiveUppercase: true}> = {
+	fooBAR: 'string',
 };
 ```
 

source/pascal-case.d.ts

@@ -11,23 +11,30 @@ import type {PascalCase} from 'type-fest';
 // Simple
 
 const someVariable: PascalCase<'foo-bar'> = 'FooBar';
+const preserveConsecutiveUppercase: PascalCase<'foo-BAR-baz', {preserveConsecutiveUppercase: true}> = 'FooBARBaz';
 
 // Advanced
 
-type PascalCaseProps<T> = {
+type PascalCasedProperties<T> = {
 	[K in keyof T as PascalCase<K>]: T[K]
 };
 
 interface RawOptions {
 	'dry-run': boolean;
 	'full_family_name': string;
 	foo: number;
-}
+	BAR: string;
+	QUZ_QUX: number;
+	'OTHER-FIELD': boolean;
+};
 
-const dbResult: CamelCasedProperties<ModelProps> = {
+const dbResult: PascalCasedProperties<RawOptions> = {
 	DryRun: true,
 	FullFamilyName: 'bar.js',
-	Foo: 123
+	Foo: 123,
+	Bar: 'foo',
+	QuzQux: 6,
+	OtherField: false,
 };
 ```
 

source/pascal-cased-properties-deep.d.ts

@@ -40,6 +40,14 @@ const result: PascalCasedPropertiesDeep<UserWithFriends> = {
 		},
 	],
 };
+
+const preserveConsecutiveUppercase: PascalCasedPropertiesDeep<{fooBAR: {fooBARBiz: [{fooBARBaz: string}]}}, {preserveConsecutiveUppercase: true}> = {
+	FooBAR: {
+		FooBARBiz: [{
+			FooBARBaz: 'string',
+		}],
+	},
+};
 ```
 
 @category Change case

source/pascal-cased-properties.d.ts

@@ -23,6 +23,10 @@ const result: PascalCasedProperties<User> = {
 	UserId: 1,
 	UserName: 'Tom',
 };
+
+const preserveConsecutiveUppercase: PascalCasedProperties<{fooBAR: string}, {preserveConsecutiveUppercase: true}> = {
+	FooBAR: 'string',
+};
 ```
 
 @category Change case

test-d/camel-case.ts

@@ -67,15 +67,15 @@ expectAssignable<CamelCasedProperties<RawOptions>>({
 	otherField: false,
 });
 
-expectType<CamelCase<'fooBAR'>>('fooBAR');
-expectType<CamelCase<'fooBAR', {preserveConsecutiveUppercase: false}>>('fooBar');
+expectType<CamelCase<'fooBAR'>>('fooBar');
+expectType<CamelCase<'fooBAR', {preserveConsecutiveUppercase: true}>>('fooBAR');
 
-expectType<CamelCase<'fooBARBiz'>>('fooBARBiz');
-expectType<CamelCase<'fooBARBiz', {preserveConsecutiveUppercase: false}>>('fooBarBiz');
+expectType<CamelCase<'fooBARBiz'>>('fooBarBiz');
+expectType<CamelCase<'fooBARBiz', {preserveConsecutiveUppercase: true}>>('fooBARBiz');
 
-expectType<CamelCase<'foo BAR-Biz_BUZZ'>>('fooBARBizBUZZ');
+expectType<CamelCase<'foo BAR-Biz_BUZZ', {preserveConsecutiveUppercase: true}>>('fooBARBizBUZZ');
 expectType<CamelCase<'foo BAR-Biz_BUZZ', {preserveConsecutiveUppercase: false}>>('fooBarBizBuzz');
-expectType<CamelCase<'foo\tBAR-Biz_BUZZ', {preserveConsecutiveUppercase: false}>>('fooBarBizBuzz');
+expectType<CamelCase<'foo\tBAR-Biz_BUZZ'>>('fooBarBizBuzz');
 
+expectType<CamelCase<string, {preserveConsecutiveUppercase: true}>>('string' as string);
 expectType<CamelCase<string>>('string' as string);
-expectType<CamelCase<string, {preserveConsecutiveUppercase: false}>>('string' as string);

test-d/camel-cased-properties-deep.ts

@@ -13,10 +13,10 @@ expectType<Set<{fooBar: string}>>(bar);
 
 type bazBizDeep = {fooBAR: number; baz: {fooBAR: Array<{BARFoo: string}>}};
 
-declare const baz: CamelCasedPropertiesDeep<bazBizDeep>;
+declare const baz: CamelCasedPropertiesDeep<bazBizDeep, {preserveConsecutiveUppercase: true}>;
 expectType<{fooBAR: number; baz: {fooBAR: Array<{bARFoo: string}>}}>(baz);
 
-declare const biz: CamelCasedPropertiesDeep<bazBizDeep, {preserveConsecutiveUppercase: false}>;
+declare const biz: CamelCasedPropertiesDeep<bazBizDeep>;
 expectType<{fooBar: number; baz: {fooBar: Array<{barFoo: string}>}}>(biz);
 
 declare const tuple: CamelCasedPropertiesDeep<{tuple: [number, string, {D: string}]}>;

test-d/camel-cased-properties.ts

@@ -10,10 +10,10 @@ expectType<Array<{helloWorld: string}>>(bar);
 declare const fooBar: CamelCasedProperties<() => {a: string}>;
 expectType<() => {a: string}>(fooBar);
 
-declare const baz: CamelCasedProperties<{fooBAR: number; BARFoo: string}>;
+declare const baz: CamelCasedProperties<{fooBAR: number; BARFoo: string}, {preserveConsecutiveUppercase: true}>;
 expectType<{fooBAR: number; bARFoo: string}>(baz);
 
-declare const biz: CamelCasedProperties<{fooBAR: number; BARFoo: string}, {preserveConsecutiveUppercase: false}>;
+declare const biz: CamelCasedProperties<{fooBAR: number; BARFoo: string}>;
 expectType<{fooBar: number; barFoo: string}>(biz);
 
 // Verify example

test-d/pascal-case.ts

@@ -9,3 +9,16 @@ expectType<'FooBar'>(pascalFromKebab);
 
 const pascalFromComplexKebab: PascalCase<'foo-bar-abc-123'> = 'FooBarAbc123';
 expectType<'FooBarAbc123'>(pascalFromComplexKebab);
+
+expectType<PascalCase<'fooBAR'>>('FooBar');
+expectType<PascalCase<'fooBAR', {preserveConsecutiveUppercase: true}>>('FooBAR');
+
+expectType<PascalCase<'fooBARBiz'>>('FooBarBiz');
+expectType<PascalCase<'fooBARBiz', {preserveConsecutiveUppercase: true}>>('FooBARBiz');
+
+expectType<PascalCase<'foo BAR-Biz_BUZZ', {preserveConsecutiveUppercase: true}>>('FooBARBizBUZZ');
+expectType<PascalCase<'foo BAR-Biz_BUZZ', {preserveConsecutiveUppercase: false}>>('FooBarBizBuzz');
+expectType<PascalCase<'foo\tBAR-Biz_BUZZ'>>('FooBarBizBuzz');
+
+expectType<PascalCase<string, {preserveConsecutiveUppercase: true}>>({} as Capitalize<string>);
+expectType<PascalCase<string>>({} as Capitalize<string>);