Monorepo 与项目引用
创建工作区 Monorepo,并连接 TypeScript 项目引用,以实现快速增量构建和清晰的包间类型。
Monorepo 与项目引用 是 CoddyKit 上的免费 TypeScript Academy 课时。 这是第 1 节课,共 1 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 TypeScript Academy 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 TypeScript Academy 课程共包含 1 节课。
简介
目标:组织一个可扩展的单仓库。您将声明工作区,添加项目引用,并使用 tsc -b 构建增量输出。
- pnpm/yarn 工作区
- 复合项目
- 共享类型
工作区布局
一个简单的双包布局:共享(库)和应用(依赖共享包)。工作区会链接本地包。
# folder structure (for reference)
/monorepo
package.json
tsconfig.base.json
packages/
shared/
src/index.ts
package.json
tsconfig.json
app/
src/index.ts
package.json
tsconfig.json根工作区
声明工作区,以便包管理器链接本地依赖。使用 TS 构建模式添加 build/clean 脚本。
// package.json (root)
{
"name": "monorepo",
"private": true,
"workspaces": ["packages/*"],
"scripts": {
"build": "tsc -b packages/*",
"clean": "tsc -b packages/* --clean"
}
}共享包
将该库标记为复合项目。生成声明文件,让依赖方能够快速进行类型检查。
// packages/shared/tsconfig.json
{
"extends": "../../tsconfig.base.json",
"compilerOptions": {
"outDir": "dist",
"rootDir": "src",
"declaration": true,
"composite": true
},
"include": ["src"]
}
// packages/shared/src/index.ts
export interface User { id: string; name: string }
export const hello = (u: User) => `Hello, ${u.name}`应用包与引用
添加引用条目以依赖 shared。构建器会先编译 shared,然后编译 app。
// packages/app/tsconfig.json
{
"extends": "../../tsconfig.base.json",
"compilerOptions": {
"outDir": "dist",
"rootDir": "src",
"composite": true
},
"references": [
{ "path": "../shared" }
],
"include": ["src"]
}
// packages/app/src/index.ts
import { hello } from "shared"
console.log(hello({ id: "u1", name: "Ada" }))基础配置与提示
提示:
- 创建
tsconfig.base.json,存放共享的编译器选项。 - 使用与包名称对应的
paths映射。 - 运行
tsc -b --watch,进行本地增量开发。
引用要求检查
快速检查:每个被引用的包必须包含什么?
回顾
回顾:工作区会链接本地包;项目引用(复合项目 + 引用)能够实现快速、增量的 tsc -b 构建,并确保跨包类型可靠。
常见问题解答
「Monorepo 与项目引用」课时是免费的吗?
是的 — 「Monorepo 与项目引用」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 TypeScript Academy 课程的其余内容,请升级到 CoddyKit PRO。 TypeScript Academy 课程共包含 1 节课。
「Monorepo 与项目引用」这节课中我会学到什么?
创建工作区 Monorepo,并连接 TypeScript 项目引用,以实现快速增量构建和清晰的包间类型。 你通过在浏览器中直接运行的动手代码来练习 TypeScript Academy,全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 TypeScript Academy 需要有经验吗?
无需任何先前经验。CoddyKit 上的 TypeScript Academy 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 1 节课,共 1 节。
「Monorepo 与项目引用」课时需要多长时间?
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。
我能在这节 TypeScript Academy 课中编写并运行代码吗?
能。每节 TypeScript Academy 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。