Публикация пакетов с типами
Публикуйте библиотеки с полноценными типами: создавайте .d.ts с помощью tsc, указывайте их в package.json, обрабатывайте экспорты ESM/CJS и проводите тестирование перед публикацией.
«Публикация пакетов с типами» — бесплатный урок TypeScript Academy на CoddyKit. Это урок 2 из 2. Ты можешь прочитать весь урок бесплатно ниже — а потом практиковать его прямо в браузере с встроенным редактором кода и ИИ-репетитором 24/7. Это часть пути обучения TypeScript Academy, и твой прогресс синхронизируется между веб-версией и приложением CoddyKit. Курс TypeScript Academy содержит 2 уроков всего.
Введение
Цель: опубликовать пакет с надёжной типизацией. Вы сгенерируете файлы .d.ts, правильно настроите package.json, обеспечите поддержку ESM/CJS с помощью exports и проверите всё с помощью 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/**/*"]
}Поле types и экспорт в package.json
Укажите корневое объявление в поле types. Для экспортов подпутей добавьте запись 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" }))Советы и подводные камни
Советы:
- Предпочитайте экспорты подпутей
exportsс отдельными записямиtypes. - Не экспортируйте внутренние типы или помечайте их как
@internal. - Используйте сценарий
prepare, чтобы выполнить сборку передnpm publish.
Проверка публикации типов
Быстрая проверка: какая минимальная корректная настройка нужна, чтобы предоставить типы?
Повторение
Повторение: генерируйте объявления с помощью tsc, настройте package.json (types/exports) и проверьте пакет в приложении-потребителе перед публикацией.
Часто задаваемые вопросы
Урок «Публикация пакетов с типами» бесплатный?
Да — полный текст урока «Публикация пакетов с типами» бесплатно доступен здесь в веб-версии. Чтобы практиковать его интерактивно (встроенный редактор кода и ИИ-репетитор 24/7) и разблокировать остальной курс TypeScript Academy, подпишись на CoddyKit PRO. Курс TypeScript Academy содержит 2 уроков всего.
Чему я научусь в уроке «Публикация пакетов с типами»?
Публикуйте библиотеки с полноценными типами: создавайте .d.ts с помощью tsc, указывайте их в package.json, обрабатывайте экспорты ESM/CJS и проводите тестирование перед публикацией. Ты практикуешь TypeScript Academy с помощью реального кода, который запускаешь прямо в браузере, и ИИ-репетитор 24/7 отвечает на твои вопросы во время урока.
Нужен ли мне опыт, чтобы начать TypeScript Academy?
Предыдущий опыт не требуется. TypeScript Academy на CoddyKit структурирован для всех уровней — от новичков до продвинутых, поэтому ты можешь начать отсюда или с самого начала и учиться в своем темпе. Это урок 2 из 2.
Сколько времени занимает урок «Публикация пакетов с типами»?
Большинство уроков CoddyKit занимают около 5–10 минут. Каждый из них компактный и интерактивный, поэтому ты постоянно делаешь прогресс и продолжаешь с того же места в веб-версии и приложении.
Можно ли писать и запускать код в этом уроке TypeScript Academy?
Да. Каждый урок TypeScript Academy включает встроенный редактор кода, поэтому ты пишешь и запускаешь реальный код прямо в браузере и получаешь моментальную обратную связь от AI — локальная установка не требуется.
Все уроки этого курса
- Основы .d.ts; export type и export
- Публикация пакетов с типами