@mandujs/cli 0.8.1 → 0.8.3

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/README.ko.md CHANGED
@@ -1,181 +1,181 @@
1
- <p align="center">
2
- <img src="https://raw.githubusercontent.com/konamgil/mandu/main/mandu_only_simbol.png" alt="Mandu" width="200" />
3
- </p>
4
-
5
- <h1 align="center">@mandujs/cli</h1>
6
-
7
- <p align="center">
8
- <strong>Agent-Native Fullstack Framework CLI</strong><br/>
9
- 에이전트가 코딩해도 아키텍처가 무너지지 않는 개발 OS
10
- </p>
11
-
12
- <p align="center">
13
- <a href="./README.md"><strong>English</strong></a> | 한국어
14
- </p>
15
-
16
- ## 설치
17
-
18
- ```bash
19
- # Bun 필수
20
- bun add -D @mandujs/cli
21
- ```
22
-
23
- ## 빠른 시작
24
-
25
- ```bash
26
- # 새 프로젝트 생성
27
- bunx @mandujs/cli init my-app
28
- cd my-app
29
-
30
- # 개발 서버 시작
31
- bun run dev
32
- ```
33
-
34
- ## 명령어
35
-
36
- ### `mandu init <project-name>`
37
-
38
- 새 Mandu 프로젝트를 생성합니다.
39
-
40
- ```bash
41
- bunx @mandujs/cli init my-app
42
- ```
43
-
44
- 생성되는 구조:
45
- ```
46
- my-app/
47
- ├── apps/
48
- │ ├── server/main.ts # 서버 진입점
49
- │ └── web/entry.tsx # 클라이언트 진입점
50
- ├── spec/
51
- │ └── routes.manifest.json # SSOT - 라우트 정의
52
- ├── tests/ # 테스트 템플릿
53
- ├── package.json
54
- └── tsconfig.json
55
- ```
56
-
57
- ### `mandu dev`
58
-
59
- 개발 서버를 시작합니다 (HMR 지원).
60
-
61
- ```bash
62
- bun run dev
63
- # 또는
64
- bunx mandu dev
65
- ```
66
-
67
- ### `mandu spec`
68
-
69
- spec 파일을 검증하고 lock 파일을 갱신합니다.
70
-
71
- ```bash
72
- bun run spec
73
- ```
74
-
75
- ### `mandu generate`
76
-
77
- spec 기반으로 코드를 생성합니다.
78
-
79
- ```bash
80
- bun run generate
81
- ```
82
-
83
- ### `mandu guard`
84
-
85
- 아키텍처 규칙을 검사하고 위반 사항을 자동 수정합니다.
86
-
87
- ```bash
88
- bun run guard
89
-
90
- # 자동 수정 비활성화
91
- bunx mandu guard --no-auto-correct
92
- ```
93
-
94
- 자동 수정 가능한 규칙:
95
- - `SPEC_HASH_MISMATCH` → lock 파일 갱신
96
- - `GENERATED_MANUAL_EDIT` → 코드 재생성
97
- - `SLOT_NOT_FOUND` → slot 파일 생성
98
-
99
- ## Spec 파일 작성
100
-
101
- `spec/routes.manifest.json`이 모든 라우트의 단일 진실 공급원(SSOT)입니다.
102
-
103
- ```json
104
- {
105
- "version": "1.0.0",
106
- "routes": [
107
- {
108
- "id": "getUsers",
109
- "pattern": "/api/users",
110
- "kind": "api",
111
- "module": "apps/server/api/users.ts"
112
- },
113
- {
114
- "id": "homePage",
115
- "pattern": "/",
116
- "kind": "page",
117
- "module": "apps/server/pages/home.ts",
118
- "componentModule": "apps/web/pages/Home.tsx"
119
- }
120
- ]
121
- }
122
- ```
123
-
124
- ### Slot 시스템 (v0.2.0+)
125
-
126
- 비즈니스 로직을 분리하려면 `slotModule`을 추가합니다:
127
-
128
- ```json
129
- {
130
- "id": "getUsers",
131
- "pattern": "/api/users",
132
- "kind": "api",
133
- "module": "apps/server/api/users.generated.ts",
134
- "slotModule": "apps/server/api/users.slot.ts"
135
- }
136
- ```
137
-
138
- - `*.generated.ts` - 프레임워크가 관리 (수정 금지)
139
- - `*.slot.ts` - 개발자가 작성하는 비즈니스 로직
140
-
141
- ## 개발 워크플로우
142
-
143
- ```bash
144
- # 1. spec 수정
145
- # 2. spec 검증 및 lock 갱신
146
- bun run spec
147
-
148
- # 3. 코드 생성
149
- bun run generate
150
-
151
- # 4. 아키텍처 검사
152
- bun run guard
153
-
154
- # 5. 테스트
155
- bun test
156
-
157
- # 6. 개발 서버
158
- bun run dev
159
- ```
160
-
161
- ## 테스트
162
-
163
- Bun 테스트 프레임워크를 기본 지원합니다.
164
-
165
- ```bash
166
- bun test # 테스트 실행
167
- bun test --watch # 감시 모드
168
- ```
169
-
170
- ## 요구 사항
171
-
172
- - Bun >= 1.0.0
173
- - React >= 18.0.0
174
-
175
- ## 관련 패키지
176
-
177
- - [@mandujs/core](https://www.npmjs.com/package/@mandujs/core) - 핵심 런타임
178
-
179
- ## 라이선스
180
-
181
- MIT
1
+ <p align="center">
2
+ <img src="https://raw.githubusercontent.com/konamgil/mandu/main/mandu_only_simbol.png" alt="Mandu" width="200" />
3
+ </p>
4
+
5
+ <h1 align="center">@mandujs/cli</h1>
6
+
7
+ <p align="center">
8
+ <strong>Agent-Native Fullstack Framework CLI</strong><br/>
9
+ 에이전트가 코딩해도 아키텍처가 무너지지 않는 개발 OS
10
+ </p>
11
+
12
+ <p align="center">
13
+ <a href="./README.md"><strong>English</strong></a> | 한국어
14
+ </p>
15
+
16
+ ## 설치
17
+
18
+ ```bash
19
+ # Bun 필수
20
+ bun add -D @mandujs/cli
21
+ ```
22
+
23
+ ## 빠른 시작
24
+
25
+ ```bash
26
+ # 새 프로젝트 생성
27
+ bunx @mandujs/cli init my-app
28
+ cd my-app
29
+
30
+ # 개발 서버 시작
31
+ bun run dev
32
+ ```
33
+
34
+ ## 명령어
35
+
36
+ ### `mandu init <project-name>`
37
+
38
+ 새 Mandu 프로젝트를 생성합니다.
39
+
40
+ ```bash
41
+ bunx @mandujs/cli init my-app
42
+ ```
43
+
44
+ 생성되는 구조:
45
+ ```
46
+ my-app/
47
+ ├── apps/
48
+ │ ├── server/main.ts # 서버 진입점
49
+ │ └── web/entry.tsx # 클라이언트 진입점
50
+ ├── spec/
51
+ │ └── routes.manifest.json # SSOT - 라우트 정의
52
+ ├── tests/ # 테스트 템플릿
53
+ ├── package.json
54
+ └── tsconfig.json
55
+ ```
56
+
57
+ ### `mandu dev`
58
+
59
+ 개발 서버를 시작합니다 (HMR 지원).
60
+
61
+ ```bash
62
+ bun run dev
63
+ # 또는
64
+ bunx mandu dev
65
+ ```
66
+
67
+ ### `mandu spec`
68
+
69
+ spec 파일을 검증하고 lock 파일을 갱신합니다.
70
+
71
+ ```bash
72
+ bun run spec
73
+ ```
74
+
75
+ ### `mandu generate`
76
+
77
+ spec 기반으로 코드를 생성합니다.
78
+
79
+ ```bash
80
+ bun run generate
81
+ ```
82
+
83
+ ### `mandu guard`
84
+
85
+ 아키텍처 규칙을 검사하고 위반 사항을 자동 수정합니다.
86
+
87
+ ```bash
88
+ bun run guard
89
+
90
+ # 자동 수정 비활성화
91
+ bunx mandu guard --no-auto-correct
92
+ ```
93
+
94
+ 자동 수정 가능한 규칙:
95
+ - `SPEC_HASH_MISMATCH` → lock 파일 갱신
96
+ - `GENERATED_MANUAL_EDIT` → 코드 재생성
97
+ - `SLOT_NOT_FOUND` → slot 파일 생성
98
+
99
+ ## Spec 파일 작성
100
+
101
+ `spec/routes.manifest.json`이 모든 라우트의 단일 진실 공급원(SSOT)입니다.
102
+
103
+ ```json
104
+ {
105
+ "version": "1.0.0",
106
+ "routes": [
107
+ {
108
+ "id": "getUsers",
109
+ "pattern": "/api/users",
110
+ "kind": "api",
111
+ "module": "apps/server/api/users.ts"
112
+ },
113
+ {
114
+ "id": "homePage",
115
+ "pattern": "/",
116
+ "kind": "page",
117
+ "module": "apps/server/pages/home.ts",
118
+ "componentModule": "apps/web/pages/Home.tsx"
119
+ }
120
+ ]
121
+ }
122
+ ```
123
+
124
+ ### Slot 시스템 (v0.2.0+)
125
+
126
+ 비즈니스 로직을 분리하려면 `slotModule`을 추가합니다:
127
+
128
+ ```json
129
+ {
130
+ "id": "getUsers",
131
+ "pattern": "/api/users",
132
+ "kind": "api",
133
+ "module": "apps/server/api/users.generated.ts",
134
+ "slotModule": "apps/server/api/users.slot.ts"
135
+ }
136
+ ```
137
+
138
+ - `*.generated.ts` - 프레임워크가 관리 (수정 금지)
139
+ - `*.slot.ts` - 개발자가 작성하는 비즈니스 로직
140
+
141
+ ## 개발 워크플로우
142
+
143
+ ```bash
144
+ # 1. spec 수정
145
+ # 2. spec 검증 및 lock 갱신
146
+ bun run spec
147
+
148
+ # 3. 코드 생성
149
+ bun run generate
150
+
151
+ # 4. 아키텍처 검사
152
+ bun run guard
153
+
154
+ # 5. 테스트
155
+ bun test
156
+
157
+ # 6. 개발 서버
158
+ bun run dev
159
+ ```
160
+
161
+ ## 테스트
162
+
163
+ Bun 테스트 프레임워크를 기본 지원합니다.
164
+
165
+ ```bash
166
+ bun test # 테스트 실행
167
+ bun test --watch # 감시 모드
168
+ ```
169
+
170
+ ## 요구 사항
171
+
172
+ - Bun >= 1.0.0
173
+ - React >= 18.0.0
174
+
175
+ ## 관련 패키지
176
+
177
+ - [@mandujs/core](https://www.npmjs.com/package/@mandujs/core) - 핵심 런타임
178
+
179
+ ## 라이선스
180
+
181
+ MIT