sdd-tool 1.0.1 → 1.2.0

package/templates/git/commitlint.config.js

@@ -0,0 +1,122 @@
+/**
+ * SDD 프로젝트용 commitlint 설정
+ *
+ * 사용법:
+ * 1. 이 파일을 프로젝트 루트에 복사
+ * 2. npm install --save-dev @commitlint/cli
+ * 3. Git hooks에서 commitlint 실행
+ */
+
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+
+  // 스펙 커밋 타입 추가
+  rules: {
+    'type-enum': [
+      2,
+      'always',
+      [
+        // SDD 스펙 타입
+        'spec', // 스펙 신규 생성
+        'spec-update', // 스펙 내용 수정
+        'spec-status', // 스펙 상태 변경
+        'plan', // 구현 계획
+        'tasks', // 작업 분해
+        'constitution', // Constitution 변경
+        'sdd-config', // SDD 설정 변경
+
+        // Conventional Commits 타입
+        'feat', // 새 기능
+        'fix', // 버그 수정
+        'docs', // 문서 변경
+        'style', // 코드 포맷팅
+        'refactor', // 리팩토링
+        'perf', // 성능 개선
+        'test', // 테스트
+        'build', // 빌드 시스템
+        'ci', // CI 설정
+        'chore', // 기타 작업
+        'revert', // 되돌리기
+      ],
+    ],
+
+    // 스코프 형식: 영문 소문자, 하이픈, 슬래시, 쉼표, 별표 허용
+    'scope-case': [2, 'always', 'lower-case'],
+    'scope-empty': [0], // 스코프는 선택사항
+
+    // 제목 규칙
+    'subject-case': [0], // 케이스 제한 없음 (한글 허용)
+    'subject-empty': [2, 'never'],
+    'subject-max-length': [2, 'always', 50],
+
+    // 본문 규칙
+    'body-max-line-length': [2, 'always', 72],
+
+    // 헤더 규칙
+    'header-max-length': [2, 'always', 72],
+  },
+
+  // 에러 메시지 한글화
+  prompt: {
+    messages: {
+      skip: '(엔터로 건너뛰기)',
+      max: '최대 %d자',
+      min: '최소 %d자',
+      emptyWarning: '비어있으면 안 됩니다',
+      upperLimitWarning: '글자 수 초과',
+      lowerLimitWarning: '글자 수 부족',
+    },
+    questions: {
+      type: {
+        description: '커밋 유형을 선택하세요',
+        enum: {
+          spec: { description: '스펙 신규 생성', title: 'Spec' },
+          'spec-update': { description: '스펙 내용 수정', title: 'Spec Update' },
+          'spec-status': { description: '스펙 상태 변경', title: 'Spec Status' },
+          plan: { description: '구현 계획', title: 'Plan' },
+          tasks: { description: '작업 분해', title: 'Tasks' },
+          constitution: { description: 'Constitution 변경', title: 'Constitution' },
+          'sdd-config': { description: 'SDD 설정 변경', title: 'SDD Config' },
+          feat: { description: '새 기능', title: 'Feature' },
+          fix: { description: '버그 수정', title: 'Fix' },
+          docs: { description: '문서 변경', title: 'Docs' },
+          style: { description: '코드 포맷팅', title: 'Style' },
+          refactor: { description: '리팩토링', title: 'Refactor' },
+          perf: { description: '성능 개선', title: 'Perf' },
+          test: { description: '테스트', title: 'Test' },
+          build: { description: '빌드 시스템', title: 'Build' },
+          ci: { description: 'CI 설정', title: 'CI' },
+          chore: { description: '기타 작업', title: 'Chore' },
+          revert: { description: '되돌리기', title: 'Revert' },
+        },
+      },
+      scope: {
+        description: '스코프를 입력하세요 (예: auth, auth/user-login)',
+      },
+      subject: {
+        description: '간결한 변경 설명을 입력하세요',
+      },
+      body: {
+        description: '상세한 변경 설명을 입력하세요 (선택)',
+      },
+      isBreaking: {
+        description: 'Breaking Change가 있나요?',
+      },
+      breakingBody: {
+        description: 'Breaking Change 상세 내용을 입력하세요',
+      },
+      breaking: {
+        description: 'Breaking Change 요약을 입력하세요',
+      },
+      isIssueAffected: {
+        description: '관련 이슈가 있나요?',
+      },
+      issuesBody: {
+        description: '이슈 참조 (예: Refs: #123)',
+      },
+      issues: {
+        description: '이슈 번호를 입력하세요',
+      },
+    },
+  },
+};

