@kood/claude-code 0.5.4 → 0.5.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +6 -2
- package/package.json +1 -1
- package/templates/.claude/agents/document-writer.md +2 -2
- package/templates/.claude/skills/docs-creator/SKILL.md +2 -2
- package/templates/.claude/skills/docs-refactor/SKILL.md +1 -1
- package/templates/.claude/skills/plan/SKILL.md +15 -15
- package/templates/.claude/skills/ralph/SKILL.md +425 -72
- package/templates/hono/CLAUDE.md +28 -28
- package/templates/hono/docs/architecture.md +24 -24
- package/templates/hono/docs/deployment/cloudflare.md +18 -18
- package/templates/hono/docs/deployment/docker.md +13 -13
- package/templates/hono/docs/deployment/index.md +19 -19
- package/templates/hono/docs/deployment/railway.md +32 -32
- package/templates/hono/docs/deployment/vercel.md +29 -29
- package/templates/hono/docs/guides/conventions.md +57 -57
- package/templates/hono/docs/guides/env-setup.md +47 -47
- package/templates/hono/docs/guides/getting-started.md +27 -27
- package/templates/hono/docs/library/hono/error-handling.md +11 -11
- package/templates/hono/docs/library/hono/index.md +4 -4
- package/templates/hono/docs/library/hono/middleware.md +18 -18
- package/templates/hono/docs/library/hono/rpc.md +7 -7
- package/templates/hono/docs/library/hono/validation.md +6 -6
- package/templates/hono/docs/library/prisma/cloudflare-d1.md +29 -29
- package/templates/hono/docs/library/prisma/config.md +16 -16
- package/templates/hono/docs/library/prisma/index.md +32 -32
- package/templates/hono/docs/library/t3-env/index.md +22 -22
- package/templates/hono/docs/library/zod/index.md +31 -31
- package/templates/nextjs/CLAUDE.md +54 -54
- package/templates/nextjs/docs/architecture.md +146 -146
- package/templates/nextjs/docs/design.md +183 -183
- package/templates/nextjs/docs/guides/conventions.md +86 -86
- package/templates/nextjs/docs/guides/getting-started.md +28 -28
- package/templates/nextjs/docs/guides/routes.md +32 -32
- package/templates/nextjs/docs/library/better-auth/index.md +70 -70
- package/templates/nextjs/docs/library/nextjs/app-router.md +43 -43
- package/templates/nextjs/docs/library/nextjs/caching.md +73 -73
- package/templates/nextjs/docs/library/nextjs/index.md +51 -51
- package/templates/nextjs/docs/library/nextjs/middleware.md +41 -41
- package/templates/nextjs/docs/library/nextjs/route-handlers.md +31 -31
- package/templates/nextjs/docs/library/nextjs/server-actions.md +34 -34
- package/templates/nextjs/docs/library/prisma/cloudflare-d1.md +20 -20
- package/templates/nextjs/docs/library/prisma/config.md +18 -18
- package/templates/nextjs/docs/library/prisma/crud.md +17 -17
- package/templates/nextjs/docs/library/prisma/index.md +18 -18
- package/templates/nextjs/docs/library/prisma/relations.md +16 -16
- package/templates/nextjs/docs/library/prisma/schema.md +23 -23
- package/templates/nextjs/docs/library/prisma/setup.md +6 -6
- package/templates/nextjs/docs/library/prisma/transactions.md +10 -10
- package/templates/nextjs/docs/library/tanstack-query/index.md +6 -6
- package/templates/nextjs/docs/library/tanstack-query/invalidation.md +20 -20
- package/templates/nextjs/docs/library/tanstack-query/optimistic-updates.md +4 -4
- package/templates/nextjs/docs/library/tanstack-query/use-mutation.md +15 -15
- package/templates/nextjs/docs/library/tanstack-query/use-query.md +22 -22
- package/templates/nextjs/docs/library/zod/complex-types.md +11 -11
- package/templates/nextjs/docs/library/zod/index.md +8 -8
- package/templates/nextjs/docs/library/zod/transforms.md +11 -11
- package/templates/nextjs/docs/library/zod/validation.md +9 -9
- package/templates/npx/CLAUDE.md +38 -38
- package/templates/npx/docs/library/commander/index.md +12 -12
- package/templates/npx/docs/library/fs-extra/index.md +9 -9
- package/templates/npx/docs/library/prompts/index.md +3 -3
- package/templates/npx/docs/references/patterns.md +12 -12
- package/templates/tanstack-start/CLAUDE.md +54 -54
- package/templates/tanstack-start/docs/architecture.md +128 -128
- package/templates/tanstack-start/docs/design.md +169 -169
- package/templates/tanstack-start/docs/guides/conventions.md +43 -43
- package/templates/tanstack-start/docs/guides/env-setup.md +35 -35
- package/templates/tanstack-start/docs/guides/getting-started.md +19 -19
- package/templates/tanstack-start/docs/guides/hooks.md +45 -45
- package/templates/tanstack-start/docs/guides/routes.md +54 -54
- package/templates/tanstack-start/docs/guides/services.md +45 -45
- package/templates/tanstack-start/docs/library/prisma/cloudflare-d1.md +19 -19
- package/templates/tanstack-start/docs/library/prisma/config.md +16 -16
- package/templates/tanstack-start/docs/library/prisma/crud.md +17 -17
- package/templates/tanstack-start/docs/library/prisma/relations.md +16 -16
- package/templates/tanstack-start/docs/library/prisma/schema.md +23 -23
- package/templates/tanstack-start/docs/library/prisma/setup.md +6 -6
- package/templates/tanstack-start/docs/library/prisma/transactions.md +10 -10
- package/templates/tanstack-start/docs/library/tanstack-query/invalidation.md +19 -19
- package/templates/tanstack-start/docs/library/tanstack-query/optimistic-updates.md +4 -4
- package/templates/tanstack-start/docs/library/tanstack-query/use-mutation.md +14 -14
- package/templates/tanstack-start/docs/library/tanstack-query/use-query.md +21 -21
- package/templates/tanstack-start/docs/library/tanstack-router/error-handling.md +9 -9
- package/templates/tanstack-start/docs/library/tanstack-router/hooks.md +11 -11
- package/templates/tanstack-start/docs/library/tanstack-router/navigation.md +17 -17
- package/templates/tanstack-start/docs/library/tanstack-router/route-context.md +5 -5
- package/templates/tanstack-start/docs/library/tanstack-router/search-params.md +10 -10
- package/templates/tanstack-start/docs/library/tanstack-start/auth-patterns.md +8 -8
- package/templates/tanstack-start/docs/library/tanstack-start/middleware.md +9 -9
- package/templates/tanstack-start/docs/library/tanstack-start/routing.md +6 -6
- package/templates/tanstack-start/docs/library/tanstack-start/server-functions.md +18 -18
- package/templates/tanstack-start/docs/library/tanstack-start/setup.md +4 -4
- package/templates/tanstack-start/docs/library/zod/complex-types.md +11 -11
- package/templates/tanstack-start/docs/library/zod/transforms.md +11 -11
- package/templates/tanstack-start/docs/library/zod/validation.md +9 -9
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
# Nitro - Vercel
|
|
1
|
+
# Nitro - Vercel 배포
|
|
2
2
|
|
|
3
|
-
>
|
|
3
|
+
> 서버리스 배포
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## 설정
|
|
8
8
|
|
|
9
9
|
```typescript
|
|
10
10
|
// nitro.config.ts
|
|
@@ -26,11 +26,11 @@ export default defineNitroConfig({
|
|
|
26
26
|
|
|
27
27
|
---
|
|
28
28
|
|
|
29
|
-
##
|
|
29
|
+
## 배포
|
|
30
30
|
|
|
31
|
-
### GitHub
|
|
31
|
+
### GitHub 연동 (권장)
|
|
32
32
|
|
|
33
|
-
1. [Vercel
|
|
33
|
+
1. [Vercel 대시보드](https://vercel.com) → Add New → Project
|
|
34
34
|
2. Build Command: `yarn build`
|
|
35
35
|
3. Output Directory: `.vercel/output`
|
|
36
36
|
|
|
@@ -39,8 +39,8 @@ export default defineNitroConfig({
|
|
|
39
39
|
```bash
|
|
40
40
|
npm install -g vercel
|
|
41
41
|
vercel login
|
|
42
|
-
vercel #
|
|
43
|
-
vercel --prod #
|
|
42
|
+
vercel # 프리뷰
|
|
43
|
+
vercel --prod # 프로덕션
|
|
44
44
|
|
|
45
45
|
vercel env add DATABASE_URL
|
|
46
46
|
```
|
|
@@ -59,7 +59,7 @@ export default defineNitroConfig({
|
|
|
59
59
|
|
|
60
60
|
---
|
|
61
61
|
|
|
62
|
-
## ISR (
|
|
62
|
+
## ISR (캐시)
|
|
63
63
|
|
|
64
64
|
```typescript
|
|
65
65
|
app.get("/posts", async (c) => {
|
|
@@ -68,14 +68,14 @@ app.get("/posts", async (c) => {
|
|
|
68
68
|
});
|
|
69
69
|
|
|
70
70
|
app.get("/user/:id", async (c) => {
|
|
71
|
-
c.header("Cache-Control", "no-store"); //
|
|
71
|
+
c.header("Cache-Control", "no-store"); // 캐시 안함
|
|
72
72
|
return c.json(await fetchUser(c.req.param("id")));
|
|
73
73
|
});
|
|
74
74
|
```
|
|
75
75
|
|
|
76
76
|
---
|
|
77
77
|
|
|
78
|
-
##
|
|
78
|
+
## 환경 변수
|
|
79
79
|
|
|
80
80
|
```typescript
|
|
81
81
|
app.get("/config", (c) => {
|
|
@@ -86,16 +86,16 @@ app.get("/config", (c) => {
|
|
|
86
86
|
});
|
|
87
87
|
```
|
|
88
88
|
|
|
89
|
-
|
|
|
90
|
-
|
|
91
|
-
| `VERCEL` | Vercel
|
|
92
|
-
| `VERCEL_ENV` |
|
|
93
|
-
| `VERCEL_URL` |
|
|
94
|
-
| `VERCEL_REGION` |
|
|
89
|
+
| 자동 제공 변수 | 설명 |
|
|
90
|
+
|---------------|------|
|
|
91
|
+
| `VERCEL` | Vercel 환경 ("1") |
|
|
92
|
+
| `VERCEL_ENV` | 환경 |
|
|
93
|
+
| `VERCEL_URL` | 배포 URL |
|
|
94
|
+
| `VERCEL_REGION` | 실행 리전 |
|
|
95
95
|
|
|
96
96
|
---
|
|
97
97
|
|
|
98
|
-
##
|
|
98
|
+
## 데이터베이스
|
|
99
99
|
|
|
100
100
|
### Vercel Postgres
|
|
101
101
|
|
|
@@ -161,22 +161,22 @@ jobs:
|
|
|
161
161
|
|
|
162
162
|
---
|
|
163
163
|
|
|
164
|
-
##
|
|
164
|
+
## 문제 해결
|
|
165
165
|
|
|
166
|
-
|
|
|
167
|
-
|
|
168
|
-
| Function Timeout |
|
|
169
|
-
| Edge
|
|
170
|
-
|
|
|
166
|
+
| 문제 | 해결 |
|
|
167
|
+
|------|------|
|
|
168
|
+
| Function Timeout | `maxDuration` 증가 |
|
|
169
|
+
| Edge 호환성 오류 | Edge 호환 API 사용 |
|
|
170
|
+
| 번들 크기 초과 | externals 설정 |
|
|
171
171
|
|
|
172
172
|
```bash
|
|
173
|
-
vercel dev #
|
|
174
|
-
vercel logs #
|
|
175
|
-
vercel env ls #
|
|
173
|
+
vercel dev # 로컬 시뮬레이션
|
|
174
|
+
vercel logs # 로그 확인
|
|
175
|
+
vercel env ls # 환경 변수 확인
|
|
176
176
|
```
|
|
177
177
|
|
|
178
178
|
---
|
|
179
179
|
|
|
180
|
-
##
|
|
180
|
+
## 관련 문서
|
|
181
181
|
|
|
182
|
-
- [
|
|
182
|
+
- [배포 가이드](./index.md)
|
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
#
|
|
1
|
+
# 코드 컨벤션
|
|
2
2
|
|
|
3
|
-
>
|
|
3
|
+
> Hono 프로젝트 코드 작성 규칙
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
<naming>
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## 파일 네이밍
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
|
|
13
|
-
|
|
|
14
|
-
| **Route
|
|
15
|
-
|
|
|
11
|
+
| 타입 | 규칙 | 예시 |
|
|
12
|
+
|------|------|------|
|
|
13
|
+
| **일반 파일** | kebab-case | `user-service.ts`, `auth-middleware.ts` |
|
|
14
|
+
| **Route 파일** | kebab-case | `users.ts`, `posts.ts` |
|
|
15
|
+
| **타입 파일** | kebab-case | `user-types.ts`, `api-types.ts` |
|
|
16
16
|
|
|
17
17
|
</naming>
|
|
18
18
|
|
|
@@ -20,39 +20,39 @@
|
|
|
20
20
|
|
|
21
21
|
<typescript>
|
|
22
22
|
|
|
23
|
-
## TypeScript
|
|
23
|
+
## TypeScript 규칙
|
|
24
24
|
|
|
25
|
-
|
|
|
26
|
-
|
|
27
|
-
|
|
|
28
|
-
|
|
|
29
|
-
| **
|
|
30
|
-
| **Import
|
|
25
|
+
| 규칙 | 설명 | 예시 |
|
|
26
|
+
|------|------|------|
|
|
27
|
+
| **함수 선언** | const 함수, 명시적 return type | `const fn = (): ReturnType => {}` |
|
|
28
|
+
| **타입 정의** | interface (객체), type (유니온) | `interface User {}`, `type Status = 'a' \| 'b'` |
|
|
29
|
+
| **any 금지** | unknown 사용 | `const data: unknown = JSON.parse(str)` |
|
|
30
|
+
| **Import 타입** | type import 분리 | `import type { User } from '@/types'` |
|
|
31
31
|
|
|
32
|
-
##
|
|
32
|
+
## 패턴
|
|
33
33
|
|
|
34
34
|
```typescript
|
|
35
|
-
// ✅ const
|
|
35
|
+
// ✅ const 함수, 명시적 타입
|
|
36
36
|
const getUserById = async (id: string): Promise<User | null> => {
|
|
37
37
|
return prisma.user.findUnique({ where: { id } })
|
|
38
38
|
}
|
|
39
39
|
|
|
40
|
-
// ✅
|
|
40
|
+
// ✅ 간단한 함수도 명시적 타입
|
|
41
41
|
const formatDate = (date: Date): string => {
|
|
42
42
|
return date.toISOString()
|
|
43
43
|
}
|
|
44
44
|
|
|
45
|
-
// ✅
|
|
45
|
+
// ✅ any 금지 → unknown 사용
|
|
46
46
|
const parseJSON = (data: string): unknown => {
|
|
47
47
|
return JSON.parse(data)
|
|
48
48
|
}
|
|
49
49
|
|
|
50
|
-
// ❌
|
|
50
|
+
// ❌ any 사용 금지
|
|
51
51
|
const badParse = (data: string): any => { // ❌
|
|
52
52
|
return JSON.parse(data)
|
|
53
53
|
}
|
|
54
54
|
|
|
55
|
-
// ❌
|
|
55
|
+
// ❌ function 키워드 금지
|
|
56
56
|
function badFunction() { // ❌
|
|
57
57
|
return 'use const arrow function'
|
|
58
58
|
}
|
|
@@ -64,7 +64,7 @@ function badFunction() { // ❌
|
|
|
64
64
|
|
|
65
65
|
<imports>
|
|
66
66
|
|
|
67
|
-
## Import
|
|
67
|
+
## Import 순서
|
|
68
68
|
|
|
69
69
|
```typescript
|
|
70
70
|
// 1. External libraries
|
|
@@ -88,12 +88,12 @@ import type { Context } from 'hono'
|
|
|
88
88
|
|
|
89
89
|
<comments>
|
|
90
90
|
|
|
91
|
-
##
|
|
91
|
+
## 한글 주석 (묶음 단위)
|
|
92
92
|
|
|
93
93
|
```typescript
|
|
94
|
-
// ✅
|
|
94
|
+
// ✅ 코드 묶음 단위 주석
|
|
95
95
|
// ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
96
|
-
//
|
|
96
|
+
// 사용자 조회
|
|
97
97
|
// ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
98
98
|
users.get('/', async (c) => {
|
|
99
99
|
const users = await prisma.user.findMany()
|
|
@@ -108,7 +108,7 @@ users.get('/:id', async (c) => {
|
|
|
108
108
|
})
|
|
109
109
|
|
|
110
110
|
// ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
111
|
-
//
|
|
111
|
+
// 사용자 생성/수정
|
|
112
112
|
// ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
113
113
|
users.post('/', zValidator('json', createUserSchema), async (c) => {
|
|
114
114
|
const data = c.req.valid('json')
|
|
@@ -118,10 +118,10 @@ users.post('/', zValidator('json', createUserSchema), async (c) => {
|
|
|
118
118
|
```
|
|
119
119
|
|
|
120
120
|
```typescript
|
|
121
|
-
// ❌
|
|
122
|
-
users.get('/', async (c) => { //
|
|
123
|
-
const users = await prisma.user.findMany() //
|
|
124
|
-
return c.json({ users }) //
|
|
121
|
+
// ❌ 세세한 주석 (금지)
|
|
122
|
+
users.get('/', async (c) => { // 사용자 목록 조회
|
|
123
|
+
const users = await prisma.user.findMany() // DB에서 조회
|
|
124
|
+
return c.json({ users }) // JSON 반환
|
|
125
125
|
})
|
|
126
126
|
```
|
|
127
127
|
|
|
@@ -131,14 +131,14 @@ users.get('/', async (c) => { // Retrieve user list
|
|
|
131
131
|
|
|
132
132
|
<error_handling>
|
|
133
133
|
|
|
134
|
-
##
|
|
134
|
+
## 에러 처리 패턴
|
|
135
135
|
|
|
136
|
-
###
|
|
136
|
+
### HTTPException 사용
|
|
137
137
|
|
|
138
138
|
```typescript
|
|
139
139
|
import { HTTPException } from 'hono/http-exception'
|
|
140
140
|
|
|
141
|
-
// ✅
|
|
141
|
+
// ✅ HTTPException 사용
|
|
142
142
|
users.get('/:id', async (c) => {
|
|
143
143
|
const id = c.req.param('id')
|
|
144
144
|
const user = await prisma.user.findUnique({ where: { id } })
|
|
@@ -150,7 +150,7 @@ users.get('/:id', async (c) => {
|
|
|
150
150
|
return c.json({ user })
|
|
151
151
|
})
|
|
152
152
|
|
|
153
|
-
// ❌
|
|
153
|
+
// ❌ 일반 Error 사용 금지
|
|
154
154
|
users.get('/:id', async (c) => {
|
|
155
155
|
const id = c.req.param('id')
|
|
156
156
|
const user = await prisma.user.findUnique({ where: { id } })
|
|
@@ -163,7 +163,7 @@ users.get('/:id', async (c) => {
|
|
|
163
163
|
})
|
|
164
164
|
```
|
|
165
165
|
|
|
166
|
-
###
|
|
166
|
+
### 전역 에러 핸들러
|
|
167
167
|
|
|
168
168
|
```typescript
|
|
169
169
|
// src/index.ts
|
|
@@ -204,7 +204,7 @@ app.notFound((c) => {
|
|
|
204
204
|
})
|
|
205
205
|
```
|
|
206
206
|
|
|
207
|
-
###
|
|
207
|
+
### 커스텀 에러 클래스
|
|
208
208
|
|
|
209
209
|
```typescript
|
|
210
210
|
// lib/errors.ts
|
|
@@ -228,7 +228,7 @@ export class UnauthorizedError extends HTTPException {
|
|
|
228
228
|
}
|
|
229
229
|
}
|
|
230
230
|
|
|
231
|
-
//
|
|
231
|
+
// 사용
|
|
232
232
|
import { NotFoundError } from '@/lib/errors'
|
|
233
233
|
|
|
234
234
|
users.get('/:id', async (c) => {
|
|
@@ -244,15 +244,15 @@ users.get('/:id', async (c) => {
|
|
|
244
244
|
|
|
245
245
|
<validation>
|
|
246
246
|
|
|
247
|
-
## Validation
|
|
247
|
+
## Validation 패턴
|
|
248
248
|
|
|
249
|
-
###
|
|
249
|
+
### zValidator 사용
|
|
250
250
|
|
|
251
251
|
```typescript
|
|
252
252
|
import { zValidator } from '@hono/zod-validator'
|
|
253
253
|
import { z } from 'zod'
|
|
254
254
|
|
|
255
|
-
// ✅
|
|
255
|
+
// ✅ zValidator 사용
|
|
256
256
|
const createUserSchema = z.object({
|
|
257
257
|
name: z.string().min(1).trim(),
|
|
258
258
|
email: z.email(),
|
|
@@ -260,12 +260,12 @@ const createUserSchema = z.object({
|
|
|
260
260
|
})
|
|
261
261
|
|
|
262
262
|
users.post('/', zValidator('json', createUserSchema), async (c) => {
|
|
263
|
-
const data = c.req.valid('json') //
|
|
263
|
+
const data = c.req.valid('json') // 타입 안전
|
|
264
264
|
const user = await prisma.user.create({ data })
|
|
265
265
|
return c.json({ user }, 201)
|
|
266
266
|
})
|
|
267
267
|
|
|
268
|
-
// ❌
|
|
268
|
+
// ❌ 수동 검증 금지
|
|
269
269
|
users.post('/', async (c) => {
|
|
270
270
|
const body = await c.req.json()
|
|
271
271
|
|
|
@@ -278,7 +278,7 @@ users.post('/', async (c) => {
|
|
|
278
278
|
})
|
|
279
279
|
```
|
|
280
280
|
|
|
281
|
-
###
|
|
281
|
+
### 여러 Validator
|
|
282
282
|
|
|
283
283
|
```typescript
|
|
284
284
|
// Query Params
|
|
@@ -306,17 +306,17 @@ users.post('/', zValidator('json', createUserSchema), (c) => {
|
|
|
306
306
|
|
|
307
307
|
<examples>
|
|
308
308
|
|
|
309
|
-
##
|
|
309
|
+
## 파일명 예시
|
|
310
310
|
|
|
311
|
-
|
|
|
312
|
-
|
|
311
|
+
| 타입 | ❌ 잘못된 예시 | ✅ 올바른 예시 |
|
|
312
|
+
|------|---------------|---------------|
|
|
313
313
|
| Route | `Users.ts` | `users.ts` |
|
|
314
314
|
| Service | `userService.ts` | `user-service.ts` |
|
|
315
315
|
| Middleware | `authMiddleware.ts` | `auth-middleware.ts` |
|
|
316
316
|
| Utility | `formatUtils.ts` | `format-utils.ts` |
|
|
317
317
|
| Type | `UserTypes.ts` | `user-types.ts` |
|
|
318
318
|
|
|
319
|
-
##
|
|
319
|
+
## 디렉토리 구조
|
|
320
320
|
|
|
321
321
|
```
|
|
322
322
|
src/
|
|
@@ -325,19 +325,19 @@ src/
|
|
|
325
325
|
│ ├── posts.ts # /posts/*
|
|
326
326
|
│ └── auth.ts # /auth/*
|
|
327
327
|
├── middleware/
|
|
328
|
-
│ ├── auth.ts #
|
|
329
|
-
│ ├── logger.ts #
|
|
330
|
-
│ └── cors.ts # CORS
|
|
328
|
+
│ ├── auth.ts # 인증 미들웨어
|
|
329
|
+
│ ├── logger.ts # 로깅 미들웨어
|
|
330
|
+
│ └── cors.ts # CORS 미들웨어
|
|
331
331
|
├── services/
|
|
332
|
-
│ ├── user-service.ts #
|
|
333
|
-
│ └── post-service.ts #
|
|
332
|
+
│ ├── user-service.ts # 사용자 비즈니스 로직
|
|
333
|
+
│ └── post-service.ts # 게시글 비즈니스 로직
|
|
334
334
|
├── lib/
|
|
335
|
-
│ ├── prisma.ts # Prisma
|
|
336
|
-
│ ├── env.ts #
|
|
337
|
-
│ └── errors.ts #
|
|
335
|
+
│ ├── prisma.ts # Prisma 클라이언트
|
|
336
|
+
│ ├── env.ts # 환경 변수
|
|
337
|
+
│ └── errors.ts # 커스텀 에러
|
|
338
338
|
└── types/
|
|
339
|
-
├── user-types.ts #
|
|
340
|
-
└── api-types.ts # API
|
|
339
|
+
├── user-types.ts # 사용자 타입
|
|
340
|
+
└── api-types.ts # API 타입
|
|
341
341
|
```
|
|
342
342
|
|
|
343
343
|
</examples>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
#
|
|
1
|
+
# 환경 변수 설정
|
|
2
2
|
|
|
3
|
-
>
|
|
3
|
+
> Hono 환경 변수 관리 (Node.js, Cloudflare Workers)
|
|
4
4
|
|
|
5
5
|
<instructions>
|
|
6
6
|
@../library/t3-env/index.md
|
|
@@ -10,9 +10,9 @@
|
|
|
10
10
|
|
|
11
11
|
<runtime_differences>
|
|
12
12
|
|
|
13
|
-
|
|
|
14
|
-
|
|
15
|
-
| **Node.js** | `process.env.*` |
|
|
13
|
+
| 런타임 | 환경 변수 접근 | 용도 |
|
|
14
|
+
|--------|---------------|------|
|
|
15
|
+
| **Node.js** | `process.env.*` | 일반 서버 |
|
|
16
16
|
| **Cloudflare Workers** | `c.env.*` (Bindings) | Edge Runtime |
|
|
17
17
|
| **Deno** | `Deno.env.get()` | Deno Runtime |
|
|
18
18
|
| **Bun** | `process.env.*` | Bun Runtime |
|
|
@@ -23,22 +23,22 @@
|
|
|
23
23
|
|
|
24
24
|
<file_structure>
|
|
25
25
|
|
|
26
|
-
##
|
|
26
|
+
## 환경 파일 구조
|
|
27
27
|
|
|
28
28
|
```
|
|
29
|
-
├── .env #
|
|
30
|
-
├── .env.development #
|
|
31
|
-
├── .env.production #
|
|
32
|
-
├── .env.local #
|
|
33
|
-
└── src/lib/env.ts #
|
|
29
|
+
├── .env # 기본 (커밋 O)
|
|
30
|
+
├── .env.development # 개발 (커밋 O)
|
|
31
|
+
├── .env.production # 프로덕션 (커밋 O)
|
|
32
|
+
├── .env.local # 로컬 오버라이드 (커밋 X)
|
|
33
|
+
└── src/lib/env.ts # 검증 및 타입 (t3-env)
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
-
|
|
|
37
|
-
|
|
38
|
-
| 1 | `.env.{mode}.local` |
|
|
39
|
-
| 2 | `.env.local` |
|
|
40
|
-
| 3 | `.env.{mode}` |
|
|
41
|
-
| 4 | `.env` |
|
|
36
|
+
| 우선순위 | 파일 | 설명 |
|
|
37
|
+
|----------|------|------|
|
|
38
|
+
| 1 | `.env.{mode}.local` | 최우선 (gitignore) |
|
|
39
|
+
| 2 | `.env.local` | 로컬 오버라이드 |
|
|
40
|
+
| 3 | `.env.{mode}` | 환경별 설정 |
|
|
41
|
+
| 4 | `.env` | 기본 설정 |
|
|
42
42
|
|
|
43
43
|
</file_structure>
|
|
44
44
|
|
|
@@ -46,9 +46,9 @@
|
|
|
46
46
|
|
|
47
47
|
<patterns>
|
|
48
48
|
|
|
49
|
-
##
|
|
49
|
+
## 환경 파일 예시
|
|
50
50
|
|
|
51
|
-
### .env.local (gitignore,
|
|
51
|
+
### .env.local (gitignore, 시크릿)
|
|
52
52
|
|
|
53
53
|
```env
|
|
54
54
|
DATABASE_URL=postgresql://user:password@localhost:5432/myapp
|
|
@@ -72,9 +72,9 @@ PORT=8080
|
|
|
72
72
|
LOG_LEVEL=info
|
|
73
73
|
```
|
|
74
74
|
|
|
75
|
-
## Node.js
|
|
75
|
+
## Node.js 환경 변수
|
|
76
76
|
|
|
77
|
-
###
|
|
77
|
+
### 타입 안전한 환경 변수 (t3-env)
|
|
78
78
|
|
|
79
79
|
```typescript
|
|
80
80
|
// src/lib/env.ts
|
|
@@ -94,7 +94,7 @@ export const env = createEnv({
|
|
|
94
94
|
})
|
|
95
95
|
```
|
|
96
96
|
|
|
97
|
-
###
|
|
97
|
+
### 사용 예시
|
|
98
98
|
|
|
99
99
|
```typescript
|
|
100
100
|
// src/index.ts
|
|
@@ -116,9 +116,9 @@ export default {
|
|
|
116
116
|
}
|
|
117
117
|
```
|
|
118
118
|
|
|
119
|
-
## Cloudflare Workers
|
|
119
|
+
## Cloudflare Workers 환경 변수
|
|
120
120
|
|
|
121
|
-
### Bindings
|
|
121
|
+
### Bindings 타입 정의
|
|
122
122
|
|
|
123
123
|
```typescript
|
|
124
124
|
// src/types/index.ts
|
|
@@ -139,12 +139,12 @@ compatibility_date = "2024-01-01"
|
|
|
139
139
|
[vars]
|
|
140
140
|
NODE_ENV = "production"
|
|
141
141
|
|
|
142
|
-
#
|
|
142
|
+
# 시크릿은 wrangler secret put 명령어로 설정
|
|
143
143
|
# wrangler secret put DATABASE_URL
|
|
144
144
|
# wrangler secret put JWT_SECRET
|
|
145
145
|
```
|
|
146
146
|
|
|
147
|
-
###
|
|
147
|
+
### 사용 예시
|
|
148
148
|
|
|
149
149
|
```typescript
|
|
150
150
|
// src/index.ts
|
|
@@ -154,7 +154,7 @@ import type { Bindings } from './types'
|
|
|
154
154
|
const app = new Hono<{ Bindings: Bindings }>()
|
|
155
155
|
|
|
156
156
|
app.get('/', (c) => {
|
|
157
|
-
//
|
|
157
|
+
// c.env를 통해 환경 변수 접근
|
|
158
158
|
const dbUrl = c.env.DATABASE_URL
|
|
159
159
|
const jwtSecret = c.env.JWT_SECRET
|
|
160
160
|
|
|
@@ -167,7 +167,7 @@ app.get('/', (c) => {
|
|
|
167
167
|
export default app
|
|
168
168
|
```
|
|
169
169
|
|
|
170
|
-
###
|
|
170
|
+
### 미들웨어에서 사용
|
|
171
171
|
|
|
172
172
|
```typescript
|
|
173
173
|
// src/middleware/auth.ts
|
|
@@ -186,26 +186,26 @@ export const authMiddleware = createMiddleware<{
|
|
|
186
186
|
const token = c.req.header('Authorization')?.replace('Bearer ', '')
|
|
187
187
|
if (!token) throw new HTTPException(401, { message: 'Unauthorized' })
|
|
188
188
|
|
|
189
|
-
//
|
|
189
|
+
// JWT Secret 사용
|
|
190
190
|
const jwtSecret = c.env.JWT_SECRET
|
|
191
|
-
// JWT
|
|
191
|
+
// JWT 검증 로직...
|
|
192
192
|
|
|
193
193
|
c.set('userId', 'user-id')
|
|
194
194
|
await next()
|
|
195
195
|
})
|
|
196
196
|
```
|
|
197
197
|
|
|
198
|
-
## Cloudflare Workers
|
|
198
|
+
## Cloudflare Workers 시크릿 설정
|
|
199
199
|
|
|
200
200
|
```bash
|
|
201
|
-
#
|
|
201
|
+
# 시크릿 추가
|
|
202
202
|
wrangler secret put DATABASE_URL
|
|
203
203
|
wrangler secret put JWT_SECRET
|
|
204
204
|
|
|
205
|
-
#
|
|
205
|
+
# 시크릿 목록 확인
|
|
206
206
|
wrangler secret list
|
|
207
207
|
|
|
208
|
-
#
|
|
208
|
+
# 시크릿 삭제
|
|
209
209
|
wrangler secret delete DATABASE_URL
|
|
210
210
|
```
|
|
211
211
|
|
|
@@ -218,14 +218,14 @@ wrangler secret delete DATABASE_URL
|
|
|
218
218
|
## .gitignore
|
|
219
219
|
|
|
220
220
|
```gitignore
|
|
221
|
-
#
|
|
221
|
+
# 시크릿 포함 (절대 커밋 X)
|
|
222
222
|
.env.local
|
|
223
223
|
.env.*.local
|
|
224
224
|
|
|
225
225
|
# Cloudflare Workers
|
|
226
226
|
.dev.vars
|
|
227
227
|
|
|
228
|
-
#
|
|
228
|
+
# 공개 설정 (커밋 O)
|
|
229
229
|
!.env
|
|
230
230
|
!.env.development
|
|
231
231
|
!.env.production
|
|
@@ -237,7 +237,7 @@ wrangler secret delete DATABASE_URL
|
|
|
237
237
|
|
|
238
238
|
<typescript_types>
|
|
239
239
|
|
|
240
|
-
## TypeScript
|
|
240
|
+
## TypeScript 타입
|
|
241
241
|
|
|
242
242
|
### Node.js
|
|
243
243
|
|
|
@@ -286,13 +286,13 @@ export type Bindings = {
|
|
|
286
286
|
|
|
287
287
|
<best_practices>
|
|
288
288
|
|
|
289
|
-
|
|
|
290
|
-
|
|
291
|
-
|
|
|
292
|
-
|
|
|
293
|
-
|
|
|
294
|
-
|
|
|
295
|
-
|
|
|
289
|
+
| 원칙 | 설명 |
|
|
290
|
+
|------|------|
|
|
291
|
+
| **시크릿 분리** | `.env.local`에만 시크릿 저장, 커밋 금지 |
|
|
292
|
+
| **타입 안전성** | t3-env 또는 Zod로 검증 |
|
|
293
|
+
| **기본값** | `.env`에 안전한 기본값 설정 |
|
|
294
|
+
| **문서화** | `.env.example` 파일로 필수 변수 목록 제공 |
|
|
295
|
+
| **런타임별 차이** | Node.js는 `process.env`, Cloudflare는 `c.env` |
|
|
296
296
|
|
|
297
297
|
</best_practices>
|
|
298
298
|
|
|
@@ -300,7 +300,7 @@ export type Bindings = {
|
|
|
300
300
|
|
|
301
301
|
<cloudflare_specific>
|
|
302
302
|
|
|
303
|
-
## Cloudflare Workers
|
|
303
|
+
## Cloudflare Workers 추가 기능
|
|
304
304
|
|
|
305
305
|
### KV Namespace
|
|
306
306
|
|
|
@@ -310,7 +310,7 @@ export type Bindings = {
|
|
|
310
310
|
binding = "MY_KV"
|
|
311
311
|
id = "your-kv-id"
|
|
312
312
|
|
|
313
|
-
//
|
|
313
|
+
// 사용
|
|
314
314
|
app.get('/cache/:key', async (c) => {
|
|
315
315
|
const key = c.req.param('key')
|
|
316
316
|
const value = await c.env.MY_KV.get(key)
|
|
@@ -327,7 +327,7 @@ binding = "DB"
|
|
|
327
327
|
database_name = "my-database"
|
|
328
328
|
database_id = "your-db-id"
|
|
329
329
|
|
|
330
|
-
//
|
|
330
|
+
// 사용
|
|
331
331
|
app.get('/users', async (c) => {
|
|
332
332
|
const { results } = await c.env.DB.prepare('SELECT * FROM users').all()
|
|
333
333
|
return c.json({ users: results })
|