0Pricing
TypeScript Academy · Lekcja

Publikowanie pakietów z typami

Publikowanie bibliotek z pełnym wsparciem typów: generowanie .d.ts przez tsc, wskazywanie ich w package.json, obsługa eksportów ESM/CJS i testowanie przed publikacją

Publikowanie pakietów z typami to bezpłatna lekcja TypeScript Academy na CoddyKit. To lekcja 2 z 2. Możesz przeczytać całą lekcję poniżej za darmo — a potem ćwiczyć ją interaktywnie w przeglądarce z wbudowanym edytorem kodu i tutorem AI dostępnym 24/7. To część ścieżki edukacyjnej TypeScript Academy, a Twój postęp synchronizuje się między webem a aplikacją CoddyKit. Kurs TypeScript Academy zawiera 2 lekcji w sumie.

Wprowadzenie

Cel: Opublikować pakiet z kompletnymi deklaracjami typów. Należy generować pliki .d.ts, poprawnie skonfigurować package.json, obsługiwać ESM/CJS za pomocą exports oraz zweryfikować wszystko poleceniem tsc --noEmit w przykładowej aplikacji.

  • Generowanie deklaracji
  • Wskazanie types (lub exports dla poszczególnych punktów wejścia)
  • Testowanie przed publikacją

Generowanie deklaracji

Należy włączyć declaration, aby generować pliki .d.ts. Warto używać osobnej konfiguracji kompilacji, aby konfiguracja tsconfig aplikacji pozostała rygorystyczna i przejrzysta.

// tsconfig.build.json
{
  "compilerOptions": {
    "target": "ES2020",
    "module": "ESNext",
    "declaration": true,
    "emitDeclarationOnly": false,
    "outDir": "dist",
    "rootDir": "src",
    "stripInternal": true
  },
  "include": ["src/**/*"]
}

types/exports w package.json

types należy wskazać na główną deklarację. W przypadku eksportów podścieżek trzeba dodać wpis types, aby edytory rozpoznawały pliki .d.ts dla poszczególnych modułów.

// 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"
    }
  }
}

Źródło a .d.ts

Należy zadbać o poprawne typowanie publicznego API. Deklaracje odzwierciedlają sygnatury źródłowe, dzięki czemu użytkownicy pakietu otrzymują autouzupełnianie i sprawdzanie typów.

// 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

Testowanie w projekcie użytkownika

Przed publikacją należy przetestować pakiet w niewielkim projekcie użytkownika za pomocą tsc --noEmit. Dla nieprawidłowego użycia powinny pojawiać się właściwe błędy.

// 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" }))

Wskazówki i pułapki

Wskazówki:

  • Warto preferować eksporty podścieżek exports z osobnym types dla każdego punktu wejścia.
  • Typy wewnętrzne powinny pozostać nieeksportowane lub być oznaczone jako @internal.
  • Należy używać skryptu prepare, aby wykonać kompilację przed npm publish.

Sprawdzenie publikowania typów

Szybkie sprawdzenie: Jaka jest minimalna poprawna konfiguracja udostępniania typów?

Podsumowanie

Podsumowanie: Należy generować deklaracje za pomocą tsc, poprawnie skonfigurować package.json (types/exports) i zweryfikować pakiet w aplikacji użytkownika przed publikacją.

Często zadawane pytania

Czy lekcja „Publikowanie pakietów z typami” jest bezpłatna?

Tak — pełny tekst „Publikowanie pakietów z typami” jest dostępny za darmo tutaj w sieci. Aby ćwiczyć ją interaktywnie (wbudowany edytor kodu i tutor AI dostępny 24/7) i odblokować resztę kursu TypeScript Academy, przejdź na CoddyKit PRO. Kurs TypeScript Academy zawiera 2 lekcji w sumie.

Co nauczysz się w „Publikowanie pakietów z typami”?

Publikowanie bibliotek z pełnym wsparciem typów: generowanie .d.ts przez tsc, wskazywanie ich w package.json, obsługa eksportów ESM/CJS i testowanie przed publikacją Ćwiczysz TypeScript Academy z praktycznym kodem, który uruchamiasz bezpośrednio w przeglądarce, a tutor AI dostępny 24/7 odpowiada na Twoje pytania podczas pracy nad lekcją.

Czy potrzebuję doświadczenia, aby zacząć TypeScript Academy?

Nie wymagamy żadnego doświadczenia. TypeScript Academy w CoddyKit jest strukturyzowany dla początkujących i zaawansowanych użytkowników, więc możesz zacząć tutaj lub od początku i uczyć się w swoim tempie. To lekcja 2 z 2.

Ile czasu zajmuje lekcja „Publikowanie pakietów z typami”?

Większość lekcji CoddyKit trwa około 5–10 minut. Każda lekcja to mały, interaktywny krok, dzięki czemu robisz systematyczne postępy i zawsze wracasz dokładnie do tego samego miejsca — na webie i w aplikacji.

Czy mogę pisać i uruchamiać kod w tej lekcji TypeScript Academy?

Tak. Każda lekcja TypeScript Academy zawiera wbudowany edytor kodu, więc piszesz i uruchamiasz prawdziwy kod bezpośrednio w przeglądarce i od razu otrzymujesz sprzężenie zwrotne od AI — bez konfiguracji na komputerze.

Wszystkie lekcje w tym kursie

  1. Podstawy .d.ts; export type a export
  2. Publikowanie pakietów z typami
← Powrót do TypeScript Academy