codesyncer 1.0.0

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 (61) hide show
  1. package/LICENSE +31 -0
  2. package/README.ko.md +417 -0
  3. package/README.md +417 -0
  4. package/bin/codesyncer.js +3 -0
  5. package/dist/commands/add-repo.d.ts +3 -0
  6. package/dist/commands/add-repo.d.ts.map +1 -0
  7. package/dist/commands/add-repo.js +145 -0
  8. package/dist/commands/add-repo.js.map +1 -0
  9. package/dist/commands/init.d.ts +3 -0
  10. package/dist/commands/init.d.ts.map +1 -0
  11. package/dist/commands/init.js +489 -0
  12. package/dist/commands/init.js.map +1 -0
  13. package/dist/commands/update.d.ts +3 -0
  14. package/dist/commands/update.d.ts.map +1 -0
  15. package/dist/commands/update.js +123 -0
  16. package/dist/commands/update.js.map +1 -0
  17. package/dist/constants/keywords.d.ts +23 -0
  18. package/dist/constants/keywords.d.ts.map +1 -0
  19. package/dist/constants/keywords.js +133 -0
  20. package/dist/constants/keywords.js.map +1 -0
  21. package/dist/index.d.ts +3 -0
  22. package/dist/index.d.ts.map +1 -0
  23. package/dist/index.js +52 -0
  24. package/dist/index.js.map +1 -0
  25. package/dist/templates/en/architecture.md +147 -0
  26. package/dist/templates/en/claude.md +267 -0
  27. package/dist/templates/en/comment_guide.md +324 -0
  28. package/dist/templates/en/decisions.md +227 -0
  29. package/dist/templates/en/master.md +179 -0
  30. package/dist/templates/ko/architecture.md +147 -0
  31. package/dist/templates/ko/claude.md +267 -0
  32. package/dist/templates/ko/comment_guide.md +324 -0
  33. package/dist/templates/ko/decisions.md +227 -0
  34. package/dist/templates/ko/master.md +179 -0
  35. package/dist/types.d.ts +78 -0
  36. package/dist/types.d.ts.map +1 -0
  37. package/dist/types.js +16 -0
  38. package/dist/types.js.map +1 -0
  39. package/dist/utils/messages.d.ts +129 -0
  40. package/dist/utils/messages.d.ts.map +1 -0
  41. package/dist/utils/messages.js +168 -0
  42. package/dist/utils/messages.js.map +1 -0
  43. package/dist/utils/scanner.d.ts +11 -0
  44. package/dist/utils/scanner.d.ts.map +1 -0
  45. package/dist/utils/scanner.js +311 -0
  46. package/dist/utils/scanner.js.map +1 -0
  47. package/dist/utils/template-loader.d.ts +18 -0
  48. package/dist/utils/template-loader.d.ts.map +1 -0
  49. package/dist/utils/template-loader.js +496 -0
  50. package/dist/utils/template-loader.js.map +1 -0
  51. package/package.json +70 -0
  52. package/src/templates/en/architecture.md +147 -0
  53. package/src/templates/en/claude.md +267 -0
  54. package/src/templates/en/comment_guide.md +324 -0
  55. package/src/templates/en/decisions.md +227 -0
  56. package/src/templates/en/master.md +179 -0
  57. package/src/templates/ko/architecture.md +147 -0
  58. package/src/templates/ko/claude.md +267 -0
  59. package/src/templates/ko/comment_guide.md +324 -0
  60. package/src/templates/ko/decisions.md +227 -0
  61. package/src/templates/ko/master.md +179 -0
