lee-spec-kit 0.4.12 → 0.4.14

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.
Files changed (32) hide show
  1. package/README.en.md +54 -1
  2. package/README.md +58 -1
  3. package/dist/index.js +314 -124
  4. package/package.json +1 -1
  5. package/templates/en/common/agents/pr-template.md +21 -3
  6. package/templates/en/common/agents/skills/create-feature.md +2 -16
  7. package/templates/en/common/agents/skills/create-pr.md +24 -4
  8. package/templates/en/common/agents/skills/execute-task.md +5 -3
  9. package/templates/en/fullstack/README.md +5 -2
  10. package/templates/en/fullstack/agents/agents.md +2 -1
  11. package/templates/en/fullstack/features/feature-base/plan.md +1 -1
  12. package/templates/en/fullstack/features/feature-base/spec.md +1 -1
  13. package/templates/en/fullstack/features/feature-base/tasks.md +10 -1
  14. package/templates/en/single/README.md +5 -2
  15. package/templates/en/single/agents/agents.md +2 -1
  16. package/templates/en/single/features/feature-base/plan.md +1 -1
  17. package/templates/en/single/features/feature-base/spec.md +1 -1
  18. package/templates/en/single/features/feature-base/tasks.md +10 -1
  19. package/templates/ko/common/agents/pr-template.md +21 -3
  20. package/templates/ko/common/agents/skills/create-feature.md +2 -16
  21. package/templates/ko/common/agents/skills/create-pr.md +24 -4
  22. package/templates/ko/common/agents/skills/execute-task.md +7 -13
  23. package/templates/ko/fullstack/README.md +5 -2
  24. package/templates/ko/fullstack/agents/agents.md +2 -1
  25. package/templates/ko/fullstack/features/feature-base/plan.md +1 -1
  26. package/templates/ko/fullstack/features/feature-base/spec.md +1 -1
  27. package/templates/ko/fullstack/features/feature-base/tasks.md +11 -2
  28. package/templates/ko/single/README.md +5 -2
  29. package/templates/ko/single/agents/agents.md +2 -1
  30. package/templates/ko/single/features/feature-base/plan.md +1 -1
  31. package/templates/ko/single/features/feature-base/spec.md +1 -1
  32. package/templates/ko/single/features/feature-base/tasks.md +11 -2
package/README.en.md CHANGED
@@ -168,7 +168,9 @@ Running `init` creates `.lee-spec-kit.json` in your docs root (default: `docs/`)
168
168
  "projectType": "single",
169
169
  "lang": "en",
170
170
  "createdAt": "YYYY-MM-DD",
171
- "docsRepo": "embedded"
171
+ "docsRepo": "embedded",
172
+ "pr": { "screenshots": { "upload": false } },
173
+ "approval": { "mode": "builtin" }
172
174
  }
