Add `CamelCasedProps`, `CamelCasedPropsDeep` etc. types #179

wwwzbwcom · 2021-02-04T05:40:51Z

Hello, I am using CamelCase etc. for API types converting, but found it difficult to write a well-defined CamelCasedProps and CamelCasedPropsDeep (which can convert array etc.), so I add these type to make type-fest naming converting easier to use.

I think these types are similar and connected, so I add them in one PR

jamiebuilds · 2021-02-05T20:18:39Z

We were just talking about wanting something like this in type-fest. This would make the built-in casing types far more useful. I think API type conversions are one of the more common use cases and you're generally talking about object properties there.

ts41/camel-cased-props.d.ts

ts41/delimiter-cased-props-deep.d.ts

ts41/delimiter-cased-props.d.ts

sindresorhus · 2021-02-06T09:43:10Z

You need to add the types to the readme.

sindresorhus · 2021-02-06T09:44:01Z

I would go with CamelCasedProps => CamelCasedProperties

wwwzbwcom · 2021-02-07T03:36:11Z

@sindresorhus

You need to add the types to the readme.

I think they are already in REAME.md?

I would go with CamelCasedProps => CamelCasedProperties

renamed.

wwwzbwcom · 2021-02-15T17:13:23Z

@sindresorhus Hello, is there any more changes needed for this PR?

cluk3 · 2021-03-09T19:56:09Z

looks great, would be nice to have it merged! We are already using SnakeCasedProperties within my company codebase (I copied it from the PR) and it works just fine. One thing this is is not supporting though is having consecutive upper case letters, testGUILabel would become test_g_u_i_label.

ts41/snake-cased-properties.d.ts

sindresorhus · 2021-03-10T09:35:58Z

ts41/snake-cased-properties.d.ts

+
+@see SnakeCase
+@see SnakeCasedPropertiesDeep
+@example


Suggested change

@example

@example

SnakeCased don't have a newline after @example, which style should follow?

sindresorhus · 2021-03-10T09:36:09Z

ts41/snake-cased-properties.d.ts

