lee-spec-kit 0.1.2 → 0.1.5

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 (41) hide show
  1. package/README.md +5 -5
  2. package/dist/index.js +105 -53
  3. package/package.json +1 -1
  4. package/templates/en/fullstack/agents/agents.md +1 -1
  5. package/templates/en/fullstack/agents/constitution.md +5 -0
  6. package/templates/en/fullstack/agents/git-workflow.md +2 -0
  7. package/templates/en/fullstack/agents/issue-template.md +35 -1
  8. package/templates/en/fullstack/agents/pr-template.md +19 -1
  9. package/templates/en/fullstack/features/README.md +4 -4
  10. package/templates/en/fullstack/features/be/README.md +1 -1
  11. package/templates/en/fullstack/features/fe/README.md +1 -1
  12. package/templates/en/fullstack/features/feature-base/plan.md +2 -2
  13. package/templates/en/fullstack/features/feature-base/spec.md +4 -4
  14. package/templates/en/fullstack/features/feature-base/tasks.md +4 -4
  15. package/templates/en/fullstack/prd/README.md +5 -0
  16. package/templates/en/single/agents/agents.md +1 -1
  17. package/templates/en/single/agents/constitution.md +44 -39
  18. package/templates/en/single/agents/git-workflow.md +62 -60
  19. package/templates/en/single/agents/issue-template.md +66 -30
  20. package/templates/en/single/agents/pr-template.md +51 -31
  21. package/templates/en/single/features/README.md +2 -2
  22. package/templates/en/single/features/feature-base/plan.md +2 -2
  23. package/templates/en/single/features/feature-base/spec.md +4 -4
  24. package/templates/en/single/features/feature-base/tasks.md +4 -4
  25. package/templates/en/single/prd/README.md +14 -9
  26. package/templates/ko/fullstack/agents/agents.md +1 -1
  27. package/templates/ko/fullstack/agents/constitution.md +5 -0
  28. package/templates/ko/fullstack/agents/git-workflow.md +2 -0
  29. package/templates/ko/fullstack/agents/issue-template.md +36 -0
  30. package/templates/ko/fullstack/agents/pr-template.md +19 -1
  31. package/templates/ko/fullstack/features/README.md +4 -4
  32. package/templates/ko/fullstack/features/be/README.md +1 -1
  33. package/templates/ko/fullstack/features/fe/README.md +1 -1
  34. package/templates/ko/fullstack/prd/README.md +5 -0
  35. package/templates/ko/single/agents/agents.md +1 -1
  36. package/templates/ko/single/agents/constitution.md +5 -0
  37. package/templates/ko/single/agents/git-workflow.md +2 -0
  38. package/templates/ko/single/agents/issue-template.md +36 -0
  39. package/templates/ko/single/agents/pr-template.md +19 -1
  40. package/templates/ko/single/features/README.md +2 -2
  41. package/templates/ko/single/prd/README.md +5 -0
@@ -1,15 +1,20 @@
1
1
  # PRD (Product Requirements Document)
2
2
 
3
- 폴더에는 제품 요구사항 문서를 작성합니다.
3
+ This folder contains product requirements documents.
4
4
 
5
- ## 작성 가이드
5
+ > **📌 Document Scope**
6
+ >
7
+ > - **This folder**: Product requirements, business logic, user stories
8
+ > - **Constitution**: Tech stack, architecture principles, code quality, security principles → `agents/constitution.md`
6
9
 
7
- 1. 프로젝트 개요와 목표를 정의하세요
8
- 2. 주요 기능과 사용자 스토리를 작성하세요
9
- 3. 기술 아키텍처 개요를 포함하세요
10
+ ## Writing Guide
10
11
 
11
- ## 예시 파일
12
+ 1. Define project overview and goals
13
+ 2. Write main features and user stories
14
+ 3. Include technical architecture overview
12
15
 