173
175
  ```
174
176
 
@@ -182,10 +184,61 @@ Running `init` creates `.lee-spec-kit.json` in your docs root (default: `docs/`)
182
184
  | `pushDocs` | (standalone only) whether to manage/push docs repo as a separate git repo |
183
185
  | `docsRemote` | (standalone + pushDocs) docs repo remote URL |
184
186
  | `projectRoot` | (standalone only) project repo path (single: string, fullstack: {fe, be}) |
187
+ | `pr` | (optional) PR artifacts policy (e.g. screenshot upload) |
188
+ | `approval` | (optional) Override CHECK-required policy in `context` output (for automation/semi-auto) |
185
189
 
186
190
  > In standalone mode, `init` can add `pushDocs`, `docsRemote`, and `projectRoot` to this config.
187
191
  > If you run the CLI outside the docs repo in standalone mode, set `LEE_SPEC_KIT_DOCS_DIR` to the docs repo path.
188
192
 
193
+ ### approval (check policy)
194
+
195
+ `approval` only affects the following values produced by `context`:
196
+
197
+ - the `[CHECK required]` tag in text output
198
+ - `actions[].requiresUserCheck` in `context --json`
199
+ - `checkPolicy.token` (`context --json`): recommended approval token (`OK`)
200
+
201
+ > This does not enforce/deny execution by itself; it’s a signal for agents.
202
+ > If `approval` is omitted, it behaves as `builtin`. (No migration required)
203
+ > When `requiresUserCheck: true`, it’s recommended that agents wait for an explicit `OK` response before proceeding.
204
+
205
+ #### Modes
206
+
207
+ - `builtin` (default): keep built-in `requiresUserCheck` in steps/actions
208
+ - `category` (recommended): control CHECK policy by `actions[].category`
209
+ - `steps`: control by step numbers (not recommended; fragile)
210
+
211
+ #### Fields
212
+
213
+ - `default` (`category` only): `keep` | `require` | `skip` (default: `keep`)
214
+ - `requireCheckCategories` (`category` only): categories that **always** require CHECK (e.g. `["pr_create"]`, `["*"]`)
215
+ - `skipCheckCategories` (`category` only): categories that **never** require CHECK (e.g. `["docs_commit"]`, `["*"]`)
216
+ - `requireCheckSteps` (`steps` only): step numbers that require CHECK (e.g. `[3, 5, 12]`)
217
+
218
+ #### category examples
219
+
220
+ ```json
221
+ {
222
+ "approval": { "mode": "category", "default": "skip" }
223
+ }
224
+ ```
225
+
226
+ ```json
227
+ {
228
+ "approval": {
229
+ "mode": "category",
230
+ "default": "keep",
231
+ "skipCheckCategories": ["docs_commit"]
232
+ }
233
+ }
234
+ ```
235
+
236
+ > To discover available `category` values, check `actions[].category` in `context --json`.
237
+
238
+ ### pr (PR artifacts policy)
239
+
240
+ - `pr.screenshots.upload` (default: `false`): When `true`, agents may upload screenshots (e.g. GitHub Release assets) and include URLs in PR body. When `false`, agents should not upload/include URLs and should omit screenshot sections from the PR body.
241
+
189
242
  ## Generated Structure
190
243
 
191
244
  See the Korean README for the full tree examples and workflow details: `README.md`.
package/README.md CHANGED
@@ -149,6 +149,10 @@ npx lee-spec-kit context --json
149
149
 
150
150
  - `type: "command"`: `scope`(project|docs), `cwd`, `cmd` 제공 (복사하여 붙여넣기 가능한 형태로 `cd ... && git ...` 형태로 출력)
151
151
  - `type: "instruction"`: 사람이 수행해야 하는 안내 메시지
152
+ - `category`: 액션 분류 (자동화/반자동용 `approval.mode: "category"`에서 사용)
153
+ - `requiresUserCheck`: 사용자 확인 필요 여부 (에이전트는 **사용자 응답을 정확히 `OK`로 제한**하는 것을 권장 / 설정의 `approval`로 오버라이드 가능)
154
+
155
+ 또한 `checkPolicy`가 포함되어, 에이전트가 사용자 확인 정책을 적용할 때 참고할 수 있습니다. (`docPath`, `hint`, `token: "OK"`, `config`)
152
156
 
153
157
  ### 상태 확인
154
158
 
@@ -209,7 +213,9 @@ npx lee-spec-kit update --force
209
213
  "projectType": "single",
210
214
  "lang": "ko",
211
215
  "createdAt": "YYYY-MM-DD",
212
- "docsRepo": "embedded"
216
+ "docsRepo": "embedded",
217
+ "pr": { "screenshots": { "upload": false } },
218
+ "approval": { "mode": "builtin" }
213
219
  }
214
220
  ```
215
221
 
@@ -223,12 +229,63 @@ npx lee-spec-kit update --force
223
229
  | `pushDocs` | (standalone만) docs 레포를 별도 Git으로 관리/푸시할지 여부 |
224
230
  | `docsRemote` | (standalone+pushDocs) docs 레포 remote URL |