+	userId: number;
+	userName: string;
+}
+const result: SnakeCasedProperties<User> = {


Suggested change

const result: SnakeCasedProperties<User> = {

const result: SnakeCasedProperties<User> = {

ts41/snake-cased-properties.d.ts

sindresorhus · 2021-03-10T09:37:27Z

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

+import {expectType} from 'tsd';
+
+declare const foo: PascalCasedPropertiesDeep<{ helloWorld: { fooBar: string } }>;
+expectType<{ HelloWorld: { FooBar: string } }>(foo);


Suggested change

expectType<{ HelloWorld: { FooBar: string } }>(foo);

expectType<{HelloWorld: {FooBar: string}}>(foo);

sindresorhus · 2021-03-10T09:39:15Z

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

+*/
+export type CamelCasedPropertiesDeep<Value> = Value extends Function
+	? Value
+	: Value extends Array<infer U>


Suggested change

: Value extends Array<infer U>

: Value extends ReadonlyArray<infer U>

?

sindresorhus · 2021-03-10T09:40:36Z

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

+
+```
+*/
+export type CamelCasedPropertiesDeep<Value> = Value extends Function


Suggested change

export type CamelCasedPropertiesDeep<Value> = Value extends Function

export type CamelCasedPropertiesDeep<ValueType> = ValueType extends Function

CamelCased<> used Value, Is it better to keep it same as CamelCased?

sindresorhus · 2021-03-10T09:41:26Z

Most of the nitpick changes I just commented on applies to all types, not just the ones I commented on.

sindresorhus · 2021-03-10T09:42:14Z

@kainiedziela Could you help review?

kainiedziela · 2021-03-10T10:53:11Z

So usually what we do with -deep types is that we ensure that as many different cases are covered - not only function, objects and arrays, but maps and sets and readonly types of all of those things as well.

While I understand that in this instance perhaps being so dilligent about covering all cases may not make as much sense I do think that we should document exactly what get's recursed into what does not.

@wwwzbwcom looking at PartialDeep and it's test suite may clarify my ramblings.

wwwzbwcom · 2021-03-12T05:47:17Z

Most of the nitpick changes I just commented on applies to all types, not just the ones I commented on.

@sindresorhus @kainiedziela
maybe we could add a .prettierconfig or code style lint guideline?
It's difficult to find out which style I should follow when contribute to it :(

sindresorhus · 2021-03-22T08:12:56Z

Thanks :)

jpilkahn · 2021-03-23T07:18:35Z

Just came across this recent merge while consulting the documentation for unrelated reasons.
These types will be immensely useful! 😮

Thanks :)

Indeed.
To the both of you, @wwwzbwcom, @sindresorhus.

Having said that, may I suggest addition of equivalent property manipulation types for the inbuilt intrinsic string manipulation types?
Would be a natural fit, I feel.

Addendum, for the sake of completeness:
It is in the nature of collaborative spirit to include the offer to do the chore and open the PR myself (it'd just be a copy/paste/replace job anyway).

sindresorhus · 2021-03-23T07:53:58Z

Having said that, may I suggest addition of equivalent property manipulation types for the inbuilt intrinsic string manipulation types?

In general, it's better to open a new issue with your proposal (please elaborate more) than commenting on a done PR.

jonjrodriguez · 2021-03-31T03:56:41Z

How am I meant to import these types? When I try

import { CamelCasedPropertiesDeep } from 'type-fest/camel-cased-properties-deep'

it fails eslint with

Unable to resolve path to module 'type-fest/camel-cased-properties-deep'. eslintimport/no-unresolved)

wwwzbwcom changed the title ~~feat: add xxx-cased-props and xxx-cased-props-deep typings~~ Add CamelCasedProps, CamelCasedPropsDeep etc. types Feb 4, 2021

jamiebuilds reviewed Feb 5, 2021

View reviewed changes

ts41/camel-cased-props.d.ts Outdated Show resolved Hide resolved

sindresorhus requested changes Feb 6, 2021

View reviewed changes

ts41/delimiter-cased-props-deep.d.ts Outdated Show resolved Hide resolved

ts41/delimiter-cased-props-deep.d.ts Outdated Show resolved Hide resolved

ts41/delimiter-cased-props.d.ts Outdated Show resolved Hide resolved

wwwzbwcom requested a review from sindresorhus February 7, 2021 03:36

sindresorhus requested changes Mar 10, 2021

View reviewed changes

sindresorhus requested a review from voxpelli March 10, 2021 09:41

wwwzbwcom and others added 14 commits March 12, 2021 14:12

feat: add xxx-cased-props and xxx-cased-props-deep typings

9e886be

doc: update README.md

d3bc9fb

chore: rename XXXCasedProps to XXXCasedProperties

bd43b8f

fix: make all changes single quote

0f82414

fix: return original type when non-deep converting array

46ecc07

fix: use descriptive type name

4c0c208

chore: use tab indention

f32e25d

fix: add judgement for function

fc60ee0

fix: add test for function

4c34422

chore: fix lint problem

9229a2f

chore: rename file names

a344d22

Update readme.md

a2be1fd

fix: fix code style and comment style problems

7feb8bd

fix: add checking with set

12e79f1

sindresorhus added 25 commits March 22, 2021 15:03

Update delimiter-cased-properties-deep.ts

a2dcc45

Update delimiter-cased-properties.ts

08e9f7a

Update kebab-cased-properties-deep.ts

99478cf

Update kebab-cased-properties.ts

99c85b0

Update pascal-cased-properties-deep.ts

6851e87

Update pascal-cased-properties.ts

88f21b1

Update snake-cased-properties-deep.ts

00597a1

Update snake-cased-properties.ts

8a8b7c1

Update camel-cased-properties-deep.d.ts

e800ff4

Update camel-cased-properties.d.ts

63abd7a

Update delimiter-cased-properties-deep.d.ts

abb7779

Update delimiter-cased-properties.d.ts

febcd45

Update kebab-cased-properties-deep.d.ts

ab47737

Update kebab-cased-properties.d.ts

14e8c7d

Update pascal-cased-properties-deep.d.ts

afcc812

Update pascal-cased-properties.d.ts

bb94c63

Update snake-cased-properties-deep.d.ts

3ad02a4

Update snake-cased-properties.d.ts

8f36e3a

Update camel-cased-properties-deep.d.ts

8218fbe

Update camel-cased-properties.d.ts

403fa33

Update delimiter-cased-properties-deep.d.ts

2de59f0

Update delimiter-cased-properties.d.ts

818788b

Update kebab-cased-properties-deep.d.ts

c5389b7

Update kebab-cased-properties.d.ts

8c6dd2d

Merge branch 'main' into main

53bc936

sindresorhus merged commit c043c25 into sindresorhus:main Mar 22, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `CamelCasedProps`, `CamelCasedPropsDeep` etc. types #179

Add `CamelCasedProps`, `CamelCasedPropsDeep` etc. types #179

wwwzbwcom commented Feb 4, 2021

jamiebuilds commented Feb 5, 2021

sindresorhus commented Feb 6, 2021

sindresorhus commented Feb 6, 2021

wwwzbwcom commented Feb 7, 2021

wwwzbwcom commented Feb 15, 2021

cluk3 commented Mar 9, 2021 •

edited

sindresorhus Mar 10, 2021

wwwzbwcom Mar 12, 2021

sindresorhus Mar 10, 2021

sindresorhus Mar 10, 2021

sindresorhus Mar 10, 2021

sindresorhus Mar 10, 2021

wwwzbwcom Mar 12, 2021

sindresorhus commented Mar 10, 2021

sindresorhus commented Mar 10, 2021

kainiedziela commented Mar 10, 2021 •

edited

wwwzbwcom commented Mar 12, 2021

sindresorhus commented Mar 22, 2021

jpilkahn commented Mar 23, 2021

sindresorhus commented Mar 23, 2021

jonjrodriguez commented Mar 31, 2021

	const result: SnakeCasedProperties<User> = {

	const result: SnakeCasedProperties<User> = {

	expectType<{ HelloWorld: { FooBar: string } }>(foo);
	expectType<{HelloWorld: {FooBar: string}}>(foo);

	: Value extends Array<infer U>
	: Value extends ReadonlyArray<infer U>

	export type CamelCasedPropertiesDeep<Value> = Value extends Function
	export type CamelCasedPropertiesDeep<ValueType> = ValueType extends Function

Add CamelCasedProps, CamelCasedPropsDeep etc. types #179

Add CamelCasedProps, CamelCasedPropsDeep etc. types #179

Conversation

wwwzbwcom commented Feb 4, 2021

jamiebuilds commented Feb 5, 2021

sindresorhus commented Feb 6, 2021

sindresorhus commented Feb 6, 2021

wwwzbwcom commented Feb 7, 2021

wwwzbwcom commented Feb 15, 2021

cluk3 commented Mar 9, 2021 • edited

sindresorhus Mar 10, 2021

Choose a reason for hiding this comment

wwwzbwcom Mar 12, 2021

Choose a reason for hiding this comment

sindresorhus Mar 10, 2021

Choose a reason for hiding this comment

sindresorhus Mar 10, 2021

Choose a reason for hiding this comment

sindresorhus Mar 10, 2021

Choose a reason for hiding this comment

sindresorhus Mar 10, 2021

Choose a reason for hiding this comment

wwwzbwcom Mar 12, 2021

Choose a reason for hiding this comment

sindresorhus commented Mar 10, 2021

sindresorhus commented Mar 10, 2021

kainiedziela commented Mar 10, 2021 • edited

wwwzbwcom commented Mar 12, 2021

sindresorhus commented Mar 22, 2021

jpilkahn commented Mar 23, 2021

sindresorhus commented Mar 23, 2021

jonjrodriguez commented Mar 31, 2021

Add `CamelCasedProps`, `CamelCasedPropsDeep` etc. types #179

Add `CamelCasedProps`, `CamelCasedPropsDeep` etc. types #179

cluk3 commented Mar 9, 2021 •

edited

kainiedziela commented Mar 10, 2021 •

edited