byuckchon-frontend-cli 1.10.1 → 2.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.
package/package.json
CHANGED
|
@@ -163,11 +163,12 @@ async function applyMonorepoConventions(appDir, config, scope) {
|
|
|
163
163
|
compilerOptions: {
|
|
164
164
|
// 공통 옵션은 config-typescript → settings 프리셋에 있다.
|
|
165
165
|
tsBuildInfoFile: './node_modules/.tmp/tsconfig.tsbuildinfo',
|
|
166
|
-
baseUrl
|
|
166
|
+
// baseUrl 은 TypeScript 7 에서 제거 대상이다.
|
|
167
|
+
// 생략하면 paths 가 이 tsconfig 파일 위치 기준으로 해석되므로 ./ 을 붙인다.
|
|
167
168
|
paths: {
|
|
168
|
-
'@/*': ['src/*'],
|
|
169
|
-
'@icons/*': ['src/assets/icons/*'],
|
|
170
|
-
'@images/*': ['src/assets/images/*'],
|
|
169
|
+
'@/*': ['./src/*'],
|
|
170
|
+
'@icons/*': ['./src/assets/icons/*'],
|
|
171
|
+
'@images/*': ['./src/assets/images/*'],
|
|
171
172
|
},
|
|
172
173
|
},
|
|
173
174
|
include: ['src', 'vite.config.ts'],
|
|
@@ -183,7 +184,7 @@ async function applyMonorepoConventions(appDir, config, scope) {
|
|
|
183
184
|
{
|
|
184
185
|
extends: `@${scope}/config-typescript/next.json`,
|
|
185
186
|
compilerOptions: {
|
|
186
|
-
baseUrl
|
|
187
|
+
// baseUrl 없이 paths 만 쓴다. (TypeScript 7 에서 baseUrl 제거)
|
|
187
188
|
paths: { '@/*': ['./src/*'] },
|
|
188
189
|
},
|
|
189
190
|
include: [
|
|
@@ -26,6 +26,116 @@ import { defineTokenConfig } from "@byuckchon-frontend/settings/tokens";
|
|
|
26
26
|
export default defineTokenConfig();
|
|
27
27
|
`;
|
|
28
28
|
|
|
29
|
+
// ─── AI 에이전트 가이드 ────────────────────────────────────────────────────────
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* AGENTS.md 를 만든다. Codex 와 bc chat 이 이 이름을 기본으로 찾고,
|
|
33
|
+
* CLAUDE.md 는 이 파일을 import 하는 한 줄짜리로 둬서 문서를 하나만 관리한다.
|
|
34
|
+
*
|
|
35
|
+
* 매 세션 컨텍스트에 실리므로 짧게 유지한다. 상세 API 는 각 패키지 README 로 넘긴다.
|
|
36
|
+
*/
|
|
37
|
+
export function agentsDoc(framework) {
|
|
38
|
+
const isReact = framework === "react";
|
|
39
|
+
|
|
40
|
+
return `# 작업 규칙
|
|
41
|
+
|
|
42
|
+
이 프로젝트에서 코드를 작성할 때 지켜야 할 것들입니다.
|
|
43
|
+
|
|
44
|
+
## 1. 사내 패키지를 먼저 쓴다
|
|
45
|
+
|
|
46
|
+
직접 구현하기 전에 아래 패키지에 이미 있는지 **반드시 먼저 확인하세요.**
|
|
47
|
+
같은 기능을 새로 만들면 유지보수 비용이 프로젝트 수만큼 늘어납니다.
|
|
48
|
+
|
|
49
|
+
| 패키지 | 무엇이 있나 |
|
|
50
|
+
| --- | --- |
|
|
51
|
+
| \`@byuckchon-frontend/hooks\` | useDebounce, useThrottle, useTimer, useInfiniteScroll, useIntersectionObserver, useDetectClose, useAutoFocus, useFileUpload, usePagination, usePullToRefresh, useScrollTop, useCheckList, useMonthCalendar, useVisibilityEvent, usePasswordVisibility, useImpressionRef, useInstallPWA, useScrollToSelectedItem |
|
|
52
|
+
| \`@byuckchon-frontend/utils\` | 포맷(formatData), 검증(validate), 에러 처리(handleError), 쿼리 파라미터(filterParams), userAgent, sanitizeHtml, dateUtils, editorUtils |
|
|
53
|
+
| \`@byuckchon-frontend/core\` | Overlay, ErrorBoundary, SanitizeHtmlRender |
|
|
54
|
+
| \`@byuckchon-frontend/basic-ui\` | Accordion, Input, Checkbox, Toggle, Dropdown, Table, Tooltip, Pagination, Calendar, BottomSheet, Breadcrumb, Modal(Alert·Confirm·Choice), ToastMessage, UIThemeProvider |
|
|
55
|
+
| \`@byuckchon-frontend/settings\` | ESLint / Prettier / tsconfig 프리셋, 모션 토큰, 디자인 토큰 변환 |
|
|
56
|
+
|
|
57
|
+
**작업 순서**
|
|
58
|
+
|
|
59
|
+
1. 위 표에서 찾아본다
|
|
60
|
+
2. 애매하면 실제 export 를 확인한다 — 위 목록은 스냅샷이라 최신이 아닐 수 있다
|
|
61
|
+
\`\`\`bash
|
|
62
|
+
cat node_modules/@byuckchon-frontend/hooks/dist/index.d.ts
|
|
63
|
+
\`\`\`
|
|
64
|
+
3. 없으면 그때 직접 구현한다
|
|
65
|
+
|
|
66
|
+
없는 걸 억지로 끼워 맞추지는 마세요. 쓰임이 다르면 직접 만드는 게 맞습니다.
|
|
67
|
+
|
|
68
|
+
## 2. 설정 파일은 직접 고치지 않는다
|
|
69
|
+
|
|
70
|
+
\`eslint.config.js\`, \`prettier.config.js\`, \`tsconfig.*.json\`, \`token.config.js\` 는
|
|
71
|
+
\`@byuckchon-frontend/settings\` 를 참조만 합니다. 규칙 본체는 node_modules 안에 있습니다.
|
|
72
|
+
|
|
73
|
+
예외가 필요하면 **덮어쓰지 말고 뒤에 이어붙이세요.**
|
|
74
|
+
|
|
75
|
+
\`\`\`js
|
|
76
|
+
// eslint.config.js — 배열 뒤쪽이 이깁니다
|
|
77
|
+
import byuckchon from '@byuckchon-frontend/settings/eslint/react';
|
|
78
|
+
|
|
79
|
+
export default [
|
|
80
|
+
...byuckchon,
|
|
81
|
+
{ rules: { '@typescript-eslint/no-explicit-any': 'warn' } },
|
|
82
|
+
];
|
|
83
|
+
\`\`\`
|
|
84
|
+
|
|
85
|
+
\`.vscode/settings.json\`, \`.nvmrc\`${isReact ? "" : ""} 같은 파일은 \`npx byuckchon-settings-sync\` 로 갱신합니다.
|
|
86
|
+
|
|
87
|
+
## 3. 커밋 메시지
|
|
88
|
+
|
|
89
|
+
\`\`\`
|
|
90
|
+
<type>: <요약>
|
|
91
|
+
\`\`\`
|
|
92
|
+
|
|
93
|
+
\`feat\` \`fix\` \`refactor\` \`perf\` \`style\` \`docs\` \`test\` \`chore\`
|
|
94
|
+
|
|
95
|
+
**리뷰어가 확인해야 할 것은 커밋 본문에 남깁니다.** PR 본문의 "리뷰 포인트"로 자동 수집됩니다.
|
|
96
|
+
|
|
97
|
+
\`\`\`
|
|
98
|
+
feat: 주문 목록 API 연동
|
|
99
|
+
|
|
100
|
+
NOTE: 응답 스키마가 미확정이라 types/order.ts 에 any 가 남아 있습니다
|
|
101
|
+
TODO: 에러 처리 미구현 — 백엔드 에러 코드 확정 후 작업 예정
|
|
102
|
+
\`\`\`
|
|
103
|
+
|
|
104
|
+
확신이 없거나, 임시로 둔 코드가 있거나, 리뷰어의 판단이 필요하면 **반드시 남기세요.**
|
|
105
|
+
말없이 넘어가면 리뷰에서 놓칩니다.
|
|
106
|
+
|
|
107
|
+
## 4. 브랜치 이름
|
|
108
|
+
|
|
109
|
+
\`\`\`
|
|
110
|
+
<type>/<작업 요약>/<작업자>
|
|
111
|
+
feature/update-mypage-style/hyuk
|
|
112
|
+
\`\`\`
|
|
113
|
+
|
|
114
|
+
PR 제목은 첫 토막이 대괄호로 자동으로 붙습니다. → \`[feature] 마이페이지 디자인 적용\`
|
|
115
|
+
|
|
116
|
+
## 5. 폴더 구조
|
|
117
|
+
|
|
118
|
+
${
|
|
119
|
+
isReact
|
|
120
|
+
? `\`\`\`
|
|
121
|
+
src/lib 공용 로직·유틸 src/store 전역 상태
|
|
122
|
+
src/api API 호출 src/hooks 커스텀 훅
|
|
123
|
+
src/context Context src/components 컴포넌트
|
|
124
|
+
src/layouts 레이아웃 src/pages 페이지
|
|
125
|
+
src/assets 이미지·아이콘
|
|
126
|
+
\`\`\``
|
|
127
|
+
: `\`\`\`
|
|
128
|
+
src/app App Router src/components 컴포넌트
|
|
129
|
+
src/lib 공용 로직·유틸 src/hooks 커스텀 훅
|
|
130
|
+
src/providers Provider src/constant 상수
|
|
131
|
+
src/assets 이미지·아이콘
|
|
132
|
+
\`\`\``
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
경로 별칭은 \`@/\` 를 씁니다. (\`@/lib/utils/cn\`)
|
|
136
|
+
`;
|
|
137
|
+
}
|
|
138
|
+
|
|
29
139
|
// ─── 공통 설정 파일 ────────────────────────────────────────────────────────────
|
|
30
140
|
|
|
31
141
|
async function createPrettierConfig(rootDir) {
|
|
@@ -213,11 +323,12 @@ export default defineConfig({
|
|
|
213
323
|
extends: "@byuckchon-frontend/settings/tsconfig/react.json",
|
|
214
324
|
compilerOptions: {
|
|
215
325
|
tsBuildInfoFile: "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
|
|
216
|
-
baseUrl
|
|
326
|
+
// baseUrl 은 TypeScript 7 에서 제거 대상이다.
|
|
327
|
+
// 생략하면 paths 가 이 tsconfig 파일 위치 기준으로 해석되므로 ./ 을 붙인다.
|
|
217
328
|
paths: {
|
|
218
|
-
"@/*": ["src/*"],
|
|
219
|
-
"@icons/*": ["src/assets/icons/*"],
|
|
220
|
-
"@images/*": ["src/assets/images/*"],
|
|
329
|
+
"@/*": ["./src/*"],
|
|
330
|
+
"@icons/*": ["./src/assets/icons/*"],
|
|
331
|
+
"@images/*": ["./src/assets/images/*"],
|
|
221
332
|
},
|
|
222
333
|
},
|
|
223
334
|
include: ["src"],
|
|
@@ -245,6 +356,8 @@ export default defineConfig({
|
|
|
245
356
|
);
|
|
246
357
|
|
|
247
358
|
await write(path.join(rootDir, ".nvmrc"), await readSettingsAsset("project/nvmrc"));
|
|
359
|
+
await write(path.join(rootDir, "AGENTS.md"), agentsDoc("react"));
|
|
360
|
+
await write(path.join(rootDir, "CLAUDE.md"), "@AGENTS.md\n");
|
|
248
361
|
|
|
249
362
|
await createPrettierConfig(rootDir);
|
|
250
363
|
await createEslintConfig(rootDir);
|
|
@@ -360,7 +473,7 @@ export default nextConfig;
|
|
|
360
473
|
{
|
|
361
474
|
extends: "@byuckchon-frontend/settings/tsconfig/next.json",
|
|
362
475
|
compilerOptions: {
|
|
363
|
-
baseUrl
|
|
476
|
+
// baseUrl 없이 paths 만 쓴다. (TypeScript 7 에서 baseUrl 제거)
|
|
364
477
|
paths: { "@/*": ["./src/*"] },
|
|
365
478
|
},
|
|
366
479
|
include: ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
|
|
@@ -372,6 +485,8 @@ export default nextConfig;
|
|
|
372
485
|
);
|
|
373
486
|
|
|
374
487
|
await write(path.join(rootDir, ".nvmrc"), await readSettingsAsset("project/nvmrc"));
|
|
488
|
+
await write(path.join(rootDir, "AGENTS.md"), agentsDoc("next"));
|
|
489
|
+
await write(path.join(rootDir, "CLAUDE.md"), "@AGENTS.md\n");
|
|
375
490
|
|
|
376
491
|
await createPrettierConfig(rootDir);
|
|
377
492
|
await createNextEslintConfig(rootDir);
|
|
@@ -3,6 +3,7 @@ import path from 'node:path';
|
|
|
3
3
|
|
|
4
4
|
import { versions } from '../constants/versions.js';
|
|
5
5
|
import { readSettingsAsset } from '../utils/settingsAssets.js';
|
|
6
|
+
import { agentsDoc } from './createBaseFiles.js';
|
|
6
7
|
import { createApp } from './createApp.js';
|
|
7
8
|
import { scaffoldReviewAutomation } from './scaffoldReviewAutomation.js';
|
|
8
9
|
|
|
@@ -134,6 +135,10 @@ packages:
|
|
|
134
135
|
|
|
135
136
|
await write(path.join(root, '.nvmrc'), await readSettingsAsset('project/nvmrc'));
|
|
136
137
|
|
|
138
|
+
// AI 에이전트 가이드 — 루트에 두면 모든 앱에서 공통으로 읽힌다.
|
|
139
|
+
await write(path.join(root, 'AGENTS.md'), agentsDoc(config.framework));
|
|
140
|
+
await write(path.join(root, 'CLAUDE.md'), '@AGENTS.md\n');
|
|
141
|
+
|
|
137
142
|
await write(
|
|
138
143
|
path.join(root, 'prettier.config.mjs'),
|
|
139
144
|
`// 포맷 규칙은 @byuckchon-frontend/settings 가 관리합니다.
|