lee-spec-kit 0.6.14 → 0.6.16

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 (20) hide show
  1. package/README.en.md +40 -1
  2. package/README.md +42 -1
  3. package/dist/index.js +513 -295
  4. package/package.json +1 -1
  5. package/templates/en/common/README.md +20 -0
  6. package/templates/en/common/agents/skills/create-issue.md +2 -3
  7. package/templates/en/common/agents/skills/create-pr.md +20 -4
  8. package/templates/en/common/features/README.md +11 -1
  9. package/templates/en/common/features/feature-base/issue.md +0 -1
  10. package/templates/en/common/features/feature-base/pr.md +0 -3
  11. package/templates/en/common/features/feature-base/spec.md +0 -1
  12. package/templates/en/common/features/feature-base/tasks.md +5 -0
  13. package/templates/ko/common/README.md +20 -0
  14. package/templates/ko/common/agents/skills/create-issue.md +2 -3
  15. package/templates/ko/common/agents/skills/create-pr.md +20 -4
  16. package/templates/ko/common/features/README.md +11 -1
  17. package/templates/ko/common/features/feature-base/issue.md +0 -1
  18. package/templates/ko/common/features/feature-base/pr.md +0 -3
  19. package/templates/ko/common/features/feature-base/spec.md +0 -1
  20. package/templates/ko/common/features/feature-base/tasks.md +5 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "lee-spec-kit",
3
- "version": "0.6.14",
3
+ "version": "0.6.16",
4
4
  "description": "Project documentation structure generator for AI-assisted development",
5
5
  "type": "module",
