live-typescript-monorepo - GitLite

KO | EN

gitlite — search

#javascript #ai #go #golang #android #machine-learning #nodejs #java #windows #kubernetes #pytorch #security #mcp #ios

live-typescript-monorepo

(★ 123)

Strategies for live-updating TypeScript types in monorepos

파일 탐색기

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

- - settings.json
- .gitignore
- package.json
- pnpm-lock.yaml
- pnpm-workspace.yaml
- tsconfig.base.json
- tsconfig.json
- - settings.json
- .gitignore
- package.json
- pnpm-lock.yaml
- pnpm-workspace.yaml
- tsconfig.base.json
- tsconfig.json
- - settings.json
- .gitignore
- package.json
- pnpm-lock.yaml
- pnpm-workspace.yaml
- tsconfig.base.json
- tsconfig.json
- - settings.json
- .gitignore
- package.json
- pnpm-lock.yaml
- pnpm-workspace.yaml
- tsconfig.base.json
- tsconfig.json
- - settings.json
- .gitignore
- package.json
- pnpm-lock.yaml
- pnpm-workspace.yaml
- tsconfig.base.json
- tsconfig.json
.gitignore
.prettierrc
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/colinhacks/live-typescript-monorepo

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

cd live-typescript-monorepo

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

2. Node.js

쉬움 추천

사전 준비물

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

├── pnpm-lock.yaml

이 명령어를 터미널에 그대로 입력해 실행하세요.

├── pnpm-workspace.yaml

이 명령어를 터미널에 그대로 입력해 실행하세요.

$ pnpm i # install

이 명령어를 터미널에 그대로 입력해 실행하세요.

pnpm test

이 명령어를 터미널에 그대로 입력해 실행하세요.

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

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

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Read the [associated blog post](https://colinhacks.com/essays/live-types-typescript-monorepo) for complete information.

# _Live types_ in TypeScript monorepos

In development, your TypeScript code should feel "alive". When you update your code in one file, the effects of that change should propogate to all files that import it.

This is true even for monorepos, where you may not be importing things from a file, but from a local package.

```diff
- import { Fish } from "../pkg-a/index";
+ import { Fish } from "pkg-a"
```

This repo contains a few strategies you can use to make your TypeScript monorepo feel more alive.

## Approaches

Each subdirectory contains a pnpm monorepo (`pnpm-workspace.yaml`) with two packages, `pkg-a` and `pkg-b`. **`pkg-b` has a dependency on `pkg-a`**. Each package has a `tsconfig.json` that extends a `tsconfig.base.json` in the root of the monorepo.

The file structure looks something like this:

```txt
.
├── package.json
├── packages
│   ├── pkg-a
│   │   ├── index.ts
│   │   ├── package.json
│   │   └── tsconfig.json
│   └── pkg-b
│       ├── index.ts
│       ├── package.json
│       └── tsconfig.json
├── pnpm-lock.yaml
├── pnpm-workspace.yaml
├── tsconfig.base.json
└── tsconfig.json
```

Let's break down the approaches. (Refer to the [associated blog post](https://colinhacks.com/essays/live-types-typescript-monorepo) for complete breakdowns.)

### `1. project-references`

Use TypeScript project references to link packages together. This has a lot of downsides and doesn't play nice with `node` or other tooling out of the box.

### `2. publishConfig`

Use `publishConfig` in `package.json` to specify `.ts` file in development and `.js` file in production.

### `3. tsconfig-paths`

Configure `compilerOptions.paths` in `tsconfig.json` to override resolution for local package names.

### `4. tshy-dev`

Using `tshy`'s `liveDev` mode to hard-link the `.ts` source code directly into `./dist/esm` and `./dist/commonjs` directories. This lets VS Code discover your live TypeScript source code without any additional `package.json` configuration.

### `5. custom-conditions`

**Recommended** User-defined conditional export in `package.json#exports` plus `customConditions` in `tsconfig.json`

## Usage

To play around with a particular approach, clone this repo and navigate to the appropriate subdirectory.

```sh
$ gh repo clone colinhacks/live-typescript-monorepo
$ cd live-typescript-monorepo
$ cd <subdir>  # tsconfig-paths, publishconfig, project-references, custom-conditions
```

Then run the following commands:

```sh
$ pnpm i                  # install
$ code .                  # open in VS Code
```

Once the project is open in VS Code, open `packages/pkg-a/index.ts` and `packages/pkg-b/index.ts`. When you change the definition of `Fish` in `pkg-a`, those changes should propagate immediately to `pkg-b` without a build step.

Each subdirectory also contains a `"test"` script that executes `pkg-b/index.ts`. (This won't work in `project-references`.) This should execute the latest `.ts` files for both `pkg-a` and `pkg-b`! Make some changes and see the effects.

```ts
pnpm test
```

Happy monorepo hacking!