13
- - `{project-name}-prd.md` - 메인 PRD 문서
14
- - `backend-overview.md` - 백엔드 아키텍처 (선택)
15
- - `frontend-overview.md` - 프론트엔드 아키텍처 (선택)
16
+ ## Example Files
17
+
18
+ - `{project-name}-prd.md` - Main PRD document
19
+ - `backend-overview.md` - Backend architecture (optional)
20
+ - `frontend-overview.md` - Frontend architecture (optional)
@@ -66,7 +66,7 @@ docs/
66
66
  ### 1. 새 기능 추가 요청
67
67
 
68
68
  1. 대상 레포 확인 (BE 또는 FE)
69
- 2. 새 기능 폴더 생성: `lee-spec-kit feature <name>` 또는 `docs/features/README.md` 참조
69
+ 2. 새 기능 폴더 생성: `npx lee-spec-kit feature <name>` 또는 `docs/features/README.md` 참조
70
70
  3. `spec.md` 작성 - 무엇을, 왜 만드는지 (기술 스택 X)
71
71
  4. 사용자에게 스펙 초안 확인 요청
72
72
  5. GitHub Issue 생성 (`agents/issue-template.md` 참조)
@@ -3,6 +3,11 @@
3
3
  프로젝트의 핵심 원칙과 기술 결정 가이드라인입니다.
4
4
  모든 개발 결정은 이 문서를 기준으로 합니다.
5
5
 
6
+ > **📌 문서 범위**
7
+ >
8
+ > - **이 문서**: 기술 스택, 아키텍처 원칙, 코드 품질, 보안 원칙
9
+ > - **PRD**: 제품 요구사항, 비즈니스 로직, 사용자 스토리 → `prd/*.md`
10
+
6
11
  ---
7
12
 
8
13
  ## 프로젝트 미션
@@ -46,6 +46,8 @@ main
46
46
 
47
47
  ## 커밋 컨벤션
48
48
 
