发布带类型的包
发布具备一流类型支持的库：使用 tsc 生成 .d.ts，将 package.json 指向这些文件，处理 ESM/CJS 导出，并在发布前运行测试。
发布带类型的包 是 CoddyKit 上的免费 TypeScript Academy 课时。 这是第 2 节课，共 2 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 TypeScript Academy 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 TypeScript Academy 课程共包含 2 节课。
简介
目标：发布一个具有完善类型声明的包。您将生成 .d.ts 文件，正确配置 package.json，通过 exports 支持 ESM/CJS，并在示例应用中使用 tsc --noEmit 进行验证。
- 生成声明文件
- 指定
types（或为每个入口指定exports） - 发布前测试
生成声明文件
启用 declaration 以生成.d.ts。使用专用的构建配置，以保持应用的 tsconfig 严格且整洁。
// tsconfig.build.json
{
"compilerOptions": {
"target": "ES2020",
"module": "ESNext",
"declaration": true,
"emitDeclarationOnly": false,
"outDir": "dist",
"rootDir": "src",
"stripInternal": true
},
"include": ["src/**/*"]
}package.json 类型与导出
将 types 指向根声明文件。对于子路径导出，请包含一个类型条目，以便编辑器解析每个模块的 .d.ts。
// package.json
{
"name": "@acme/widgets",
"version": "1.0.0",
"type": "module",
"main": "./dist/index.cjs",
"module": "./dist/index.js",
"types": "./dist/index.d.ts",
"exports": {
".": {
"types": "./dist/index.d.ts",
"import": "./dist/index.js",
"require": "./dist/index.cjs"
},
"./utils": {
"types": "./dist/utils.d.ts",
"import": "./dist/utils.js",
"require": "./dist/utils.cjs"
}
}
}源代码与 .d.ts
确保公共 API 具有完善的类型。声明文件应映射源代码签名，以便使用者获得自动补全和检查。
// src/index.ts
export interface Widget { id: string; name: string }
export function greet(w: Widget): string { return `Hello, ${w.name}` }
// dist/index.d.ts (emitted)
export interface Widget { id: string; name: string }
export declare function greet(w: Widget): string
在使用方项目中测试
发布前，请在一个使用 tsc --noEmit 的小型使用方项目中进行测试。对于无效用法，应得到正确的错误。
// consumer/tsconfig.json
{
"compilerOptions": { "strict": true, "target": "ES2020", "module": "ESNext" },
"include": ["./src"]
}
// consumer/src/app.ts
import { greet } from "@acme/widgets"
// Type checks in the consumer
console.log(greet({ id: "w1", name: "Ada" }))
// @ts-expect-error: missing name
// console.log(greet({ id: "w1" }))提示与陷阱
提示：
- 优先使用带有各入口
types的子路径exports。 - 不要导出内部类型，或使用
@internal标记。 - 使用
prepare脚本在npm publish之前进行构建。
发布类型检查
快速检查：要对外提供类型，最小的正确配置是什么？
回顾
回顾：使用 tsc 生成声明文件，配置 package.json（types/exports），并在发布前于使用方应用中进行验证。
常见问题解答
「发布带类型的包」课时是免费的吗？
是的 — 「发布带类型的包」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 TypeScript Academy 课程的其余内容，请升级到 CoddyKit PRO。 TypeScript Academy 课程共包含 2 节课。
「发布带类型的包」这节课中我会学到什么？
发布具备一流类型支持的库：使用 tsc 生成 .d.ts，将 package.json 指向这些文件，处理 ESM/CJS 导出，并在发布前运行测试。 你通过在浏览器中直接运行的动手代码来练习 TypeScript Academy，全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 TypeScript Academy 需要有经验吗？
无需任何先前经验。CoddyKit 上的 TypeScript Academy 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。 这是第 2 节课，共 2 节。
「发布带类型的包」课时需要多长时间？
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。
我能在这节 TypeScript Academy 课中编写并运行代码吗？
能。每节 TypeScript Academy 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。