furkanilgenci / undefined

A project to turn a file of JSON responses into TypeScript types

undefined

A project to turn a file of JSON responses into TypeScript types

Warning on code

I haven't really tried to organize this code. I made this code strictly as i learned more about the problem space. So the code looks like exploratory code, not production ready code.

To me, it seems like there is going to be a several pass compiler for this to be a real deal here.

I am unsure how much i want to pursue this beyond my needs

My needs have been met, i am unsure if I want to pursue this much further.

If anyone is interested in this, i can certainly help you get ramped up, whisper me twitter

Union Collapsing is really hard...

Its currently disabled because its creating incorrect types. But i think i am pretty dang close to it being correct.

Why create this?

I have a new database at Netflix with +100 unique events without definitions. I will define them...

Here is a reason for why you could use it:

1. You have too many JSON objects to develop types for other than naming.
2. You may have enums that need to get pulled out.
3. You want as compact possible representation

How To Use

1. Clone

   git clone [email protected]:ThePrimeagen/undefined.git
   

2. Dependency installation

   yarn install
   

3. Have a file filled with json responses (check out out)

4. The data can be handed in a few ways

   cat <jsons_here> | npx ts-node src/undefined.ts stdin
   npx ts-node src/undefined.ts <json_here>
   

5. You want to save this to a file?

   npx ts-node src/undefined.ts <json_here> > types.d.ts
   

Enums

You can specify what fields need to be lifted into enums. I make the assumption that enums are likely string values (though there is a case for me to fix this, PRs will be merged with little regard)

npx ts-node src/undefined.ts <json_here> --enums Foo,Bar > types.d.ts

This will take any top level fields on objects and attempt to pull out the values, convert it into an enum, put at top of definitions, and replace their type (usually string) as the enum.

There is an issue

Fix it and make a PR. The code is shitty because I rage wrote it all in ~1 hour on twitch.

ThePrimeagen

Support

Github sponsor or twitch prime babe!