225
231
  | `projectRoot` | (standalone만) 프로젝트 레포지토리 경로 (single: string, fullstack: {fe, be}) |
232
+ | `pr` | (선택) PR 결과물 정책 (예: 스크린샷 업로드 여부) |
233
+ | `approval` | (선택) `context` 출력의 `[확인 필요]`/`requiresUserCheck` 정책 오버라이드 (자동화/반자동용) |
226
234
 
227
235
  > `docsRepo: "standalone"`을 선택하면 `pushDocs`, `docsRemote`, `projectRoot`가 추가됩니다.
228
236
 
229
237
  > 어디서 실행하든 설정을 찾을 수 있도록, CLI는 현재 디렉토리에서 상위로 올라가며 `.lee-spec-kit.json` 또는 `docs/.lee-spec-kit.json`을 탐색합니다.
230
238
  > standalone 환경에서 docs 레포 바깥(예: 프로젝트 레포)에서 실행해야 한다면 `LEE_SPEC_KIT_DOCS_DIR`에 docs 레포 경로를 지정할 수 있습니다.
231
239
 
240
+ ### approval (사용자 확인 정책)
241
+
242
+ `approval`은 `context`가 출력하는 다음 값에만 영향을 줍니다:
243
+
244
+ - 텍스트 출력의 `[확인 필요]` 표시
245
+ - `context --json`의 `actions[].requiresUserCheck`
246
+ - `checkPolicy.token` (`context --json`): 승인 토큰 (`OK`)
247
+
248
+ > 실제 명령 실행을 강제/차단하는 기능은 아닙니다. (에이전트가 참고하도록 신호를 제공)
249
+ > 기존 설정에 `approval`이 없으면 `builtin`으로 동작합니다. (마이그레이션 불필요)
250
+ > `requiresUserCheck: true`인 액션은 에이전트가 사용자로부터 **정확히 `OK` 응답**을 받은 뒤 진행하는 것을 권장합니다.
251
+
252
+ #### 모드
253
+
254
+ - `builtin` (기본): 코드에 내장된 `requiresUserCheck`를 그대로 사용
255
+ - `category` (권장): `actions[].category` 기준으로 확인 정책을 제어
256
+ - `steps`: step 번호 기준(변경에 취약하므로 권장하지 않음)
257
+
258
+ #### 설정 필드
259
+
260
+ - `default` (`category`만): `keep` | `require` | `skip` (기본: `keep`)
261
+ - `requireCheckCategories` (`category`만): 확인을 **항상** 요구할 category 목록 (예: `["pr_create"]`, `["*"]`)
262
+ - `skipCheckCategories` (`category`만): 확인을 **절대** 요구하지 않을 category 목록 (예: `["docs_commit"]`, `["*"]`)
263
+ - `requireCheckSteps` (`steps`만): 확인이 필요한 step 번호 목록 (예: `[3, 5, 12]`)
264
+
265
+ #### category 예시
266
+
267
+ ```json
268
+ {
269
+ "approval": { "mode": "category", "default": "skip" }
270
+ }
271
+ ```
272
+
273
+ ```json
274
+ {
275
+ "approval": {
276
+ "mode": "category",
277
+ "default": "keep",
278
+ "skipCheckCategories": ["docs_commit"]
279
+ }
280
+ }
281
+ ```
282
+
283
+ > 사용 가능한 `category` 값은 `context --json`의 `actions[].category`로 확인하는 것을 권장합니다.
284
+
285
+ ### pr (PR 결과물 정책)
286
+
287
+ - `pr.screenshots.upload` (기본: `false`): `true`면 스크린샷을 업로드(예: GitHub Release assets)하고 PR 본문에 URL을 포함할 수 있습니다. `false`면 업로드/URL 포함을 하지 않으며 PR 본문에서도 스크린샷 섹션을 만들지 않는 것을 권장합니다.
288
+
232
289
  ### Standalone 프로젝트 설정 예시
233
290
 
234
291
  **Single 프로젝트:**