package/templates/github/branch-protection.md

@@ -0,0 +1,194 @@
+# GitHub Branch Protection 설정 가이드
+
+SDD 프로젝트에 권장하는 브랜치 보호 규칙입니다.
+
+## 설정 위치
+
+Repository → Settings → Branches → Add branch protection rule
+
+---
+
+## main 브랜치 규칙
+
+### Branch name pattern
+```
+main
+```
+
+### 권장 설정
+
+#### Protect matching branches
+
+- [x] **Require a pull request before merging**
+  - [x] Require approvals: `2`
+  - [x] Dismiss stale pull request approvals when new commits are pushed
+  - [x] Require review from Code Owners
+  - [ ] Restrict who can dismiss pull request reviews
+
+- [x] **Require status checks to pass before merging**
+  - [x] Require branches to be up to date before merging
+  - Status checks:
+    - `sdd-validate`
+    - `sdd-lint` (있는 경우)
+
+- [x] **Require conversation resolution before merging**
+
+- [ ] **Require signed commits** (선택)
+
+- [x] **Require linear history** (권장)
+
+- [ ] **Require merge queue** (대규모 팀)
+
+- [ ] **Require deployments to succeed** (CI/CD)
+
+#### Rules applied to everyone including administrators
+
+- [x] **Do not allow bypassing the above settings**
+
+---
+
+## constitution/* 브랜치 규칙
+
+### Branch name pattern
+```
+constitution/*
+```
+
+### 권장 설정
+
+- [x] **Require a pull request before merging**
+  - [x] Require approvals: `3` (더 많은 리뷰어)
+  - [x] Dismiss stale pull request approvals
+
+- [x] **Require status checks to pass**
+  - `sdd-validate`
+  - `constitution-check` (있는 경우)
+
+- [x] **Restrict who can push**
+  - 팀 리드, 아키텍트만
+
+---
+
+## spec/* 브랜치 규칙 (선택)
+
+작업 중인 스펙 브랜치는 보통 보호하지 않습니다.
+필요한 경우 아래 규칙을 적용할 수 있습니다.
+
+### Branch name pattern
+```
+spec/*
+```
+
+### 최소 설정 (선택)
+
+- [ ] Require a pull request (불필요)
+- [ ] Require status checks (불필요)
+- [x] **Allow force pushes** (히스토리 정리용)
+- [x] **Allow deletions** (병합 후 삭제)
+
+---
+
+## CODEOWNERS 설정
+
+`.github/CODEOWNERS` 파일을 생성하여 도메인별 리뷰어를 지정합니다.
+
+```
+# SDD 스펙 파일 오너십
+
+# 전역 스펙 관리자
+.sdd/ @sdd-maintainers
+
+# Constitution은 리드만
+.sdd/constitution.md @tech-leads @architects
+
+# 도메인별 오너
+.sdd/specs/auth/ @security-team
+.sdd/specs/billing/ @billing-team
+.sdd/specs/core/ @core-team
+
+# 도메인 설정
+.sdd/domains.yml @sdd-maintainers
+```
+
+---
+
+## 상태 체크 설정
+
+### GitHub Actions 워크플로우
+
+`.github/workflows/sdd-validate.yml` 파일이 있어야 상태 체크가 활성화됩니다.
+
+```yaml
+name: SDD Validate
+
+on:
+  pull_request:
+    paths:
+      - '.sdd/**'
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+      - name: Install SDD
+        run: npm install -g sdd-tool
+      - name: Validate Specs
+        run: sdd validate --ci
+```
+
+### 상태 체크 추가 방법
+
+1. 워크플로우 실행 후 (최소 1번)
+2. Settings → Branches → main 규칙 편집
+3. "Require status checks" 섹션
+4. 검색창에 `sdd-validate` 입력
+5. 체크 추가
+
+---
+
+## 빠른 설정 체크리스트
+
+### main 브랜치
+- [ ] Require PR with 2 approvals
+- [ ] Dismiss stale reviews
+- [ ] Require status checks (sdd-validate)
+- [ ] Require up-to-date branches
+- [ ] Require linear history
+
+### constitution/* 브랜치
+- [ ] Require PR with 3 approvals
+- [ ] Restrict push to leads only
+
+### 추가 설정
+- [ ] CODEOWNERS 파일 생성
+- [ ] GitHub Actions 워크플로우 추가
+- [ ] 자동 브랜치 삭제 활성화
+
+---
+
+## 문제 해결
+
+### "Status check not found"
+
+상태 체크가 보이지 않으면:
+1. 워크플로우가 최소 1번 실행되어야 함
+2. PR을 `.sdd/` 경로 변경으로 생성
+3. 워크플로우 이름 확인 (`sdd-validate`)
+
+### "Required reviews not satisfied"
+
+리뷰 수가 부족하면:
+1. 팀원에게 리뷰 요청
+2. CODEOWNERS에 정의된 오너 확인
+3. 본인 승인은 카운트 안 됨
+
+### Force push 필요
+
+보호된 브랜치에 force push가 필요하면:
+1. 임시로 규칙 비활성화
+2. 또는 새 브랜치에서 작업 후 PR