@@ -0,0 +1,147 @@
1
+ # ARCHITECTURE.md
2
+
3
+ > **자동 생성 문서** - 프로젝트 구조 및 통계
4
+ >
5
+ > 생성일: [TODAY]
6
+
7
+ ---
8
+
9
+ ## 📁 프로젝트 구조
10
+
11
+ ```
12
+ [PROJECT_NAME]/
13
+ ├── src/
14
+ │ ├── components/
15
+ │ ├── pages/
16
+ │ ├── services/
17
+ │ ├── utils/
18
+ │ └── types/
19
+ ├── package.json
20
+ └── tsconfig.json
21
+ ```
22
+
23
+ **업데이트**: "구조 업데이트" 명령으로 재스캔
24
+
25
+ ---
26
+
27
+ ## 📊 프로젝트 통계
28
+
29
+ - **총 파일**: 0개
30
+ - **TypeScript 파일**: 0개
31
+ - **JavaScript 파일**: 0개
32
+ - **컴포넌트**: 0개
33
+ - **라인 수**: 0줄
34
+
35
+ **업데이트**: "통계 업데이트" 명령으로 갱신
36
+
37
+ ---
38
+
39
+ ## 🔍 주석 태그 통계
40
+
41
+ - `@codesyncer-inference`: 0개
42
+ - `@codesyncer-decision`: 0개
43
+ - `@codesyncer-todo`: 0개
44
+ - `@codesyncer-rule`: 0개
45
+ - `@codesyncer-context`: 0개
46
+
47
+ **레거시 태그 (`@claude-*`)**: 0개
48
+
49
+ **업데이트**: 자동 스캔 또는 "통계 업데이트"
50
+
51
+ ---
52
+
53
+ ## 📝 TODO 목록
54
+
55
+ **확인 필요 항목**: 0개
56
+
57
+ 현재 TODO가 없습니다.
58
+
59
+ **검색**: `grep -r "@codesyncer-todo" ./src`
60
+
61
+ ---
62
+
63
+ ## 🏗️ 주요 컴포넌트/파일
64
+
65
+ ### Components
66
+ - 스캔 후 자동 추가됩니다
67
+
68
+ ### Pages
69
+ - 스캔 후 자동 추가됩니다
70
+
71
+ ### Services
72
+ - 스캔 후 자동 추가됩니다
73
+
74
+ ### Utils
75
+ - 스캔 후 자동 추가됩니다
76
+
77
+ ---
78
+
79
+ ## 🔌 API 엔드포인트
80
+
81
+ 발견된 API 엔드포인트가 없습니다.
82
+
83
+ **검색 패턴**: `/api/`, `fetch(`, `axios.`
84
+
85
+ ---
86
+
87
+ ## 📦 Dependencies
88
+
89
+ ### Production
90
+ ```json
91
+ {
92
+ "dependencies": {}
93
+ }
94
+ ```
95
+
96
+ ### Development
97
+ ```json
98
+ {
99
+ "devDependencies": {}
100
+ }
101
+ ```
102
+
103
+ **업데이트**: package.json 변경 시 자동 감지
104
+
105
+ ---
106
+
107
+ ## 🎨 기술 스택
108
+
109
+ - **언어**: [TECH_STACK]
110
+ - **프레임워크**: 자동 감지 예정
111
+ - **상태 관리**: 자동 감지 예정
112
+ - **스타일링**: 자동 감지 예정
113
+
114
+ ---
115
+
116
+ ## 📈 코드 품질 메트릭
117
+
118
+ ### 복잡도
119
+ - 평균 함수 복잡도: N/A
120
+ - 최대 함수 복잡도: N/A
121
+
122
+ ### 테스트 커버리지
123
+ - 총 커버리지: N/A
124
+ - 라인 커버리지: N/A
125
+ - 브랜치 커버리지: N/A
126
+
127
+ **참고**: ESLint, Prettier, Jest 설정 시 자동 표시
128
+
129
+ ---
130
+
131
+ ## 🔄 업데이트 히스토리
132
+
133
+ ### [TODAY]
134
+ - 초기 생성
135
+
136
+ ---
137
+
138
+ **자동 업데이트 트리거**:
139
+ - 새 폴더/파일 생성 감지
140
+ - package.json 변경
141
+ - 10개 이상 파일 수정
142
+
143
+ **수동 업데이트**: `"구조 업데이트"` 또는 `"통계 업데이트"` 명령
144
+
145
+ ---
146
+
147
+ *이 문서는 CodeSyncer에 의해 자동 생성 및 관리됩니다.*
@@ -0,0 +1,267 @@
1
+ # CLAUDE.md - [PROJECT_NAME] 코딩 가이드 v3.0
2
+
3
+ > **Powered by CodeSyncer** - AI 협업 시스템
4
+
5
+ ## 🚀 빠른 시작
6
+
7
+ ### 이 문서를 AI에게 읽게 하세요
8
+ ```
9
+ "CLAUDE.md 읽어줘"
10
+ ```
11
+ → AI가 자동으로 이 프로젝트의 규칙을 적용합니다.
12
+
13
+ ### 자연어로 편하게 요청하세요
14
+ ```
15
+ ✅ "주문 목록 페이지 만들어줘"
16
+ ✅ "로그인 API 추가해줘"
17
+ ✅ "결제 버튼 컴포넌트 필요해"
18
+ ✅ "이 버그 고쳐줘"
19
+ ```
20
+
21
+ **AI가 알아서:**
22
+ - 프로젝트 구조 파악
23
+ - 적절한 위치에 파일 생성
24
+ - 코딩 규칙 준수
25
+ - 필요시 의논 요청
26
+
27
+ ---
28
+
29
+ ## 🏗️ 프로젝트 정보
30
+ - **프로젝트명**: [PROJECT_NAME]
31
+ - **프로젝트 타입**: [PROJECT_TYPE]
32
+ - **기술 스택**: [TECH_STACK]
33
+ - **생성일**: [TODAY]
34
+ - **버전**: 1.0.0
35
+
36
+ ## 📁 프로젝트 구조
37
+ 자세한 구조는 `.claude/ARCHITECTURE.md` 참조
38
+
39
+ ## 🚨 절대 규칙
40
+ 1. **TypeScript strict mode** 사용
41
+ 2. **함수형 프로그래밍** 우선
42
+ 3. **명시적 타입 정의** 필수
43
+ 4. **모든 함수/컴포넌트에 주석** 작성
44
+ 5. **에러 핸들링** 필수
45
+
46
+ ## 🔴 추론 금지 영역 (반드시 사용자에게 확인)
47
+
48
+ 다음은 **절대 추론하지 말고** 사용자에게 물어보세요:
49
+
50
+ - 💰 비즈니스 로직 수치 (가격, 수수료, 한도, 할인율)
51
+ - 🔌 API 엔드포인트 URL
52
+ - 🔐 보안 설정 (토큰 만료 시간, 암호화 방식)
53
+ - 🗄️ 데이터베이스 스키마
54
+ - 🌐 외부 서비스 연동 정보
55
+
56
+ **예시:**
57
+ ```
58
+ ❌ 나쁜 예: "배송비를 3000원으로 설정했습니다"
59
+ ✅ 좋은 예: "배송비를 얼마로 설정할까요?"
60
+ ```
61
+
62
+ ## 🤝 의논 필수 키워드
63
+
64
+ 다음 키워드 감지 시 **자동으로 작업 중단** 후 사용자와 의논:
65
+
66
+ [KEYWORDS]
67
+
68
+ ### 의논 프로세스
69
+ 1. **키워드 감지** → "⚠️ '[키워드]' 감지. 의논이 필요합니다."
70
+ 2. **옵션 제시** → 추천안 + 대안들
71
+ 3. **사용자 응답 대기** → "진행" / "대안 A" / "보류"
72
+ 4. **결정 기록** → DECISIONS.md + 코드 주석
73
+ 5. **작업 재개**
74
+
75
+ ---
76
+
77
+ ## 📝 주석 작성 규칙
78
+
79
+ ### 주석 태그 (두 형식 모두 지원)
80
+
81
+ **✨ 권장 형식** (모든 AI 도구 호환):
82
+ ```typescript
83
+ @codesyncer-rule // 특별 규칙 (일반적이지 않은 구현 방식)
84
+ @codesyncer-inference // 추론 내용과 근거
85
+ @codesyncer-decision // 의논 후 결정 사항
86
+ @codesyncer-todo // 사용자 확인 필요
87
+ @codesyncer-context // 비즈니스 맥락 설명
88
+ ```
89
+
90
+ **🔄 레거시 형식** (기존 프로젝트 호환):
91
+ ```typescript
92
+ @claude-rule // @codesyncer-rule과 동일
93
+ @claude-inference // @codesyncer-inference와 동일
94
+ @claude-decision // @codesyncer-decision과 동일
95
+ @claude-todo // @codesyncer-todo와 동일
96
+ @claude-context // @codesyncer-context와 동일
97
+ ```
98
+
99
+ ### 주석 레벨별 예시
100
+
101
+ #### 📄 파일 레벨 (JSDoc)
102
+ ```tsx
103
+ /**
104
+ * User authentication service
105
+ *
106
+ * @codesyncer-context JWT 기반 인증 시스템
107
+ * @codesyncer-rule 토큰은 httpOnly 쿠키에 저장 (XSS 방지)
108
+ * @author CodeSyncer
109
+ * @date [TODAY]
110
+ */
111
+ ```
112
+
113
+ #### 🔧 함수/컴포넌트 레벨
114
+ ```tsx
115
+ /**
116
+ * 주문 생성 폼 컴포넌트
117
+ *
118
+ * @codesyncer-inference 6단계 폼 구조 (일반적인 주문 플로우)
119
+ * @codesyncer-decision [2024-10-15] Zustand로 상태 관리 (복잡한 폼이라)
120
+ */
121
+ export default function OrderForm() {
122
+ // ...
123
+ }
124
+ ```
125
+
126
+ #### 📝 인라인 레벨
127
+ ```tsx
128
+ // @codesyncer-inference: 페이지 크기 20 (일반적인 UX 패턴)
129
+ const PAGE_SIZE = 20;
130
+
131
+ // @codesyncer-todo: mainApi 엔드포인트 확인 필요
132
+ const API_URL = '/api/temp';
133
+
134
+ // @codesyncer-decision: [2024-10-17] Soft Delete 방식 (30일 복구 가능)
135
+ async function deleteUser(id: string) {
136
+ return db.update(id, { deleted_at: new Date() });
137
+ }
138
+ ```
139
+
140
+ ### 좋은 주석 vs 나쁜 주석
141
+
142
+ **✅ 좋은 주석**
143
+ ```tsx
144
+ // @codesyncer-inference: localStorage 사용 (JWT 토큰 저장용, 일반적 패턴)
145
+ // @codesyncer-context: GDPR 준수 필요 (30일 후 자동 삭제)
146
+ // @codesyncer-decision: [2024-10-15] Stripe 사용 (한국 결제 지원)
147
+ ```
148
+
149
+ **❌ 나쁜 주석**
150
+ ```tsx
151
+ // @codesyncer-inference: 이렇게 했음
152
+ // @codesyncer-todo: 나중에
153
+ // @codesyncer-decision: 변경함
154
+ ```
155
+
156
+ → **구체적인 이유와 근거**를 항상 포함하세요!
157
+
158
+ ---
159
+
160
+ ## 🔄 자동 업데이트 시스템
161
+
162
+ ### 자동 감지 트리거
163
+
164
+ | 상황 | 업데이트 대상 | 사용자 확인 |
165
+ |------|--------------|------------|
166
+ | 새 폴더/파일 생성 | ARCHITECTURE.md | "구조 업데이트?" |
167
+ | 의논 후 결정 | DECISIONS.md | 자동 추가 |
168
+ | 같은 패턴 3회 반복 | CLAUDE.md에 템플릿 추가 | "템플릿 추가?" |
169
+ | TODO 추가/완료 | ARCHITECTURE.md 통계 | "통계 업데이트?" |
170
+
171
+ ### 수동 업데이트 명령어
172
+
173
+ ```
174
+ "구조 업데이트" → ARCHITECTURE.md 재스캔
175
+ "규칙 추가" → CLAUDE.md에 새 규칙
176
+ "템플릿 추가" → 반복 패턴을 템플릿으로
177
+ "통계 업데이트" → 주석 태그 통계 갱신
178
+ ```
179
+
180
+ ---
181
+
182
+ ## 📋 프로젝트 타입별 가이드
183
+
184
+ [TEMPLATES]
185
+
186
+ ---
187
+
188
+ ## 🔄 작업 프로세스
189
+
190
+ ### 일반적인 작업 흐름
191
+ ```
192
+ 1. 사용자 요청 받음
193
+
194
+ 2. CLAUDE.md 규칙 확인
195
+
196
+ 3. 추론 금지 영역 체크 → 필요시 질문
197
+
198
+ 4. 의논 키워드 체크 → 감지 시 의논
199
+
200
+ 5. 코드 생성 (주석 자동 포함)
201
+
202
+ 6. 추론 발생 시 → @codesyncer-inference 태그
203
+
204
+ 7. 의논 결정 시 → DECISIONS.md 기록
205
+
206
+ 8. 완료 보고
207
+ ```
208
+
209
+ ### AI가 자동으로 수행하는 것들
210
+ - ✅ 프로젝트 구조 분석
211
+ - ✅ 적절한 위치에 파일 생성
212
+ - ✅ 타입 정의 자동 추가
213
+ - ✅ 주석 자동 생성
214
+ - ✅ 에러 핸들링 추가
215
+ - ✅ 추론 내용 태그로 기록
216
+
217
+ ---
218
+
219
+ ## 💡 세션 시작 시 체크리스트
220
+
221
+ AI가 이 파일을 읽으면 자동으로:
222
+
223
+ 1. ✅ **도움말 표시** - 사용 가능한 명령어 안내
224
+ 2. ✅ **프로젝트 구조 파악** - ARCHITECTURE.md 확인
225
+ 3. ✅ **최근 의논 확인** - DECISIONS.md 확인
226
+ 4. ✅ **준비 완료 메시지** - "준비되었습니다!"
227
+
228
+ ---
229
+
230
+ ## 📚 관련 문서
231
+
232
+ - **주석 가이드**: `.claude/COMMENT_GUIDE.md` - 주석 작성 상세 가이드
233
+ - **프로젝트 구조**: `.claude/ARCHITECTURE.md` - 폴더 구조, 통계
234
+ - **의논 기록**: `.claude/DECISIONS.md` - 모든 의논 결정 사항
235
+ - **마스터 문서**: `../.codesyncer/MASTER_CODESYNCER.md` - 멀티 레포 전환
236
+
237
+ ---
238
+
239
+ ## 🔍 주석 검색
240
+
241
+ 모든 주석 태그는 검색 가능합니다:
242
+
243
+ ```bash
244
+ # 모든 추론 찾기
245
+ grep -r "@codesyncer-inference" ./
246
+
247
+ # TODO 목록
248
+ grep -r "@codesyncer-todo" ./
249
+
250
+ # 의논 결정 사항
251
+ grep -r "@codesyncer-decision" ./
252
+
253
+ # 특별 규칙
254
+ grep -r "@codesyncer-rule" ./
255
+ ```
256
+
257
+ ---
258
+
259
+ **버전**: 1.0.0 (Powered by CodeSyncer)
260
+ **생성일**: [TODAY]
261
+ **AI 도구**: 현재 Claude Code 지원 | 향후 확장: Cursor, GitHub Copilot, Continue.dev
262
+
263
+ **태그 호환성**: `@codesyncer-*` (권장) + `@claude-*` (레거시) 모두 지원
264
+
265
+ ---
266
+
267
+ *이 협업 시스템은 오픈소스입니다. 개선 아이디어는 [CodeSyncer GitHub](https://github.com/bitjaru/codesyncer-cli)에서 제안해주세요!*