Improve `DelimiterCase` by filipw01 · Pull Request #930 · sindresorhus/type-fest

filipw01 · 2024-08-07T22:03:24Z

I made some changes that pass more test cases than the current solution. I was heavily inspired by CamelCase implementation

Opinions seem to be mixed from one library to another how hello123 case should be handled

Even more interestingly, those libraries that default to hello_123 don't have an option to customize it, but those that default to hello123 have optional parameters to change that

I made the type customizable via a parameter to fit both cases

Related issues:
#223
#336

What I'd still like to add:

add more test cases for other cases (kebab-case etc.)

filipw01 · 2024-08-27T12:23:05Z

@voxpelli Could you take a look? At the moment I just want to know if this is something I should dig deeper into

voxpelli · 2024-08-27T12:44:51Z

@filipw01 Its not immediately obvious to me what the improvements are, and my experience with these helpers has been that they easily turn into a game of whackamole – any improvement reveals a couple of regressions.

I do see that you ultimate refer to my wish to unify the two: #224 (comment)

To support this use case I think we essentially would have to merge the functionality of the two. I can't remember why I didn't do that initially.

But that was ultimately solved through a new option instead: #501

I guess my main feedback would be to split this PR into more commits and try to make it as clear what and why the changes made are made, so that one can as easily as possible follow the reasoning in a review

filipw01 · 2024-11-08T22:07:08Z

For the no split on number I decided to align with change-case library which seems to be the best at handling different edge cases

filipw01 · 2024-11-08T22:25:46Z

source/split-words.d.ts

-				? [...SkipEmptyWord<CurrentWord>, ...SplitWords<RemainingCharacters, FirstCharacter, FirstCharacter>]
-				// Case change: numeric to non-numeric, push word
+				// Split on number: push word
+				? Options['splitOnNumber'] extends true


When there's a numeric/non-numeric case change I added and used a new option splitOnNumber which depending on how it is set will either

When set to true - Like before split words on number

When set to false - concat to current word

filipw01 · 2024-11-08T22:29:32Z

source/screaming-snake-case.d.ts

 @category Template literal
-*/
-export type ScreamingSnakeCase<Value> = Value extends string
-	? IsScreamingSnakeCase<Value> extends true


I can bring this back, but I believe it shouldn't be necessary, especially that we don't use it for other things like snake case or kebab case

filipw01 · 2024-11-08T22:31:42Z

test-d/kebab-case.ts

+const kebabFromMixed2: KebabCase<'parseHTML'> = 'parse-html';
+expectType<'parse-html'>(kebabFromMixed2);
+
+const kebabFromMixed3: KebabCase<'parseHTMLItem'> = 'parse-html-item';
+expectType<'parse-html-item'>(kebabFromMixed3);
+
+const kebabFromNumberInTheMiddleSplitOnNumber: KebabCase<'foo2bar'> = 'foo-2-bar';
+expectType<'foo-2-bar'>(kebabFromNumberInTheMiddleSplitOnNumber);
+
+const kebabFromNumberInTheMiddleSplitOnNumberEdgeCase: KebabCase<'foO2Bar'> = 'fo-o-2-bar';
+expectType<'fo-o-2-bar'>(kebabFromNumberInTheMiddleSplitOnNumberEdgeCase);
+
+const kebabFromNumberInTheMiddleSplitOnNumberEdgeCase2: KebabCase<'foO2bar'> = 'fo-o-2-bar';
+expectType<'fo-o-2-bar'>(kebabFromNumberInTheMiddleSplitOnNumberEdgeCase2);
+
+const kebabFromNumberInTheMiddleNoSplitOnNumber: KebabCase<'foo2bar', {splitOnNumber: false}> = 'foo2bar';
+expectType<'foo2bar'>(kebabFromNumberInTheMiddleNoSplitOnNumber);
+
+const kebabFromNumberInTheMiddleNoSplitOnNumberEdgeCase: KebabCase<'foo2Bar', {splitOnNumber: false}> = 'foo2-bar';
+expectType<'foo2-bar'>(kebabFromNumberInTheMiddleNoSplitOnNumberEdgeCase);
+
+const kebabFromNumberInTheMiddleNoSplitOnNumberEdgeCase2: KebabCase<'foO2bar', {splitOnNumber: false}> = 'fo-o2bar';
+expectType<'fo-o2bar'>(kebabFromNumberInTheMiddleNoSplitOnNumberEdgeCase2);
+
+const kebabFromNumberInTheMiddleNoSplitOnNumberEdgeCase3: KebabCase<'FOO22Bar', {splitOnNumber: false}> = 'foo22-bar';
+expectType<'foo22-bar'>(kebabFromNumberInTheMiddleNoSplitOnNumberEdgeCase3);


I added the same tests to all case types as well as some edge cases visible here. If you have any doubts about the implementation I can add more tests

filipw01 · 2024-11-08T22:32:44Z

source/kebab-case.d.ts

 // Simple

 const someVariable: KebabCase<'fooBar'> = 'foo-bar';
+const someVariableNoSplitOnNumber: KebabCase<'p2pNetwork', {splitOnNumber: false}> = 'p2p-network';


I added this new option on case changing types

filipw01 · 2024-11-08T22:34:27Z

source/delimiter-case.d.ts

-		: Parts extends [string]
-			? string
-			: '';
+type DelimiterCaseFromArray<


This gets the words split and inserts the delimited at the beginning and after every word

Like ['here', 'We', 'Go'] -> '#here#We#Go'

filipw01 · 2024-11-08T22:45:03Z

source/delimiter-case.d.ts