6
6
  "bin": {
package/templates/en/common/README.md CHANGED
@@ -2,6 +2,26 @@
2
2
 
3
3
  This documentation is organized by feature to help agents quickly understand the project.
4
4
 
5
+ ## Agent Session Start Checklist
6
+
7
+ ```bash
8
+ # 1) Detect project
9
+ npx lee-spec-kit detect --json
10
+
11
+ # 2) If detected, read context first
12
+ npx lee-spec-kit context --json
13
+ ```
14
+
15
+ - Apply lee-spec-kit workflow only when `isLeeSpecKitProject: true`.
16
+ - When `actionOptions` exist, show `approvalPrompt`/`finalPrompt` exactly as provided and wait for user approval (`<LABEL>` or `<LABEL> OK`) before execution.
17
+ - If `isLeeSpecKitProject: false`, skip lee-spec-kit-specific flow and continue with normal workflow.
18
+
19
+ ## New Project Start Order
20
+
21
+ - Scaffold the code project first (for example Next.js/NestJS), then run `lee-spec-kit init`.
22
+ - After that, verify detection with `detect --json`, then continue with `feature` and `context`.
23
+ - This sequence assumes default `docsRepo: embedded`. For `standalone`, run against the docs repo path (`--dir` or `LEE_SPEC_KIT_DOCS_DIR`).
24
+
5
25
  ## Directory Structure
6
26
 
7
27
  | Path | Purpose | Key Documents |
package/templates/en/common/agents/skills/create-issue.md CHANGED
@@ -64,9 +64,8 @@ npx lee-spec-kit github issue F001 --create --confirm OK --labels enhancement
64
64
  ```
65
65
 
66
66
  After creation:
67
- - sync created issue number into `issue.md`
68
- - sync issue number into `spec.md` and `tasks.md`
69
- - keep `issue.md` status as `Ready` (creation state is tracked by issue number/link fields)
67
+ - sync created issue number into `tasks.md`
68
+ - keep `issue.md` status as `Ready` (creation state is tracked in `tasks.md`)
70
69
 
71
70
  ---
72
71
 
package/templates/en/common/agents/skills/create-pr.md CHANGED
@@ -14,6 +14,20 @@ Execution-state SSOT is the feature-local `pr.md`.
14
14
 
15
15
  ---
16
16
 
17
+ ## Pre-PR Baseline Checklist (`builtin-checklist`)
18
+
19
+ Always run this checklist in Pre-PR review. Treat it as the minimum baseline, then use review skills for deeper inspection when available.
20
+
21
+ 1. Review alignment with `spec.md` / `plan.md` / `tasks.md` and confirm implementation still matches the original goal.
22
+ 2. Inspect regression, exception handling, critical/security risks, side effects, user flow impact, and release readiness.
23
+ 3. Check maintainability: split oversized functions/files when needed, reuse/integrate existing code where appropriate, and remove obsolete code.
24
+ 4. Run related test/verification commands (or explicitly record why they were not run).
25
+ 5. Update `Pre-PR Findings` in `tasks.md` as `major=<n>, minor=<n>`.
26
+ 6. Update `Pre-PR Evidence` with concrete proof (review links, logs, or doc paths).
27
+ 7. Set `Pre-PR Review` to `Done` only after the checklist is completed.
28
+
29
+ ---
30
+
17
31
  ## Steps
18
32
 
19
33
  ### 1. Prepare `pr.md` Draft
@@ -60,8 +74,9 @@ Include the artifacts in the PR body.
60
74
 
61
75
  > - If this includes UI changes, include **screenshots**.
62
76
  > - If this includes logic/structure changes, include a **diagram**.
77
+ > - `--mermaid auto` includes a diagram by default; use `--mermaid off` only when no logic/structure change exists.
63
78
 
64
- #### UI changes (Frontend PR)
79
+ #### UI changes
65
80
 
66
81
  - Default is `pr.screenshots.upload: false`. If you need upload/URL inclusion, enable it in `.lee-spec-kit.json`.
67
82
  - If `.lee-spec-kit.json` has `pr.screenshots.upload: false`, **do not upload/include URLs**, and **do not include a "Screenshots" section** in the PR body.
@@ -121,9 +136,10 @@ gh release upload "$TAG" /tmp/lee-spec-kit/pr-assets/* --clobber
121
136
  echo \"![](https://github.com/${REPO}/releases/download/${TAG}/ui-1.png)\"
122
137
  ```
123
138
 
124
- #### Logic/structure changes (Backend PR)
139
+ #### Logic/structure changes
125
140
 
126
141
  - Write a Mermaid **`sequenceDiagram`** in the PR body and keep it aligned with the generated body template format.
142
+ - Apply this rule based on change type (logic/structure), not by frontend/backend classification.
127
143
 
128
144
  ### 4. Request User Approval + Move to `Ready`
129
145
 
@@ -153,9 +169,9 @@ npx lee-spec-kit github pr F001 --create --confirm OK --labels enhancement
153
169
  ```
154
170
 
155
171
  After creation:
156
- - record created PR link into `pr.md` and `tasks.md`
172
+ - record created PR link into `tasks.md`
157
173
  - record/keep PR status as `Review`
158
- - keep `pr.md` status as `Ready` (creation/merge state is tracked by PR link + `PR Status`)
174
+ - keep `pr.md` status as `Ready` (creation/merge state is tracked by `tasks.md` PR/PR Status)
159
175
 
160
176
  ---
161
177
 
package/templates/en/common/features/README.md CHANGED
@@ -67,8 +67,18 @@ npx lee-spec-kit status --write
67
67
  | Document status | `Status` in `spec.md`/`plan.md`, `Doc Status` in `tasks.md` | `Draft` \| `Review` \| `Approved` |
68
68
  | Issue doc status | `Status` in `issue.md` | `Draft` \| `Ready` |
69
69
  | PR doc status | `Status` in `pr.md` | `Draft` \| `Ready` |
70
- | PR review status | `PR Status` in `tasks.md`/`pr.md` | `Review` \| `Approved` |
70
+ | PR review status | `PR Status` in `tasks.md` | `Review` \| `Approved` |
71
71
  | Pre-PR review status | `Pre-PR Review` in `tasks.md` | `Pending` \| `Done` |
72
+ | Pre-PR review findings | `Pre-PR Findings` in `tasks.md` | `major=<n>, minor=<n>` |
73
+ | Pre-PR review evidence | `Pre-PR Evidence` in `tasks.md` | evidence link/log/doc path |
74
+ | PR review findings | `PR Review Findings` in `tasks.md` | `major=<n>, minor=<n>` |
75
+ | PR review evidence | `PR Review Evidence` in `tasks.md` | required evidence link/log/doc path when total PR review findings > 0 |
76
+
77
+ ---
78
+
79
+ ## Pre-PR Fallback Checklist
80
+
81
+ Use `agents/skills/create-pr.md` (`Pre-PR Baseline Checklist`) as the default baseline for every Pre-PR review. Use review skills additionally for deeper inspection.
72
82
 
73
83
  ---
74
84
 
package/templates/en/common/features/feature-base/issue.md CHANGED
@@ -3,7 +3,6 @@
3
3
  ## Metadata
4
4
 
5
5
  - **Status**: Draft | Ready
6
- - **Issue Number**: #{issue-number}
7
6
  - **Title**: {feature-name}
8
7
  - **Labels**: enhancement
9
8
  - **Created**: {YYYY-MM-DD}
package/templates/en/common/features/feature-base/pr.md CHANGED
@@ -3,9 +3,6 @@
3
3
  ## Metadata
4
4
 
5
5
  - **Status**: Draft | Ready
6
- - **PR**: -
7
- - **PR Status**: -
8
- - Values: Review | Approved
9
6
  - **Base**: main
10
7
  - **Created**: {YYYY-MM-DD}
11
8
 
package/templates/en/common/features/feature-base/spec.md CHANGED
@@ -9,7 +9,6 @@
9
9
  - **Feature ID**: F{number}
10
10
  - **Feature Name**: {feature-name}
11
11
  - **Target Repo**: {{projectName}}-{component}
12
- - **Issue Number**: #{issue-number}
13
12
  - **Created**: {YYYY-MM-DD}
14
13
  - **Status**: Draft | Review | Approved
15
14
 
package/templates/en/common/features/feature-base/tasks.md CHANGED
@@ -26,6 +26,11 @@
26
26
  - Update with final findings counts from pre-PR review
27
27
  - **Pre-PR Evidence**: -
28
28
  - Example: review note link, log path, or docs path
29
+ - Follow `agents/skills/create-pr.md` (`Pre-PR Baseline Checklist`) as the default baseline
30
+ - **PR Review Findings**: major=0, minor=0
31
+ - Update with findings counts from PR review comment resolution
32
+ - **PR Review Evidence**: -
33
+ - Example: resolved/aligned comment link, verification log, or docs path
29
34
 
30
35
  ---
31
36
 
package/templates/ko/common/README.md CHANGED
@@ -2,6 +2,26 @@
2
2
 
3
3
  에이전트가 프로젝트 전반을 빠르게 파악할 수 있도록 문서를 기능별로 분리해 두었습니다.
4
4
 
5
+ ## 에이전트 세션 시작 체크리스트
6
+
7
+ ```bash
8
+ # 1) 프로젝트 감지
9
+ npx lee-spec-kit detect --json
10
+
11
+ # 2) 감지 성공 시 컨텍스트 조회
12
+ npx lee-spec-kit context --json
13
+ ```
14
+
15
+ - `isLeeSpecKitProject: true`일 때만 lee-spec-kit 워크플로우를 적용합니다.
16
+ - `actionOptions`가 있으면 `approvalPrompt`/`finalPrompt`를 그대로 사용자에게 보여주고 승인(`<LABEL>` 또는 `<LABEL> OK`)을 받은 뒤 실행합니다.
17
+ - `isLeeSpecKitProject: false`면 lee-spec-kit 전용 절차를 건너뛰고 일반 워크플로우로 진행합니다.
18
+
19
+ ## 신규 프로젝트 시작 순서
20
+
21
+ - 코드 프로젝트 스캐폴딩(예: Next.js/NestJS) 후 `lee-spec-kit init`을 실행하세요.
22
+ - 그 다음 `detect --json`으로 감지 결과를 확인하고, `feature`/`context` 순서로 진행하세요.
23
+ - 위 순서는 기본값인 `docsRepo: embedded` 기준입니다. `standalone`이면 docs 레포 경로 기준(`--dir` 또는 `LEE_SPEC_KIT_DOCS_DIR`)으로 실행하세요.
24
+
5
25
  ## 상위 구조 요약
6
26
 
7
27
  | 경로 | 목적 | 핵심 문서/역할 |
package/templates/ko/common/agents/skills/create-issue.md CHANGED
@@ -64,9 +64,8 @@ npx lee-spec-kit github issue F001 --create --confirm OK --labels enhancement
64
64
  ```
65
65
 
66
66
  생성 후:
67
- - 생성된 이슈 번호를 `issue.md`에 기록
68
- - `spec.md`, `tasks.md`의 이슈 번호도 동기화
69
- - `issue.md` 상태는 `Ready`로 유지 (`Issue Number`/링크 필드로 생성 상태를 관리)
67
+ - 생성된 이슈 번호를 `tasks.md`에 기록
68
+ - `issue.md` 상태는 `Ready`로 유지 (생성 상태는 `tasks.md`에서 관리)
70
69
 
71
70
  ---
72
71
 
package/templates/ko/common/agents/skills/create-pr.md CHANGED
@@ -14,6 +14,20 @@ Pull Request를 생성할 때 따르는 가이드입니다.
14
14
 
15
15
  ---
16
16
 
17
+ ## Pre-PR 기본 체크리스트(`builtin-checklist`)
18
+
19
+ Pre-PR 리뷰에서 항상 수행하는 최소 기준입니다. 가능한 경우 리뷰 스킬을 추가로 사용해 심화 검토를 진행하세요.
20
+
21
+ 1. `spec.md` / `plan.md` / `tasks.md` 기준으로 변경 범위 정합성을 확인하고, 구현이 원래 목적에 맞는지 점검합니다.
22
+ 2. 회귀/예외 처리, 크리티컬·보안 리스크, 사이드 이펙트, 사용자 흐름 영향, 배포 준비도를 점검합니다.
23
+ 3. 유지보수성을 점검합니다: 큰 함수/파일은 필요 시 분리하고, 기존 코드 재사용·통합 가능성을 확인하며, 불필요해진 코드를 정리합니다.
24
+ 4. 관련 테스트/검증 명령을 실행합니다. 실행하지 못했다면 사유를 명시합니다.
25
+ 5. `tasks.md`의 `PR 전 리뷰 Findings`를 `major=<n>, minor=<n>` 형식으로 최신화합니다.
26
+ 6. `PR 전 리뷰 Evidence`에 실제 근거(리뷰 링크, 로그, 문서 경로)를 기록합니다.
27
+ 7. 체크리스트 완료 후에만 `PR 전 리뷰`를 `Done`으로 변경합니다.
28
+
29
+ ---
30
+
17
31
  ## 단계
18
32
 
19
33
  ### 1. `pr.md` 본문 초안 준비
@@ -60,8 +74,9 @@ PR 본문에 결과물을 포함합니다.
60
74
 
61
75
  > - UI 변경에 해당된다면 **스크린샷을** 포함하세요.
62
76
  > - 로직/구조 변경에 해당된다면 **다이어그램을** 포함하세요.
77
+ > - `--mermaid auto`는 기본적으로 다이어그램을 포함합니다. 로직/구조 변경이 전혀 없는 경우에만 `--mermaid off`를 사용하세요.
63
78
 
64
- #### UI 변경 (프론트엔드 PR)
79
+ #### UI 변경
65
80
 
66
81
  - 기본값은 `pr.screenshots.upload: false`입니다. 업로드/URL 포함이 필요하다면 `.lee-spec-kit.json`에서 `true`로 켜세요.
67
82
  - `.lee-spec-kit.json`에서 `pr.screenshots.upload: false`라면 **업로드/URL 포함을 하지 않으며**, PR 본문에서도 **"스크린샷" 섹션을 만들지 않습니다.**
@@ -121,9 +136,10 @@ gh release upload "$TAG" /tmp/lee-spec-kit/pr-assets/* --clobber
121
136
  echo \"![](https://github.com/${REPO}/releases/download/${TAG}/ui-1.png)\"
122
137
  ```
123
138
 
124
- #### 로직/구조 변경 (백엔드 PR)
139
+ #### 로직/구조 변경
125
140
 
126
141
  - PR 본문에 Mermaid **`sequenceDiagram`**을 작성하고, 생성된 본문 템플릿 형식과 일치하게 유지합니다.
142
+ - 이 기준은 프론트/백엔드 구분이 아니라 변경 유형(로직/구조) 기준으로 적용합니다.
127
143
 
128
144
  ### 4. 사용자 확인 요청 + `Ready` 전환
129
145
 
@@ -153,9 +169,9 @@ npx lee-spec-kit github pr F001 --create --confirm OK --labels enhancement
153
169
  ```
154
170
 
155
171
  생성 후:
156
- - 생성된 PR 링크를 `pr.md`와 `tasks.md`에 기록
172
+ - 생성된 PR 링크를 `tasks.md`에 기록
157
173
  - PR 상태를 `Review`로 기록/유지
158
- - `pr.md` 상태는 `Ready`로 유지 (생성/머지 상태는 PR 링크 + `PR 상태`로 관리)
174
+ - `pr.md` 상태는 `Ready`로 유지 (생성/머지 상태는 `tasks.md`의 PR/PR 상태로 관리)
159
175
 
160
176
  ---
161
177
 
package/templates/ko/common/features/README.md CHANGED
@@ -67,8 +67,18 @@ npx lee-spec-kit status --write
67
67
  | 문서 상태 | `spec.md`/`plan.md`의 `상태`, `tasks.md`의 `문서 상태` | `Draft` \| `Review` \| `Approved` |
68
68
  | 이슈 문서 상태 | `issue.md`의 `상태` | `Draft` \| `Ready` |
69
69
  | PR 문서 상태 | `pr.md`의 `상태` | `Draft` \| `Ready` |
70
- | PR 리뷰 상태 | `tasks.md`/`pr.md`의 `PR 상태` | `Review` \| `Approved` |
70
+ | PR 리뷰 상태 | `tasks.md`의 `PR 상태` | `Review` \| `Approved` |
71
71
  | Pre-PR 리뷰 상태 | `tasks.md`의 `PR 전 리뷰` | `Pending` \| `Done` |
72
+ | Pre-PR 리뷰 Findings | `tasks.md`의 `PR 전 리뷰 Findings` | `major=<n>, minor=<n>` |
73
+ | Pre-PR 리뷰 Evidence | `tasks.md`의 `PR 전 리뷰 Evidence` | 근거 링크/로그/문서 경로 |
74
+ | PR 리뷰 Findings | `tasks.md`의 `PR 리뷰 Findings` | `major=<n>, minor=<n>` |
75
+ | PR 리뷰 Evidence | `tasks.md`의 `PR 리뷰 Evidence` | `PR 리뷰 Findings` 합계가 1 이상이면 근거 링크/로그/문서 경로 필수 |
76
+
77
+ ---
78
+
79
+ ## Pre-PR 폴백 체크리스트
80
+
81
+ 모든 Pre-PR 리뷰에서 `agents/skills/create-pr.md`의 `Pre-PR 기본 체크리스트`를 기본 베이스라인으로 사용하고, 리뷰 스킬은 심화 검토용으로 추가 사용하세요.
72
82
 
73
83
  ---
74
84
 
package/templates/ko/common/features/feature-base/issue.md CHANGED
@@ -3,7 +3,6 @@
3
3
  ## 메타데이터
4
4
 
5
5
  - **상태**: Draft | Ready
6
- - **이슈 번호**: #{이슈번호}
7
6
  - **제목**: {기능명}
8
7
  - **라벨**: enhancement
9
8
  - **작성일**: {YYYY-MM-DD}
package/templates/ko/common/features/feature-base/pr.md CHANGED
@@ -3,9 +3,6 @@
3
3
  ## 메타데이터
4
4
 
5
5
  - **상태**: Draft | Ready
6
- - **PR**: -
7
- - **PR 상태**: -
8
- - 값: Review | Approved
9
6
  - **Base**: main
10
7
  - **작성일**: {YYYY-MM-DD}
11
8
 
package/templates/ko/common/features/feature-base/spec.md CHANGED
@@ -9,7 +9,6 @@
9
9
  - **기능 ID**: F{번호}
10
10
  - **기능명**: {기능명}
11
11
  - **대상 레포**: {{projectName}}-{component}
12
- - **이슈 번호**: #{이슈번호}
13
12
  - **작성일**: {YYYY-MM-DD}
14
13
  - **상태**: Draft | Review | Approved
15
14
 
package/templates/ko/common/features/feature-base/tasks.md CHANGED
@@ -26,6 +26,11 @@
26
26
  - 사전 리뷰 최종 결과에 맞게 major/minor 건수를 갱신
27
27
  - **PR 전 리뷰 Evidence**: -
28
28
  - 예: 리뷰 노트 링크, 로그 경로, 문서 경로
29
+ - 기본 베이스라인으로 `agents/skills/create-pr.md`(`Pre-PR 기본 체크리스트`) 기준을 따르세요
30
+ - **PR 리뷰 Findings**: major=0, minor=0
31
+ - PR 리뷰 코멘트 반영 결과에 맞게 major/minor 건수를 갱신
32
+ - **PR 리뷰 Evidence**: -
33
+ - 예: 해결/합의한 코멘트 링크, 검증 로그, 관련 문서 경로
29
34
 
30
35
  ---
31
36