undefined - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #typescript #golang #docker #macos #nodejs #java #awesome #vue #pytorch #security #openai #open-source

undefined

(★ 328)

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

파일 탐색기

최종 버전 다운로드 (.zip)

- - config.collapse.json
  - config.collapse.ts
  - config.export.declare.json
  - config.export.declare.ts
  - config.json
  - config.name.json
  - config.name.ts
  - config.sumtype.json
  - config.sumtype.ts
  - create-data.ts
  - no-config.2.ts
  - no-config.4.ts
  - run.ts
  - undefined.spec.ts
- collapse.ts
- config.ts
- enum.ts
- file.ts
- logger.ts
- sum-types.ts
- types.ts
- undefined-runner.ts
- undefined.ts
- unions.ts
- utils.ts
.gitignore
.prettierignore
generate
jest.config.ts
package.json
prettier.config.js
README.md
tsconfig.json
yarn.lock

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/ThePrimeagen/undefined

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd undefined

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

yarn install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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 git@github.com: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](https://twitch.tv/ThePrimeagen)

## Support

Github sponsor or twitch prime babe!