-	Delimiter
-	>
+ */
+export type DelimiterCase<Value, Delimiter extends string, Options extends SplitWordsOptions = {splitOnNumber: true}> = Value extends string


Here we

'hereWeGo' -> SplitWords -> ['here', 'We', 'Go']

['here', 'We', 'Go'] -> DelimiterCaseFromArray -> '#here#We#Go'

'#here#We#Go' -> RemoveFirstLetter -> 'here#We#Go'

'here#We#Go' -> Lowercase -> 'here#we#go'

filipw01 · 2024-11-08T22:49:07Z

@voxpelli At this point where all the commits are made I'd prefer not to do any git wizardry splitting into smaller commits. I left some comments for easier review. I hope this will be enough. If something is unclear let me know.

I tried to add more edge cases to avoid the whack a mole game

voxpelli · 2024-11-10T16:07:56Z

#975 is also touching some of these files. I will not have time to review either, just noting it

filipw01 · 2025-02-16T16:27:06Z

@sindresorhus any chance to move this forward?

sindresorhus · 2025-02-20T16:54:31Z

source/delimiter-case.d.ts

-	Delimiter
-	>
+ */
+export type DelimiterCase<Value, Delimiter extends string, Options extends SplitWordsOptions = {splitOnNumber: true}> = Value extends string


SplitWordsOptions = {splitOnNumber: true} will not allow us to add more options in the future, as if you specify one, you override the existing defaults.

Example: https://github.com/sindresorhus/type-fest/blob/7dfb307e3ecc0e7717de6880395f1de8715c82c1/source/paths.d.ts

sindresorhus · 2025-02-20T16:56:38Z

You need to resolve the merge conflict.

sindresorhus · 2025-02-20T16:59:42Z

And maybe splitOnNumber => splitOnNumbers?

test-d/delimiter-case.ts

source/delimiter-case.d.ts

som-sm

PR LGTM!

@filipw01 I've removed all formatting-related changes in word.d.ts in b3c49aa. Please give it a quick look to make sure I haven't accidentally messed anything up.

filipw01 · 2025-02-26T08:25:23Z

Looks good 😉

dasa · 2025-03-03T18:14:11Z

source/words.d.ts

+};
+
+type DefaultOptions = {
+	splitOnNumbers: true;


Should this default to false? 4.36.0 seems to be a breaking change since I have to set this to false to avoid errors using KebabCase.

filipw01 requested a review from voxpelli as a code owner August 7, 2024 22:03

filipw01 mentioned this pull request Aug 8, 2024

feat(toSnakeCase): add toSnakeCase remeda/remeda#818

Closed

4 tasks

filipw01 marked this pull request as draft August 27, 2024 13:06

filipw01 commented Nov 8, 2024

View reviewed changes

filipw01 marked this pull request as ready for review November 8, 2024 22:49

voxpelli mentioned this pull request Nov 10, 2024

export (Split)Words #975

Merged

sindresorhus requested changes Feb 20, 2025

View reviewed changes

sindresorhus requested a review from som-sm February 20, 2025 16:56

som-sm requested changes Feb 21, 2025

View reviewed changes

test-d/delimiter-case.ts Show resolved Hide resolved

source/delimiter-case.d.ts Outdated Show resolved Hide resolved

source/delimiter-case.d.ts Outdated Show resolved Hide resolved

filipw01 added 11 commits February 26, 2025 00:34

fix: improve delimiter cases

4981ee6

Add splitOnNumber option

6d99700

More tests

5b23441

Fix lint

f7f89ca

Fix xo autofix

775cafa

newline

1fd4ae9

Fix autofix made change

5614a70

Add more tests expose new option on individual helpers

315b0f2

More edge cases

82a2f30

simplify

ccbb3c1

make default options on per property basis instead of whole object

5bd9be0

filipw01 force-pushed the improve-delimiter-case branch from e983b73 to 5bd9be0 Compare February 25, 2025 23:51

add tests and change to tail recursive call

c2ba7b9

handle non union type

d133d18

filipw01 requested review from sindresorhus and som-sm February 26, 2025 00:14

filipw01 and others added 5 commits February 26, 2025 01:18

fix imports

96d2785

fix tests

164d076

style: fix formatting

0f91d67

style: remove formatting changes

b3c49aa

doc: improve JSDOC

a6ecfe9

som-sm approved these changes Feb 26, 2025

View reviewed changes

sindresorhus merged commit a463c30 into sindresorhus:main Feb 26, 2025
12 checks passed

dasa reviewed Mar 3, 2025

View reviewed changes

This was referenced Mar 3, 2025

DelimiterCase / SnakeCase / ScreamingSnakeCase / KebabCase: Fix default value for splitOnNumbers option #1073

Merged

KebabCasedProperties transforming : to -: #1074

Closed

Uh oh!

Conversation

filipw01 commented Aug 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

filipw01 commented Aug 27, 2024

Uh oh!

voxpelli commented Aug 27, 2024

Uh oh!

filipw01 commented Nov 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

filipw01 commented Nov 8, 2024

Uh oh!

voxpelli commented Nov 10, 2024

Uh oh!

filipw01 commented Feb 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sindresorhus commented Feb 20, 2025

Uh oh!

sindresorhus commented Feb 20, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

som-sm left a comment

Choose a reason for hiding this comment

Uh oh!

filipw01 commented Feb 26, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

filipw01 commented Aug 7, 2024 •

edited

Loading

filipw01 commented Nov 8, 2024 •

edited

Loading

filipw01 commented Feb 16, 2025 •

edited

Loading