package/templates/github/workflows/sdd-labeler.yml

@@ -0,0 +1,125 @@
+# SDD PR 라벨러 워크플로우
+# 변경된 도메인에 따라 자동으로 라벨을 추가합니다
+
+name: SDD Labeler
+
+on:
+  pull_request:
+    types: [opened, synchronize]
+    paths:
+      - '.sdd/**'
+
+jobs:
+  label:
+    name: Add Labels
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Detect Changes
+        id: changes
+        run: |
+          # 변경된 도메인 감지
+          DOMAINS=$(git diff --name-only origin/${{ github.base_ref }} | \
+            grep "^\.sdd/specs/" | \
+            cut -d'/' -f3 | \
+            sort -u | \
+            tr '\n' ' ')
+          echo "domains=$DOMAINS" >> $GITHUB_OUTPUT
+
+          # Constitution 변경 감지
+          if git diff --name-only origin/${{ github.base_ref }} | grep -q "constitution.md"; then
+            echo "constitution=true" >> $GITHUB_OUTPUT
+          else
+            echo "constitution=false" >> $GITHUB_OUTPUT
+          fi
+
+          # 스펙 변경 타입 감지
+          ADDED=$(git diff --name-only --diff-filter=A origin/${{ github.base_ref }} | grep "^\.sdd/specs/" | wc -l)
+          MODIFIED=$(git diff --name-only --diff-filter=M origin/${{ github.base_ref }} | grep "^\.sdd/specs/" | wc -l)
+          DELETED=$(git diff --name-only --diff-filter=D origin/${{ github.base_ref }} | grep "^\.sdd/specs/" | wc -l)
+
+          if [ "$ADDED" -gt 0 ]; then
+            echo "has_added=true" >> $GITHUB_OUTPUT
+          fi
+          if [ "$MODIFIED" -gt 0 ]; then
+            echo "has_modified=true" >> $GITHUB_OUTPUT
+          fi
+          if [ "$DELETED" -gt 0 ]; then
+            echo "has_deleted=true" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Create Labels if Not Exist
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const domains = '${{ steps.changes.outputs.domains }}'.trim().split(' ').filter(Boolean);
+
+            const labelConfigs = [
+              ...domains.map(d => ({ name: `spec:${d}`, color: '0366d6', description: `${d} 도메인 스펙` })),
+              { name: 'constitution', color: 'b60205', description: 'Constitution 변경' },
+              { name: 'spec:new', color: '0e8a16', description: '새 스펙 추가' },
+              { name: 'spec:update', color: 'fbca04', description: '스펙 수정' },
+              { name: 'spec:remove', color: 'd93f0b', description: '스펙 삭제' },
+            ];
+
+            for (const label of labelConfigs) {
+              try {
+                await github.rest.issues.getLabel({
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  name: label.name,
+                });
+              } catch (e) {
+                if (e.status === 404) {
+                  await github.rest.issues.createLabel({
+                    owner: context.repo.owner,
+                    repo: context.repo.repo,
+                    name: label.name,
+                    color: label.color,
+                    description: label.description,
+                  });
+                }
+              }
+            }
+
+      - name: Apply Labels
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const labels = [];
+
+            // 도메인 라벨
+            const domains = '${{ steps.changes.outputs.domains }}'.trim().split(' ').filter(Boolean);
+            labels.push(...domains.map(d => `spec:${d}`));
+
+            // Constitution 라벨
+            if ('${{ steps.changes.outputs.constitution }}' === 'true') {
+              labels.push('constitution');
+            }
+
+            // 변경 타입 라벨
+            if ('${{ steps.changes.outputs.has_added }}' === 'true') {
+              labels.push('spec:new');
+            }
+            if ('${{ steps.changes.outputs.has_modified }}' === 'true') {
+              labels.push('spec:update');
+            }
+            if ('${{ steps.changes.outputs.has_deleted }}' === 'true') {
+              labels.push('spec:remove');
+            }
+
+            if (labels.length > 0) {
+              await github.rest.issues.addLabels({
+                issue_number: context.issue.number,
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                labels: labels,
+              });
+
+              console.log(`Added labels: ${labels.join(', ')}`);
+            }

