dwkim 0.0.16 → 0.0.17

package/.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

package/.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.1.1/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

package/.github/workflows/main.yml

@@ -0,0 +1,21 @@
+name: CI - lint & build
+on:
+  push:
+    branches:
+      - '**'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 9
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'pnpm'
+
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm run lint && pnpm run build

package/.github/workflows/publish.yml

@@ -0,0 +1,36 @@
+name: Publish
+on:
+  workflow_run:
+    workflows: [CI - lint & build]
+    branches: [main]
+    types: [completed]
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  publish:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 9
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20.x
+          cache: 'pnpm'
+
+      - run: pnpm install --frozen-lockfile
+      - name: Create Release Pull Request or Publish
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          publish: pnpm publish --no-git-checks
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# dwkim
+
+## 0.0.3
+
+### Patch Changes
+
+- e433534: docs: README.md 및 .changeset/config.json 업데이트
+
+## 0.0.2
+
+### Patch Changes
+
+- 1cf9909: chore: @changesets/cli 추가
+- 1cf9909: chore: tsx 및 dev 스크립트 추가

package/README.md

@@ -0,0 +1,257 @@
+# NPM 패키지 배포 가이드
+
+이 문서는 [Blazing Fast Tips: Publishing to NPM](https://youtu.be/eh89VE3Mk5g?si=oXgStRKeVp8GBl7c) 영상의 최신 TypeScript 라이브러리 개발 및 NPM 배포 워크플로우를 실습 중심으로 정리한 것입니다.
+
+## TL;DR
+
+빠른 NPM 패키지 배포를 위한 주요 커맨드 요약:
+
+- 프로젝트 초기화:  
+  `npm init -y`
+- Git 초기화:  
+  `git init`
+- TypeScript 설정:  
+  `pnpm add -D typescript`  
+  `pnpm exec tsc --init`
+
+- 빌드 도구(tsup) 설치:  
+  `pnpm add -D tsup`
+- 빌드:  
+  `pnpm run build`
+- 타입 검사:  
+  `pnpm run lint`
+- Changesets 설치/초기화:  
+  `pnpm add -D @changesets/cli`  
+  `pnpm exec changeset init`
+- 변경점 기록:  
+  `pnpm exec changeset`
+- NPM 배포(수동):  
+  `pnpm publish`
+
+---
+
+## 1. 프로젝트 초기화
+
+```bash
+npm init # 또는 npm init -y (기본값 자동입력)
+```
+
+- `package.json`에서 `"name"`, `"license"` 등 기본 정보 지정
+- 예시
+  ```json
+  {
+    "name": "dwkim",
+    "version": "0.0.1",
+    "description": "this",
+    "license": "MIT",
+    "author": "dannyworks102@gmail.com",
+    "type": "commonjs",
+    "main": "src/index.ts"
+  }
+  ```
+
+---
+
+## 2. Git 초기화 및 .gitignore 작성
+
+```bash
+git init
+```
+
+- `.gitignore` 파일 생성:
+
+```
+node_modules
+dist
+```
+
+---
+
+## 3. TypeScript 설치 및 설정
+
+```bash
+pnpm add -D typescript
+pnpm exec tsc --init
+```
+
+- `tsconfig.json`에 아래 옵션 추가/수정:
+
+```json
+{
+  "compilerOptions": {
+    "noUncheckedIndexedAccess": true,
+    "noEmit": true
+  }
+}
+```
+
+---
+
+## 4. 소스 코드 작성
+
+예시: `src/index.ts`
+
+```typescript
+export function add(a: number, b: number): number {
+  return a + b;
+}
+```
+
+---
+
+## 5. 빌드 도구(tsup) 설치 및 빌드 스크립트 추가
+
+```bash
+pnpm add -D tsup
+```
+
+- `package.json`에 빌드 스크립트 추가:
+
+```json
+{
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm",
+    "lint": "tsc"
+  }
+}
+```
+
+```bash
+pnpm run build
+```
+
+- 결과: `dist/index.js`, `dist/index.mjs`, `dist/index.d.ts` 등 생성
+
+---
+
+## 6. package.json 진입점 지정
+
+```json
+{
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts"
+}
+```
+
+---
+
+## 7. 타입 검사
+
+```bash
+pnpm run lint
+```
+
+---
+
+## 8. Changesets로 버전/릴리즈 노트 관리 (실무 워크플로우)
+
+```bash
+pnpm add -D @changesets/cli
+pnpm exec changeset init
+```
+
+- `.changeset/` 폴더는 반드시 **git에 커밋**해야 합니다. (gitignore에 추가하면 안 됨)
+- 변경사항이 있을 때마다 아래 명령어로 변경점(md 파일)을 기록합니다 (e.g. PR 할때마다)
+
+```bash
+pnpm exec changeset # 변경점 기록(md 파일 생성)
+```
+
+- 릴리즈(버전 업데이트) 준비 시 (c.f. main 브랜치에서)
+
+```bash
+pnpm exec changeset version # package.json, CHANGELOG.md 자동 업데이트
+```
+
+- 배포(수동) (c.f. main 브랜치에서)
+
+```bash
+pnpm exec changeset publish
+```
+
+> **실무 워크플로우 요약**
+>
+> - PR마다 `pnpm exec changeset`으로 변경점만 기록
+> - main 브랜치에서 `changeset version` & `changeset publish`를 실행하거나,
+> - GitHub Actions에서 자동화(merge → version/publish)하는 것이 일반적입니다.
+
+---
+
+## 9. GitHub Actions로 CI/CD 자동화
+
+### `.github/workflows/main.yml` (테스트/빌드)
+
+```yaml
+name: CI
+on: [push]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v3
+        with:
+          version: 8
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm run lint
+      - run: pnpm run build
+```
+
+### `.github/workflows/publish.yml` (배포)
+
+```yaml
+name: Release
+on:
+  push:
+    branches: [main]
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    concurrency: release
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v3
+        with:
+          version: 8
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: 'https://registry.npmjs.org'
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm run build
+      - uses: changesets/action@v1
+        with:
+          publish: pnpm publish --no-git-checks
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+```
+
+- NPM_TOKEN은 GitHub 레포지토리의 Secrets에 등록 필요
+
+---
+
+## 10. NPM 배포 (자동화/수동 워크플로우)
+
+- **자동화:**
+
+  1. PR마다 `pnpm exec changeset`으로 변경점 기록
+  2. main 브랜치 머지 → GitHub Actions가 자동으로 `changeset version` & `changeset publish` 실행
+  3. NPM에 자동 배포
+
+- **수동:**
+  1. 변경점 기록 후,
+  2. `pnpm exec changeset version`
+  3. `pnpm exec changeset publish`
+
+---
+
+## 참고
+
+- [예제 저장소 ↗]
+- [Changesets 공식 문서 ↗]
+- [tsup 공식문서 ↗]
+- [pnpm 공식문서 ↗]

package/package.json

@@ -1,42 +1,25 @@
 {
   "name": "dwkim",
-  "version": "0.0.16",
-  "type": "module",
-  "author": "Dongwook Kim",
-  "exports": {
-    ".": "./dist/index.js"
-  },
-  "files": [
-    "dist/index.js",
-    "package.json"
-  ],
-  "bin": {
-    "dwkim": "dist/index.js"
+  "version": "0.0.17",
+  "description": "this",
+  "license": "MIT",
+  "author": "dannyworks102@gmail.com",
+  "type": "commonjs",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "dependencies": {
+    "typescript": "^5.8.3"
   },
   "devDependencies": {
-    "@types/node": "^20.17.10",
-    "dotenv-cli": "^8.0.0",
-    "esbuild": "^0.24.2",
-    "ts-node": "^10.9.2",
-    "tsx": "4.19.1",
-    "typescript": "~5.6.3",
-    "@repo/typescript-config": "0.0.0",
-    "@repo/database": "1.0.0"
-  },
-  "dependencies": {
-    "@ai-sdk/openai": "^1.1.9",
-    "ai": "^4.1.34",
-    "boxen": "^8.0.1",
-    "chalk": "^5.4.1",
-    "dotenv": "^16.4.7",
-    "rimraf": "^5.0.5",
-    "zod": "^3.24.1"
+    "@changesets/cli": "^2.29.4",
+    "tsup": "^8.5.0",
+    "tsx": "^4.20.3"
   },
   "scripts": {
-    "start": "pnpm run build && node dist/index.js",
-    "build": "node script/build.js",
-    "build:watch": "node script/build.js --watch",
-    "prebuild": "rimraf ./dist",
-    "publish:dev": "dotenv -e .env -- node script/private-registry.js"
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "release": "pnpm run build && changeset publish",
+    "dev": "tsx watch src/index.ts",
+    "lint": "tsc"
   }
 }

package/src/index.ts

@@ -0,0 +1,14 @@
+export function multiply(a: number, b: number): number {
+  return a * b;
+}
+
+export function identitiy<T>(arg: T): T {
+  return arg;
+}
+
+function main() {
+  console.log('multiply 1 2', multiply(1, 2));
+  console.log('identitiy 1', identitiy('1'));
+}
+
+main();

package/tsconfig.json

@@ -0,0 +1,32 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+    /* Language and Environment */
+    "target": "es2022" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    "moduleDetection": "force" /* Control what method is used to detect module-format JS files. */,
+    "verbatimModuleSyntax": true,
+    "moduleResolution": "Bundler", // gonna use tsup
+    "module": "ESNext",
+
+    "lib": ["es2022", "dom", "dom.iterable"],
+
+    /* Modules */
+    "resolveJsonModule": true /* Enable importing .json files. */,
+
+    /* JavaScript Support */
+    "allowJs": true /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */,
+
+    /* Emit */
+    "noEmit": true /* Disable emitting files from a compilation. */,
+
+    /* Interop Constraints */
+    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
+    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+
+    /* Type Checking */
+    "strict": true /* Enable all strict type-checking options. */,
+
+    /* Completeness */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
+  }
+}