feat(pascal-case): add pascalCase as alias to camelCase and fix camelCase helper split logic (#450)

Co-authored-by: Wouter Heirstrate <[email protected]>

Author: WHeirstrate

apps/docs/src/app/pages/docs/javascript/utils/introduction/index.md

@@ -30,6 +30,10 @@ Converts a camelCase string to a human-readable sentence.
 
 Replace all special characters to their normal counterparts.
 
+### `*pascalCaseToSentencePage`
+
+Converts a PascalCase string to a human-readable sentence.
+
 ### `*replaceHtmlWhitespacePage`
 
 Returns the filtered html as a string that has replaced the non-breakable whitespaces with regular spaces.

apps/docs/src/app/pages/docs/javascript/utils/string/camelCaseToSentence/index.md

@@ -9,7 +9,7 @@ The camelCaseToSentence helper converts a camelCase string to a human-readable s
 ```typescript
 import { camelCaseToSentence } from '@studiohyperdrive/utils';
 
-const result = camelCaseToSentence('SubscribeForMore');
+const result = camelCaseToSentence('subscribeForMore');
 
 // result = 'Subscribe for more'
 ```

apps/docs/src/app/pages/docs/javascript/utils/string/pascalCaseToSentence/index.md

@@ -0,0 +1,15 @@
+---
+keyword: pascalCaseToSentencePage
+---
+
+The pascalCaseToSentence helper converts a PascalCase string to a human-readable sentence.
+
+## How to use
+
+```typescript
+import { pascalCaseToSentence } from '@studiohyperdrive/utils';
+
+const result = pascalCaseToSentence('SubscribeForMore');
+
+// result = 'Subscribe for more'
+```

apps/docs/src/app/pages/docs/javascript/utils/string/pascalCaseToSentence/ng-doc.page.ts

@@ -0,0 +1,11 @@
+import { NgDocPage } from '@ng-doc/core';
+import { StringCategory } from '../../../../../../categories/javascript';
+
+const pascalCaseToSentencePage: NgDocPage = {
+	title: `pascalCaseToSentence`,
+	mdFile: './index.md',
+	category: StringCategory,
+	order: 0,
+};
+
+export default pascalCaseToSentencePage;

libs/javascript/utils/src/lib/string/camel-case-to-sentence/camel-case-to-sentence.util.md

@@ -1,13 +1,13 @@
 # camelCaseToSentence
 
-The camelCaseToSentence helper converts a camelCase string to a human-readable sentence.
+The camelCaseToSentence helper converts a camelCase string to a human-readable sentence. The first letter will be uppercase, while the rest of the string will be lowercase.
 
 ## How to use
 
 ```typescript
 import { camelCaseToSentence } from '@studiohyperdrive/utils';
 
-const result = camelCaseToSentence('SubscribeForMore');
+const result = camelCaseToSentence('subscribeForMore');
 
 // result = 'Subscribe for more'
 ```

libs/javascript/utils/src/lib/string/camel-case-to-sentence/camel-case-to-sentence.util.spec.ts

@@ -3,6 +3,14 @@ import { camelCaseToSentence } from './camel-case-to-sentence.util';
 /* eslint-disable @typescript-eslint/no-explicit-any */
 describe('camelCaseToSentence', () => {
 	it('should convert a camelCase string to a sentence', () => {
+		expect(camelCaseToSentence('subscribeForMore')).toEqual('Subscribe for more');
+		expect(camelCaseToSentence('string')).toEqual('String');
+		expect(camelCaseToSentence('someExtraLongDescription')).toEqual(
+			'Some extra long description'
+		);
+	});
+
+	it('should also convert a PascalCase string to a sentence', () => {
 		expect(camelCaseToSentence('SubscribeForMore')).toEqual('Subscribe for more');
 	});
 

libs/javascript/utils/src/lib/string/camel-case-to-sentence/camel-case-to-sentence.util.ts

@@ -1,9 +1,14 @@
 /**
- * Converts a camelCase string to a human-readable sentence
+ * Converts a camelCase string to a human-readable sentence.
  *
  * @param value - The provided value
+ *
+ * @example
+ * camelCaseToSentence('awesomeUtils') // 'Awesome utils'
+ *
+ * @returns A human-readable sentence derived from the camelCase string. The first
+ * letter will be uppercase, while the rest of the string will be lowercase.
  */
-
 export const camelCaseToSentence = (value: string): string => {
 	// Iben: Early exit if no (string) value was provided
 	if (!value || typeof value !== 'string') {
@@ -13,10 +18,12 @@ export const camelCaseToSentence = (value: string): string => {
 	return (
 		value
 			// Iben: Split by uppercase
-			.match(/[A-Z][a-z]+/g)
-			// Iben: Lowercase all but the first word
+			.split(/(?=[A-Z])/)
+			// Iben: Lowercase all but the first letter of the first word
 			.map((value, index) => {
-				return index === 0 ? value : value.toLowerCase();
+				return index === 0
+					? value[0].toUpperCase() + value.slice(1).toLowerCase()
+					: value.toLowerCase();
 			})
 			// Iben: Join back to a string
 			.join(' ')

libs/javascript/utils/src/lib/string/pascal-case-to-sentence/pascal-case-to-sentence.util.md

@@ -0,0 +1,13 @@
+# camelCaseToSentence
+
+The pascalCaseToSentence helper converts a PascalCase string to a human-readable sentence. The first letter will be uppercase, while the rest of the string will be lowercase.
+
+## How to use
+
+```typescript
+import { pascalCaseToSentence } from '@studiohyperdrive/utils';
+
+const result = pascalCaseToSentence('SubscribeForMore');
+
+// result = 'Subscribe for more'
+```

libs/javascript/utils/src/lib/string/pascal-case-to-sentence/pascal-case-to-sentence.util.spec.ts

@@ -0,0 +1,28 @@
+import { pascalCaseToSentence } from './pascal-case-to-sentence.util';
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+describe('pascalCaseToSentence', () => {
+	it('should convert a PascalCase string to a sentence', () => {
+		expect(pascalCaseToSentence('SubscribeForMore')).toEqual('Subscribe for more');
+		expect(pascalCaseToSentence('String')).toEqual('String');
+		expect(pascalCaseToSentence('SomeExtraLongDescription')).toEqual(
+			'Some extra long description'
+		);
+	});
+
+	it('should also convert a camelCase string to a sentence', () => {
+		expect(pascalCaseToSentence('subscribeForMore')).toEqual('Subscribe for more');
+	});
+
+	it('should return an empty string if no value was provided', () => {
+		expect(pascalCaseToSentence(null)).toEqual('');
+		expect(pascalCaseToSentence(undefined)).toEqual('');
+	});
+
+	it('should return an empty string if no string value was provided', () => {
+		expect(pascalCaseToSentence(true as any)).toEqual('');
+		expect(pascalCaseToSentence({ hello: 'world' } as any)).toEqual('');
+		expect(pascalCaseToSentence(0 as any)).toEqual('');
+		expect(pascalCaseToSentence([1] as any)).toEqual('');
+	});
+});

libs/javascript/utils/src/lib/string/pascal-case-to-sentence/pascal-case-to-sentence.util.ts

@@ -0,0 +1,16 @@
+import { camelCaseToSentence } from '../camel-case-to-sentence/camel-case-to-sentence.util';
+
+/**
+ * Converts a PascalCase string to a human-readable sentence.
+ *
+ * *This is an alias for {@link camelCaseToSentence}.*
+ *
+ * @param value - The provided value
+ *
+ * @example
+ * pascalCaseToSentence('AwesomeUtils') // 'Awesome utils'
+ *
+ * @returns A human-readable sentence derived from the PascalCase string. The first
+ * letter will be uppercase, while the rest of the string will be lowercase.
+ */
+export const pascalCaseToSentence = camelCaseToSentence;