lee-spec-kit 0.6.15 โ†’ 0.6.17

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "lee-spec-kit",
3
- "version": "0.6.15",
3
+ "version": "0.6.17",
4
4
  "description": "Project documentation structure generator for AI-assisted development",
5
5
  "type": "module",
6
6
  "bin": {
@@ -2,6 +2,30 @@
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
+ # (recommended once at start) run onboarding checks
9
+ npx lee-spec-kit onboard --strict
10
+
11
+ # 1) Detect project
12
+ npx lee-spec-kit detect --json
13
+
14
+ # 2) If detected, read context first
15
+ npx lee-spec-kit context --json-compact
16
+ ```
17
+
18
+ - Apply lee-spec-kit workflow only when `isLeeSpecKitProject: true`.
19
+ - When `actionOptions` exist, show `approvalPrompt`/`finalPrompt` exactly as provided and wait for user approval (`<LABEL>` or `<LABEL> OK`) before execution.
20
+ - If `isLeeSpecKitProject: false`, skip lee-spec-kit-specific flow and continue with normal workflow.
21
+
22
+ ## New Project Start Order
23
+
24
+ - Scaffold the code project first (for example Next.js/NestJS), then run `lee-spec-kit init`.
25
+ - After that, verify detection with `detect --json`, then continue with `feature` and `context`.
26
+ - In most cases (default: embedded), the steps above are all you need.
27
+ - Choose standalone only when docs are managed separately from the code repo. In that case, prefer running init from a parent workspace folder (for example `workspace/docs`, `workspace/project`) and set both docs/project paths together. (e.g. `npx lee-spec-kit init --docs-repo standalone --dir ./docs --project-root ./project`)
28
+
5
29
  ## Directory Structure
6
30
 
7
31
  | Path | Purpose | Key Documents |
@@ -33,7 +33,7 @@ Prohibited:
33
33
  ## ๐Ÿงพ Label Response Contract (SSOT)
34
34
 
35
35
  - End **every user-facing reply** with current status + available labels.
36
- - Use the latest `npx lee-spec-kit context --json` (or `flow --json`) as source.
36
+ - Use the latest `npx lee-spec-kit context --json-compact` as the default source (fallback: `context --json` or `flow --json` when full detail is required).
37
37
  - Use `actionOptions[].detail` or command `cmd` **verbatim**. Do not paraphrase.
38
38
  - Even when the user asks something else, append the same label block at the end if executable labels exist.
39
39
  - If no executable labels exist, print `Available labels: none` and guide re-check with `npx lee-spec-kit context`.
@@ -74,8 +74,9 @@ Include the artifacts in the PR body.
74
74
 
75
75
  > - If this includes UI changes, include **screenshots**.
76
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.
77
78
 
78
- #### UI changes (Frontend PR)
79
+ #### UI changes
79
80
 
80
81
  - Default is `pr.screenshots.upload: false`. If you need upload/URL inclusion, enable it in `.lee-spec-kit.json`.
81
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.
@@ -135,9 +136,10 @@ gh release upload "$TAG" /tmp/lee-spec-kit/pr-assets/* --clobber
135
136
  echo \"![](https://github.com/${REPO}/releases/download/${TAG}/ui-1.png)\"
136
137
  ```
137
138
 
138
- #### Logic/structure changes (Backend PR)
139
+ #### Logic/structure changes
139
140
 
140
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.
141
143
 
142
144
  ### 4. Request User Approval + Move to `Ready`
143
145
 
@@ -22,12 +22,8 @@
22
22
  - [ ] (verifiable criterion 1)
23
23
  - [ ] (verifiable criterion 2)
24
24
 
25
- ## Out of Scope
26
-
27
- - (what this issue does not cover)
28
-
29
25
  ## Related Docs
30
26
 
31
- - Spec: `./spec.md`
32
- - Plan: `./plan.md`
33
- - Tasks: `./tasks.md`
27
+ - Spec: `docs/.../spec.md`
28
+ - Plan: `docs/.../plan.md`
29
+ - Tasks: `docs/.../tasks.md`
@@ -27,6 +27,6 @@
27
27
 
28
28
  ## Related Docs
29
29
 
30
- - Spec: `./spec.md`
31
- - Tasks: `./tasks.md`
32
- - Decisions: `./decisions.md`
30
+ - Spec: `docs/.../spec.md`
31
+ - Tasks: `docs/.../tasks.md`
32
+ - Decisions: `docs/.../decisions.md`
@@ -2,6 +2,30 @@
2
2
 
3
3
  ์—์ด์ „ํŠธ๊ฐ€ ํ”„๋กœ์ ํŠธ ์ „๋ฐ˜์„ ๋น ๋ฅด๊ฒŒ ํŒŒ์•…ํ•  ์ˆ˜ ์žˆ๋„๋ก ๋ฌธ์„œ๋ฅผ ๊ธฐ๋Šฅ๋ณ„๋กœ ๋ถ„๋ฆฌํ•ด ๋‘์—ˆ์Šต๋‹ˆ๋‹ค.
4
4
 
5
+ ## ์—์ด์ „ํŠธ ์„ธ์…˜ ์‹œ์ž‘ ์ฒดํฌ๋ฆฌ์ŠคํŠธ
6
+
7
+ ```bash
8
+ # (์ตœ์ดˆ 1ํšŒ ๊ถŒ์žฅ) ์ดˆ๊ธฐ ์˜จ๋ณด๋”ฉ ์ ๊ฒ€
9
+ npx lee-spec-kit onboard --strict
10
+
11
+ # 1) ํ”„๋กœ์ ํŠธ ๊ฐ์ง€
12
+ npx lee-spec-kit detect --json
13
+
14
+ # 2) ๊ฐ์ง€ ์„ฑ๊ณต ์‹œ ์ปจํ…์ŠคํŠธ ์กฐํšŒ
15
+ npx lee-spec-kit context --json-compact
16
+ ```
17
+
18
+ - `isLeeSpecKitProject: true`์ผ ๋•Œ๋งŒ lee-spec-kit ์›Œํฌํ”Œ๋กœ์šฐ๋ฅผ ์ ์šฉํ•ฉ๋‹ˆ๋‹ค.
19
+ - `actionOptions`๊ฐ€ ์žˆ์œผ๋ฉด `approvalPrompt`/`finalPrompt`๋ฅผ ๊ทธ๋Œ€๋กœ ์‚ฌ์šฉ์ž์—๊ฒŒ ๋ณด์—ฌ์ฃผ๊ณ  ์Šน์ธ(`<LABEL>` ๋˜๋Š” `<LABEL> OK`)์„ ๋ฐ›์€ ๋’ค ์‹คํ–‰ํ•ฉ๋‹ˆ๋‹ค.
20
+ - `isLeeSpecKitProject: false`๋ฉด lee-spec-kit ์ „์šฉ ์ ˆ์ฐจ๋ฅผ ๊ฑด๋„ˆ๋›ฐ๊ณ  ์ผ๋ฐ˜ ์›Œํฌํ”Œ๋กœ์šฐ๋กœ ์ง„ํ–‰ํ•ฉ๋‹ˆ๋‹ค.
21
+
22
+ ## ์‹ ๊ทœ ํ”„๋กœ์ ํŠธ ์‹œ์ž‘ ์ˆœ์„œ
23
+
24
+ - ์ฝ”๋“œ ํ”„๋กœ์ ํŠธ ์Šค์บํด๋”ฉ(์˜ˆ: Next.js/NestJS) ํ›„ `lee-spec-kit init`์„ ์‹คํ–‰ํ•˜์„ธ์š”.
25
+ - ๊ทธ ๋‹ค์Œ `detect --json`์œผ๋กœ ๊ฐ์ง€ ๊ฒฐ๊ณผ๋ฅผ ํ™•์ธํ•˜๊ณ , `feature`/`context` ์ˆœ์„œ๋กœ ์ง„ํ–‰ํ•˜์„ธ์š”.
26
+ - ๋Œ€๋ถ€๋ถ„์˜ ๊ฒฝ์šฐ(๊ธฐ๋ณธ๊ฐ’: embedded) ์œ„ ์ˆœ์„œ๋งŒ ๋”ฐ๋ฅด๋ฉด ๋ฉ๋‹ˆ๋‹ค.
27
+ - docs๋ฅผ ์ฝ”๋“œ ์ €์žฅ์†Œ์™€ ๋ถ„๋ฆฌํ•ด ์šด์˜ํ•  ๋•Œ๋งŒ standalone์„ ์„ ํƒํ•˜์„ธ์š”. ์ด๋•Œ๋Š” ์ƒ์œ„ ์›Œํฌ์ŠคํŽ˜์ด์Šค ํด๋”(์˜ˆ: `workspace/docs`, `workspace/project`)์—์„œ `init`์„ ์‹คํ–‰ํ•ด docs/project ๊ฒฝ๋กœ๋ฅผ ํ•จ๊ป˜ ์ง€์ •ํ•˜๋Š” ๋ฐฉ์‹์„ ๊ถŒ์žฅํ•ฉ๋‹ˆ๋‹ค. (์˜ˆ: `npx lee-spec-kit init --docs-repo standalone --dir ./docs --project-root ./project`)
28
+
5
29
  ## ์ƒ์œ„ ๊ตฌ์กฐ ์š”์•ฝ
6
30
 
7
31
  | ๊ฒฝ๋กœ | ๋ชฉ์  | ํ•ต์‹ฌ ๋ฌธ์„œ/์—ญํ•  |
@@ -33,7 +33,7 @@
33
33
  ## ๐Ÿงพ ๋ผ๋ฒจ ์‘๋‹ต ๊ณ„์•ฝ (SSOT)
34
34
 
35
35
  - ์‚ฌ์šฉ์ž์—๊ฒŒ ๋ณด๋‚ด๋Š” **๋ชจ๋“  ์‘๋‹ต์˜ ๋งˆ์ง€๋ง‰**์— ํ˜„์žฌ ์ƒํƒœ + ์„ ํƒ ๊ฐ€๋Šฅํ•œ ๋ผ๋ฒจ์„ ํ‘œ์‹œํ•ฉ๋‹ˆ๋‹ค.
36
- - ๊ธฐ์ค€ ๋ฐ์ดํ„ฐ๋Š” ์ตœ์‹  `npx lee-spec-kit context --json`(๋˜๋Š” `flow --json`)์ž…๋‹ˆ๋‹ค.
36
+ - ๊ธฐ์ค€ ๋ฐ์ดํ„ฐ๋Š” ์ตœ์‹  `npx lee-spec-kit context --json-compact`๋ฅผ ๊ธฐ๋ณธ์œผ๋กœ ์‚ฌ์šฉํ•˜๊ณ , ์ƒ์„ธ ํ•„๋“œ๊ฐ€ ํ•„์š”ํ•  ๋•Œ๋งŒ `context --json`(๋˜๋Š” `flow --json`)์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.
37
37
  - ๋ผ๋ฒจ ์„ค๋ช…์€ `actionOptions[].detail` ๋˜๋Š” command `cmd`๋ฅผ **์›๋ฌธ ๊ทธ๋Œ€๋กœ** ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. (์š”์•ฝ/์˜์—ญ ๊ธˆ์ง€)
38
38
  - ์‚ฌ์šฉ์ž๊ฐ€ ๋‹ค๋ฅธ ์งˆ๋ฌธ์„ ํ•˜๋”๋ผ๋„, ์‹คํ–‰ ๊ฐ€๋Šฅํ•œ ๋ผ๋ฒจ์ด ์žˆ์œผ๋ฉด ์‘๋‹ต ๋งˆ์ง€๋ง‰์— ๋™์ผ ๋ธ”๋ก์„ ๋‹ค์‹œ ํ‘œ์‹œํ•ฉ๋‹ˆ๋‹ค.
39
39
  - ์‹คํ–‰ ๊ฐ€๋Šฅํ•œ ๋ผ๋ฒจ์ด ์—†์œผ๋ฉด `์„ ํƒ ๊ฐ€๋Šฅ: ์—†์Œ` + `npx lee-spec-kit context` ์žฌํ™•์ธ์„ ์•ˆ๋‚ดํ•ฉ๋‹ˆ๋‹ค.
@@ -74,8 +74,9 @@ PR ๋ณธ๋ฌธ์— ๊ฒฐ๊ณผ๋ฌผ์„ ํฌํ•จํ•ฉ๋‹ˆ๋‹ค.
74
74
 
75
75
  > - UI ๋ณ€๊ฒฝ์— ํ•ด๋‹น๋œ๋‹ค๋ฉด **์Šคํฌ๋ฆฐ์ƒท์„** ํฌํ•จํ•˜์„ธ์š”.
76
76
  > - ๋กœ์ง/๊ตฌ์กฐ ๋ณ€๊ฒฝ์— ํ•ด๋‹น๋œ๋‹ค๋ฉด **๋‹ค์ด์–ด๊ทธ๋žจ์„** ํฌํ•จํ•˜์„ธ์š”.
77
+ > - `--mermaid auto`๋Š” ๊ธฐ๋ณธ์ ์œผ๋กœ ๋‹ค์ด์–ด๊ทธ๋žจ์„ ํฌํ•จํ•ฉ๋‹ˆ๋‹ค. ๋กœ์ง/๊ตฌ์กฐ ๋ณ€๊ฒฝ์ด ์ „ํ˜€ ์—†๋Š” ๊ฒฝ์šฐ์—๋งŒ `--mermaid off`๋ฅผ ์‚ฌ์šฉํ•˜์„ธ์š”.
77
78
 
78
- #### UI ๋ณ€๊ฒฝ (ํ”„๋ก ํŠธ์—”๋“œ PR)
79
+ #### UI ๋ณ€๊ฒฝ
79
80
 
80
81
  - ๊ธฐ๋ณธ๊ฐ’์€ `pr.screenshots.upload: false`์ž…๋‹ˆ๋‹ค. ์—…๋กœ๋“œ/URL ํฌํ•จ์ด ํ•„์š”ํ•˜๋‹ค๋ฉด `.lee-spec-kit.json`์—์„œ `true`๋กœ ์ผœ์„ธ์š”.
81
82
  - `.lee-spec-kit.json`์—์„œ `pr.screenshots.upload: false`๋ผ๋ฉด **์—…๋กœ๋“œ/URL ํฌํ•จ์„ ํ•˜์ง€ ์•Š์œผ๋ฉฐ**, PR ๋ณธ๋ฌธ์—์„œ๋„ **"์Šคํฌ๋ฆฐ์ƒท" ์„น์…˜์„ ๋งŒ๋“ค์ง€ ์•Š์Šต๋‹ˆ๋‹ค.**
@@ -135,9 +136,10 @@ gh release upload "$TAG" /tmp/lee-spec-kit/pr-assets/* --clobber
135
136
  echo \"![](https://github.com/${REPO}/releases/download/${TAG}/ui-1.png)\"
136
137
  ```
137
138
 
138
- #### ๋กœ์ง/๊ตฌ์กฐ ๋ณ€๊ฒฝ (๋ฐฑ์—”๋“œ PR)
139
+ #### ๋กœ์ง/๊ตฌ์กฐ ๋ณ€๊ฒฝ
139
140
 
140
141
  - PR ๋ณธ๋ฌธ์— Mermaid **`sequenceDiagram`**์„ ์ž‘์„ฑํ•˜๊ณ , ์ƒ์„ฑ๋œ ๋ณธ๋ฌธ ํ…œํ”Œ๋ฆฟ ํ˜•์‹๊ณผ ์ผ์น˜ํ•˜๊ฒŒ ์œ ์ง€ํ•ฉ๋‹ˆ๋‹ค.
142
+ - ์ด ๊ธฐ์ค€์€ ํ”„๋ก ํŠธ/๋ฐฑ์—”๋“œ ๊ตฌ๋ถ„์ด ์•„๋‹ˆ๋ผ ๋ณ€๊ฒฝ ์œ ํ˜•(๋กœ์ง/๊ตฌ์กฐ) ๊ธฐ์ค€์œผ๋กœ ์ ์šฉํ•ฉ๋‹ˆ๋‹ค.
141
143
 
142
144
  ### 4. ์‚ฌ์šฉ์ž ํ™•์ธ ์š”์ฒญ + `Ready` ์ „ํ™˜
143
145
 
@@ -22,12 +22,8 @@
22
22
  - [ ] (๊ฒ€์ฆ ๊ฐ€๋Šฅํ•œ ์™„๋ฃŒ ๊ธฐ์ค€ 1)
23
23
  - [ ] (๊ฒ€์ฆ ๊ฐ€๋Šฅํ•œ ์™„๋ฃŒ ๊ธฐ์ค€ 2)
24
24
 
25
- ## ์ œ์™ธ ๋ฒ”์œ„
26
-
27
- - (์ด๋ฒˆ ์ด์Šˆ์—์„œ ๋‹ค๋ฃจ์ง€ ์•Š๋Š” ๋‚ด์šฉ)
28
-
29
25
  ## ๊ด€๋ จ ๋ฌธ์„œ
30
26
 
31
- - Spec: `./spec.md`
32
- - Plan: `./plan.md`
33
- - Tasks: `./tasks.md`
27
+ - Spec: `docs/.../spec.md`
28
+ - Plan: `docs/.../plan.md`
29
+ - Tasks: `docs/.../tasks.md`
@@ -27,6 +27,6 @@
27
27
 
28
28
  ## ๊ด€๋ จ ๋ฌธ์„œ
29
29
 
30
- - Spec: `./spec.md`
31
- - Tasks: `./tasks.md`
32
- - Decisions: `./decisions.md`
30
+ - Spec: `docs/.../spec.md`
31
+ - Tasks: `docs/.../tasks.md`
32
+ - Decisions: `docs/.../decisions.md`