49
+ > 📖 Type과 Description은 [Udacity Git Commit Message Style Guide](https://udacity.github.io/git-styleguide/)를 따릅니다.
50
+
49
51
  ### 형식
50
52
 
51
53
  ```
@@ -16,6 +16,33 @@ F{번호}: {기능명} ({짧은 설명})
16
16
 
17
17
  > "짧은 설명"은 한 줄로 의도를 전달할 수 있을 정도로만 작성합니다.
18
18
 
19
+ ### 링크 형식 (중요!)
20
+
21
+ GitHub Issue에서 링크는 **파일 위치에 따라** 다르게 작성:
22
+
23
+ 1. **프로젝트 레포 내 파일**: 전체 URL 사용 (클릭 가능)
24
+ - **일반 문서/코드** (이미 머지됨): `main` 브랜치
25
+ ```markdown
26
+ [파일명](https://github.com/{owner}/{repo}/blob/main/path/to/file)
27
+ ```
28
+ - **개발 중인 문서** (아직 머지 안 됨): **Feature 브랜치**
29
+ ```markdown
30
+ [파일명](https://github.com/{owner}/{repo}/blob/{feat-branch}/path/to/file)
31
+ ```
32
+
33
+ 2. **외부 문서 (공개 URL 있음)**: **절대 URL로 링크**
34
+
35
+ ```markdown
36
+ [react-i18next](https://react.i18next.com/)
37
+ ```
38
+
39
+ 3. **외부/로컬 문서** (docs 레포 등, URL 없음): **상대 경로 텍스트로만 표기**
40
+ ```text
41
+ ../docs/features/F001-feature-name/spec.md
42
+ ```
43
+
44
+ > ⚠️ 로컬 문서는 GitHub에서 클릭되지 않으므로, 링크 대신 경로 텍스트만 제공합니다.
45
+
19
46
  ---
20
47
 
21
48
  ## 이슈 본문 템플릿
@@ -58,3 +85,12 @@ F{번호}: {기능명} ({짧은 설명})
58
85
  | `backend` | BE 관련 |
59
86
  | `frontend` | FE 관련 |
60
87
  | `priority:high` | 높은 우선순위 |
88
+
89
+ ---
90
+
91
+ ## 본문 입력 규칙 (셸 실행 방지)
92
+
93
+ - 이슈 본문은 **`--body-file` 사용을 기본**으로 한다.
94
+ - 백틱(`)이나 `$()`가 포함된 본문을 `"..."`에 직접 넣으면 **셸에서 명령치환**될 수 있다.
95
+ - 여러 줄 본문은 `cat <<'EOF'` 형식의 **싱글 쿼트 heredoc**을 사용하고,
96
+ 필요한 변수는 **플레이스홀더 → sed 치환**으로 처리한다.
@@ -14,7 +14,16 @@ feat(#{이슈번호}): {기능명}
14
14
 
15
15
  예: `feat(#1): 사용자 인증 구현`
16
16
 
17
- ---
17
+ ### 링크 형식 (중요!)
18
+
19
+ PR 본문에서 레포 내 파일 링크는 **반드시 현재 브랜치명을 사용**:
20
+
21
+ ```markdown
22
+ [파일명](https://github.com/{owner}/{repo}/blob/{브랜치명}/docs/path/to/file.md)
23
+ ```
24
+
25
+ > ⚠️ `main` 브랜치 링크는 머지 전까지 404가 발생합니다!
26
+ > 반드시 **현재 피처 브랜치명** (예: `feat/5-feature-name`)을 사용하세요.
18
27
 
19
28
  ## PR 본문 템플릿
20
29
 
@@ -69,3 +78,12 @@ gh pr create \
69
78
  | 일반 Feature | Squash and Merge |
70
79
  | 긴급 Hotfix | Merge 또는 Rebase |
71
80
  | 문서 수정 | Squash and Merge |
81
+
82
+ ---
83
+
84
+ ## 본문 입력 규칙 (셸 실행 방지)
85
+
86
+ - PR 본문은 **`--body-file` 사용을 기본**으로 한다.
87
+ - 백틱(`)이나 `$()`가 포함된 본문을 `"..."`에 직접 넣으면 **셸에서 명령치환**될 수 있다.
88
+ - 여러 줄 본문은 `cat <<'EOF'` 형식의 **싱글 쿼트 heredoc**을 사용하고,
89
+ 필요한 변수는 **플레이스홀더 → sed 치환**으로 처리한다.
@@ -29,10 +29,10 @@ features/
29
29
 
30
30
  ```bash
31
31
  # Backend Feature
32
- lee-spec-kit feature --repo be user-auth
32
+ npx lee-spec-kit feature --repo be user-auth
33
33
 
34
34
  # Frontend Feature
35
- lee-spec-kit feature --repo fe user-profile
35
+ npx lee-spec-kit feature --repo fe user-profile
36
36
  ```
37
37
 
38
38
  > 💡 CLI는 `feature-base/`에서 템플릿을 복사하고 ID를 자동 채번합니다.
@@ -55,13 +55,13 @@ lee-spec-kit feature --repo fe user-profile
55
55
  Feature 진행 상태는 CLI로 한 번에 확인합니다.
56
56
 
57
57
  ```bash
58
- lee-spec-kit status
58
+ npx lee-spec-kit status
59
59
  ```
60
60
 
61
61
  파일로 저장:
62
62
 
63
63
  ```bash
64
- lee-spec-kit status --write
64
+ npx lee-spec-kit status --write
65
65
  ```
66
66
 
67
67
  ---
@@ -2,4 +2,4 @@
2
2
 
3
3
  이 폴더에 Backend Feature들이 생성됩니다.
4
4
 
5
- `lee-spec-kit feature --repo be <name>` 명령어로 새 Feature를 생성하세요.
5
+ `npx lee-spec-kit feature --repo be <name>` 명령어로 새 Feature를 생성하세요.
@@ -2,4 +2,4 @@
2
2
 
3
3
  이 폴더에 Frontend Feature들이 생성됩니다.
4
4
 
5
- `lee-spec-kit feature --repo fe <name>` 명령어로 새 Feature를 생성하세요.
5
+ `npx lee-spec-kit feature --repo fe <name>` 명령어로 새 Feature를 생성하세요.
@@ -2,6 +2,11 @@
2
2
 
3
3
  이 폴더에는 제품 요구사항 문서를 작성합니다.
4
4
 
5
+ > **📌 문서 범위**
6
+ >
7
+ > - **이 폴더**: 제품 요구사항, 비즈니스 로직, 사용자 스토리
8
+ > - **Constitution**: 기술 스택, 아키텍처 원칙, 코드 품질, 보안 원칙 → `agents/constitution.md`
9
+
5
10
  ## 작성 가이드
6
11
 
7
12
  1. 프로젝트 개요와 목표를 정의하세요
@@ -57,7 +57,7 @@ docs/
57
57
 
58
58
  ### 1. 새 기능 추가 요청
59
59
 
60
- 1. 새 기능 폴더 생성: `lee-spec-kit feature <name>`
60
+ 1. 새 기능 폴더 생성: `npx lee-spec-kit feature <name>`
61
61
  2. `spec.md` 작성 - 무엇을, 왜 만드는지
62
62
  3. 사용자에게 스펙 초안 확인 요청
63
63
  4. GitHub Issue 생성
@@ -3,6 +3,11 @@
3
3
  프로젝트의 핵심 원칙과 기술 결정 가이드라인입니다.
4
4
  모든 개발 결정은 이 문서를 기준으로 합니다.
5
5
 
6
+ > **📌 문서 범위**
7
+ >
8
+ > - **이 문서**: 기술 스택, 아키텍처 원칙, 코드 품질, 보안 원칙
9
+ > - **PRD**: 제품 요구사항, 비즈니스 로직, 사용자 스토리 → `prd/*.md`
10
+
6
11
  ---
7
12
 
8
13
  ## 프로젝트 미션
@@ -46,6 +46,8 @@ main
46
46
 
47
47
  ## 커밋 컨벤션
48
48
 
49
+ > 📖 Type과 Description은 [Udacity Git Commit Message Style Guide](https://udacity.github.io/git-styleguide/)를 따릅니다.
50
+
49
51
  ### 형식
50
52
 
51
53
  ```
@@ -16,6 +16,33 @@ F{번호}: {기능명} ({짧은 설명})
16
16
 
17
17
  > "짧은 설명"은 한 줄로 의도를 전달할 수 있을 정도로만 작성합니다.
18
18
 
19
+ ### 링크 형식 (중요!)
20
+
21
+ GitHub Issue에서 링크는 **파일 위치에 따라** 다르게 작성:
22
+
23
+ 1. **프로젝트 레포 내 파일**: 전체 URL 사용 (클릭 가능)
24
+ - **일반 문서/코드** (이미 머지됨): `main` 브랜치
25
+ ```markdown
26
+ [파일명](https://github.com/{owner}/{repo}/blob/main/path/to/file)
27
+ ```
28
+ - **개발 중인 문서** (아직 머지 안 됨): **Feature 브랜치**
29
+ ```markdown
30
+ [파일명](https://github.com/{owner}/{repo}/blob/{feat-branch}/path/to/file)
31
+ ```
32
+
33
+ 2. **외부 문서 (공개 URL 있음)**: **절대 URL로 링크**
34
+
35
+ ```markdown
36
+ [react-i18next](https://react.i18next.com/)
37
+ ```
38
+
39
+ 3. **외부/로컬 문서** (docs 레포 등, URL 없음): **상대 경로 텍스트로만 표기**
40
+ ```text
41
+ ../docs/features/F001-feature-name/spec.md
42
+ ```
43
+
44
+ > ⚠️ 로컬 문서는 GitHub에서 클릭되지 않으므로, 링크 대신 경로 텍스트만 제공합니다.
45
+
19
46
  ---
20
47
 
21
48
  ## 이슈 본문 템플릿
@@ -58,3 +85,12 @@ F{번호}: {기능명} ({짧은 설명})
58
85
  | `backend` | BE 관련 |
59
86
  | `frontend` | FE 관련 |
60
87
  | `priority:high` | 높은 우선순위 |
88
+
89
+ ---
90
+
91
+ ## 본문 입력 규칙 (셸 실행 방지)
92
+
93
+ - 이슈 본문은 **`--body-file` 사용을 기본**으로 한다.
94
+ - 백틱(`)이나 `$()`가 포함된 본문을 `"..."`에 직접 넣으면 **셸에서 명령치환**될 수 있다.
95
+ - 여러 줄 본문은 `cat <<'EOF'` 형식의 **싱글 쿼트 heredoc**을 사용하고,
96
+ 필요한 변수는 **플레이스홀더 → sed 치환**으로 처리한다.
@@ -14,7 +14,16 @@ feat(#{이슈번호}): {기능명}
14
14
 
15
15
  예: `feat(#1): 사용자 인증 구현`
16
16
 
17
- ---
17
+ ### 링크 형식 (중요!)
18
+
19
+ PR 본문에서 레포 내 파일 링크는 **반드시 현재 브랜치명을 사용**:
20
+
21
+ ```markdown
22
+ [파일명](https://github.com/{owner}/{repo}/blob/{브랜치명}/docs/path/to/file.md)
23
+ ```
24
+
25
+ > ⚠️ `main` 브랜치 링크는 머지 전까지 404가 발생합니다!
26
+ > 반드시 **현재 피처 브랜치명** (예: `feat/5-feature-name`)을 사용하세요.
18
27
 
19
28
  ## PR 본문 템플릿
20
29
 
@@ -69,3 +78,12 @@ gh pr create \
69
78
  | 일반 Feature | Squash and Merge |
70
79
  | 긴급 Hotfix | Merge 또는 Rebase |
71
80
  | 문서 수정 | Squash and Merge |
81
+
82
+ ---
83
+
84
+ ## 본문 입력 규칙 (셸 실행 방지)
85
+
86
+ - PR 본문은 **`--body-file` 사용을 기본**으로 한다.
87
+ - 백틱(`)이나 `$()`가 포함된 본문을 `"..."`에 직접 넣으면 **셸에서 명령치환**될 수 있다.
88
+ - 여러 줄 본문은 `cat <<'EOF'` 형식의 **싱글 쿼트 heredoc**을 사용하고,
89
+ 필요한 변수는 **플레이스홀더 → sed 치환**으로 처리한다.
@@ -22,7 +22,7 @@ features/
22
22
  ## 새 기능 생성
23
23
 
24
24
  ```bash
25
- lee-spec-kit feature user-auth
25
+ npx lee-spec-kit feature user-auth
26
26
  ```
27
27
 
28
28
  > 💡 CLI는 `feature-base/`에서 템플릿을 복사하고 ID를 자동 채번합니다.
@@ -41,7 +41,7 @@ lee-spec-kit feature user-auth
41
41
  ## 상태 확인
42
42
 
43
43
  ```bash
44
- lee-spec-kit status
44
+ npx lee-spec-kit status
45
45
  ```
46
46
 
47
47
  ---
@@ -2,6 +2,11 @@
2
2
 
3
3
  이 폴더에는 제품 요구사항 문서를 작성합니다.
4
4
 
5
+ > **📌 문서 범위**
6
+ >
7
+ > - **이 폴더**: 제품 요구사항, 비즈니스 로직, 사용자 스토리
8
+ > - **Constitution**: 기술 스택, 아키텍처 원칙, 코드 품질, 보안 원칙 → `agents/constitution.md`
9
+
5
10
  ## 작성 가이드
6
11
 
7
12
  1. 프로젝트 개요와 목표를 정의하세요