TypeScript Template

Get Started by TS Template

package.json main/exports settings

settings main

{
  ...
  "main": "./dist/index.cjs",
  "module": "./dist/index.mjs",
  "types": "./dist/index.d.ts",
  ...
}

settings exports

{
  ...
  "exports": {
    "import": "./dist/index.mjs",
    "require": "./dist/index.cjs",
    "types": "./types/index.d.ts"
  },
  ...
}

Install pnpm

• pnpm.io/zh-TW/installation

corepack enable pnpm

# corepack prepare pnpm@latest-9 --activate
# corepack use pnpm@latest-9
# corepack prepare pnpm@latest-10 --activate
# corepack use pnpm@latest-10

corepack prepare [email protected] --activate
corepack use [email protected]

# clean local corepack cache
corepack cache clean


# Cannot find matching keyid: {"signatures":[{"sig":"MEQCIGfJsZcWOYet7N9s+gixdrVR7NuxXRagWTDp3...
# use
npm install --global corepack@latest

use pnpm

pnpm -v # 10.0.0
pnpm install --frozen-lockfile

Git commit use commitizen

# 輸入 git commit 出現 commitizen 選項
git commit

? Select the type of change that you're committing: (Use arrow keys)
❯ feat:     A new feature 
  fix:      A bug fix 
  docs:     Documentation only changes 
  style:    Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons,
 etc) 
  refactor: A code change that neither fixes a bug nor adds a feature 
  perf:     A code change that improves performance 

Jest

unit test

# src/**.(spec|test).ts
pnpm test
# or
pnpm test:watch 

• Unit Test Web Report, port:9487

  pnpm test:web

• Coverage Web Report, port:9488

  pnpm test:cov:web

e2e test

# e2e-spec
pnpm test:e2e
# or
pnpm test:e2e:watch

• E2E Test Web Report, port:9477

  pnpm test:e2e:web

Release get CHANGELOG.md by standard-version

# First Release
# npx
npx standard-version -t '' --first-release

## Release patch
npx standard-version -t '' --release-as patch
# dry-run
npx standard-version -t '' --release-as patch --dry-run

## Release minor
npx standard-version -t '' --release-as minor
# dry-run
npx standard-version -t '' --release-as minor --dry-run

## Release major
npx standard-version -t '' --release-as major
# dry-run
npx standard-version -t '' --release-as major --dry-run

基礎環境建置

.npmrc, .nvmrc

husky

pnpm add -wD husky

pnpm exec husky init

Auto commit

• commitlint
• cz-conventional-changelog
• commitizen
• ~~git-cz~~

# pnpm add -D cz-conventional-changelog @commitlint/cz-commitlint @commitlint/config-conventional git-cz @commitlint/cli commitizen

pnpm add -D cz-conventional-changelog @commitlint/cz-commitlint @commitlint/config-conventional @commitlint/cli commitizen