형식 유틸리티 라이브러리 배포하기

타입 유틸리티 라이브러리란 무엇입니까?

// A type utility library exports types like:
export type DeepPartial<T> = T extends object
  ? { [K in keyof T]?: DeepPartial<T[K]> }
  : T;

프로젝트 구조

// tsconfig.json
{
  "compilerOptions": {
    "declaration": true,
    "emitDeclarationOnly": true,
    "outDir": "dist",
    "strict": true
  }
}

package.json을 사용하는 타입 전용 패키지

{
  "name": "@myorg/type-utils",
  "version": "1.0.0",
  "main": "dist/index.js",
  "types": "dist/index.d.ts",
  "sideEffects": false,
  "files": ["dist"]
}

선언 생성하기

# Build declarations
npx tsc
# dist/index.d.ts is generated

버전 관리 및 변경 로그

# Bump version
npm version minor
# Generate changelog with conventional-changelog or changesets

npm에 게시하기

npm login
npm publish --access public
# or for private: npm publish --access restricted

TypeScript 버전 호환성

// package.json peerDependencies
{
  "peerDependencies": {
    "typescript": ">=4.5"
  }
}

tsd로 타입 테스트하기

import { expectType } from "tsd";
import type { DeepPartial } from "@myorg/type-utils";

expectType<DeepPartial<{ a: { b: number } }>>({ a: {} });

TSDoc으로 문서화하기

/**
 * Makes all properties of T optional at every depth.
 * @example type A = DeepPartial<{ x: { y: number } }> // { x?: { y?: number } }
 */
export type DeepPartial<T> = ...

모노레포 배포

// Other package's package.json
{
  "dependencies": {
    "@myorg/type-utils": "workspace:*"
  }
}

복습: 타입 라이브러리 게시

빠른 확인

학습 내용