package/templates/github/workflows/sdd-validate.yml

@@ -0,0 +1,85 @@
+# SDD 스펙 검증 워크플로우
+# .sdd/ 파일 변경 시 자동으로 스펙을 검증합니다
+
+name: SDD Validate
+
+on:
+  pull_request:
+    paths:
+      - '.sdd/**'
+  push:
+    branches:
+      - main
+      - master
+    paths:
+      - '.sdd/**'
+
+jobs:
+  validate:
+    name: Validate Specs
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Install SDD Tool
+        run: npm install -g sdd-tool
+
+      - name: Validate Specs
+        run: sdd validate --ci
+
+      - name: Check Dependencies
+        run: sdd validate --ci || true
+        continue-on-error: true
+
+      - name: Constitution Check
+        run: sdd validate --constitution --ci || true
+        continue-on-error: true
+
+      - name: Comment on PR (failure)
+        if: failure() && github.event_name == 'pull_request'
+        uses: actions/github-script@v7
+        with:
+          script: |
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: `## ❌ SDD 검증 실패
+
+스펙 검증에서 오류가 발견되었습니다.
+
+### 확인 방법
+\`\`\`bash
+sdd validate
+\`\`\`
+
+### 상세 로그
+[Actions 로그 확인](${context.payload.pull_request?.html_url}/checks)
+
+---
+*이 메시지는 자동으로 생성되었습니다.*`
+            })
+
+      - name: Comment on PR (success)
+        if: success() && github.event_name == 'pull_request'
+        uses: actions/github-script@v7
+        with:
+          script: |
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: `## ✅ SDD 검증 통과
+
+모든 스펙 검증을 통과했습니다.
+
+---
+*이 메시지는 자동으로 생성되었습니다.*`
+            })

package/templates/proposal.md

@@ -1,71 +1,71 @@
----
-id: CHG-{{ID}}
-status: draft
-created: {{DATE}}
----
-
-# 변경 제안: {{TITLE}}
-
-> 변경 목적 및 배경 설명
-
----
-
-## 배경
-
-왜 이 변경이 필요한가?
-
----
-
-## 영향 범위
-
-### 영향받는 스펙
-
-- `specs/{{SPEC_PATH}}`
-
-### 변경 유형
-
-- [ ] 신규 추가 (ADDED)
-- [ ] 수정 (MODIFIED)
-- [ ] 삭제 (REMOVED)
-
----
-
-## 변경 내용
-
-### ADDED
-
-(새로 추가되는 내용)
-
-### MODIFIED
-
-(수정되는 내용)
-
-#### Before
-
-```markdown
-기존 내용
-```
-
-#### After
-
-```markdown
-변경된 내용
-```
-
-### REMOVED
-
-(삭제되는 내용)
-
----
-
-## 리스크 평가
-
-- 영향도: 낮음/중간/높음
-- 복잡도: 낮음/중간/높음
-
----
-
-## 검토자
-
-- [ ] @reviewer1
-- [ ] @reviewer2
+---
+id: CHG-{{ID}}
+status: draft
+created: {{DATE}}
+---
+
+# 변경 제안: {{TITLE}}
+
+> 변경 목적 및 배경 설명
+
+---
+
+## 배경
+
+왜 이 변경이 필요한가?
+
+---
+
+## 영향 범위
+
+### 영향받는 스펙
+
+- `specs/{{SPEC_PATH}}`
+
+### 변경 유형
+
+- [ ] 신규 추가 (ADDED)
+- [ ] 수정 (MODIFIED)
+- [ ] 삭제 (REMOVED)
+
+---
+
+## 변경 내용
+
+### ADDED
+
+(새로 추가되는 내용)
+
+### MODIFIED
+
+(수정되는 내용)
+
+#### Before
+
+```markdown
+기존 내용
+```
+
+#### After
+
+```markdown
+변경된 내용
+```
+
+### REMOVED
+
+(삭제되는 내용)
+
+---
+
+## 리스크 평가
+
+- 영향도: 낮음/중간/높음
+- 복잡도: 낮음/중간/높음
+
+---
+
+## 검토자
+
+- [ ] @reviewer1
+- [ ] @reviewer2