byuckchon-frontend-cli 1.9.5 → 1.9.7

package/src/commands/adopt.js

@@ -11,13 +11,15 @@ import {
   apiRootForFramework,
   scaffoldApiConventionDoc,
 } from '../generators/apiConventionDoc.js';
+import { scaffoldReviewAutomation } from '../generators/scaffoldReviewAutomation.js';
+import { detectMonorepoRoot } from '../context/monorepo.js';
 import { ensureRequiredDependencies } from '../utils/ensureRequiredDependencies.js';
 
 /**
  * `bc adopt`
  *
- * 기존 프로젝트(현재 디렉터리)에 bc.config.json 과 필수 의존성을 추가한다.
- * 기존 소스 코드는 건드리지 않는다.
+ * 기존 프로젝트(현재 디렉터리)에 bc.config.json, 필수 의존성, PR 리뷰 자동화를 추가한다.
+ * 기존 소스 코드와 이미 존재하는 tools/workflow는 건드리지 않는다.
  *
  * 흐름:
  *   1) 자동 감지(framework, styling, language, routing 등) 결과를 보여주고
@@ -176,6 +178,39 @@ export async function adoptCommand(opts = {}) {
   } catch {
     /* 문서 스캐폴드 실패는 치명적이지 않음 */
   }
+
+  // PR 리뷰 자동화는 모노레포 루트에 한 번만 둔다. 기존 tools/workflow는 덮어쓰지 않는다.
+  try {
+    const monorepoRoot = await detectMonorepoRoot(cwd);
+    const reviewProjectRoot = monorepoRoot ?? cwd;
+    const projectType = monorepoRoot ? 'monorepo' : 'single';
+    const reviewAutomation = await scaffoldReviewAutomation({
+      projectRoot: reviewProjectRoot,
+      projectType,
+      overwrite: false,
+    });
+
+    if (reviewAutomation.workflows.length) {
+      console.log(
+        chalk.green(
+          `  ✓ ESLint Convention Review 설정 추가: ${path.join(reviewProjectRoot, '.github', 'workflows')}`,
+        ),
+      );
+    } else {
+      console.log(
+        chalk.dim(
+          `  ESLint Convention Review 설정 유지: ${path.join(reviewProjectRoot, '.github', 'workflows')} (이미 존재)`,
+        ),
+      );
+    }
+  } catch (error) {
+    console.log(
+      chalk.yellow(
+        `  ⚠ ESLint Convention Review 설정을 추가하지 못했습니다: ${error.message}`,
+      ),
+    );
+  }
+
   console.log();
   console.log(chalk.dim('  다음:'));
   if (!process.env.ANTHROPIC_API_KEY) {

package/src/constants/versions.js

@@ -21,6 +21,7 @@ export const versions = {
   // State & Data
   zustand: '^5.0.3',
   axios: '^1.8.4',
+  'react-router-dom': '^7.5.0',
   '@tanstack/react-query': '^5.74.4',
 
   // Styling

package/src/generators/createApp.js

@@ -27,7 +27,10 @@ export async function createApp({ appDir, config, scope }) {
 
   await createFolders(appDir, config);
   await createBaseFiles(appDir, config);
-  await scaffoldApiConventionDoc({ projectRoot: appDir, framework: config.framework });
+  await scaffoldApiConventionDoc({
+    projectRoot: appDir,
+    framework: config.framework,
+  });
   await createBcConfig(appDir, config);
 
   await createAppPackageJson(appDir, config, scope);
@@ -43,8 +46,8 @@ async function rm(target) {
 }
 
 /**
- * 워크스페이스 앱용 package.json. 모노레포에서는 React 버전을 하나로 통일하려고
- * (pnpm hoist 충돌 방지) react/react-dom 모두 19 계열로 맞춘다.
+ * 워크스페이스 앱용 package.json.
+ * 단일 프로젝트와 동일하게 Vite React는 React 18, Next는 React 19를 사용한다.
  */
 async function createAppPackageJson(appDir, config, scope) {
   const isReact = config.framework === 'react';
@@ -77,13 +80,14 @@ async function createAppPackageJson(appDir, config, scope) {
     type: 'module',
     scripts,
     dependencies: {
-      react: versions['next-react'],
-      'react-dom': versions['next-react-dom'],
+      react: isReact ? versions.react : versions['next-react'],
+      'react-dom': isReact ? versions['react-dom'] : versions['next-react-dom'],
       ...(isReact ? {} : { next: versions.next }),
       zustand: versions.zustand,
       ...(isReact
         ? {
             axios: versions.axios,
+            'react-router-dom': versions['react-router-dom'],
             '@tanstack/react-query': versions['@tanstack/react-query'],
           }
         : {}),
@@ -118,7 +122,10 @@ async function createAppPackageJson(appDir, config, scope) {
     },
   };
 
-  await write(path.join(appDir, 'package.json'), JSON.stringify(pkg, null, 2) + '\n');
+  await write(
+    path.join(appDir, 'package.json'),
+    JSON.stringify(pkg, null, 2) + '\n'
+  );
 }
 
 /**
@@ -154,7 +161,7 @@ export default [
     },
   },
 ];
-`,
+`
   );
 
   if (isReact) {
@@ -182,8 +189,8 @@ export default [
           include: ['src', 'vite.config.ts'],
         },
         null,
-        2,
-      ) + '\n',
+        2
+      ) + '\n'
     );
   } else {
     await write(
@@ -204,8 +211,8 @@ export default [
           exclude: ['node_modules'],
         },
         null,
-        2,
-      ) + '\n',
+        2
+      ) + '\n'
     );
   }
 }

package/src/generators/createBaseFiles.js

@@ -424,8 +424,9 @@ export default defineConfig({
   // src/App.css
   await write(
     path.join(rootDir, "src/App.css"),
-    `@import "./tokens.css";
-@import 'tailwindcss';
+    `@import 'tailwindcss';
+@import "@byuckchon-frontend/settings/motion";
+@import "./tokens.css";
 `
   );
   await write(path.join(rootDir, "src/tokens.css"), "");
@@ -593,8 +594,9 @@ export default config;
   // src/app/globals.css
   await write(
     path.join(rootDir, "src/app/globals.css"),
-    `@import "../tokens.css";
-@import 'tailwindcss';
+    `@import 'tailwindcss';
+@import "@byuckchon-frontend/settings/motion";
+@import "../tokens.css";
 `
   );
   await write(path.join(rootDir, "token.config.js"), TOKEN_CONFIG_JS);

package/src/generators/createFolders.js

@@ -3,7 +3,7 @@ import path from 'path';
 
 /**
  * React 폴더 구조
- * lib → store → api → hooks → context → components → layout → page
+ * lib → store → api → hooks → context → components → layouts → pages
  * assets는 모든 레이어에서 참조 가능
  */
 const REACT_FOLDERS = [
@@ -17,8 +17,8 @@ const REACT_FOLDERS = [
   'src/hooks',
   'src/context',
   'src/components',
-  'src/layout',
-  'src/page',
+  'src/layouts',
+  'src/pages',
 ];
 
 /**
@@ -58,8 +58,8 @@ export async function createFolders(rootDir, config) {
     await writeFile(path.join(rootDir, 'src/store/index.ts'), '// Zustand 스토어\n');
     await writeFile(path.join(rootDir, 'src/api/index.ts'), '// Axios API 호출\n');
     await writeFile(path.join(rootDir, 'src/context/index.tsx'), '// React Context\n');
-    await writeFile(path.join(rootDir, 'src/layout/index.tsx'), '// 레이아웃 컴포넌트\n');
-    await writeFile(path.join(rootDir, 'src/page/index.tsx'), '// 페이지 컴포넌트\n');
+    await writeFile(path.join(rootDir, 'src/layouts/index.tsx'), '// 레이아웃 컴포넌트\n');
+    await writeFile(path.join(rootDir, 'src/pages/index.tsx'), '// 페이지 컴포넌트\n');
   } else {
     await writeFile(path.join(rootDir, 'src/constant/index.ts'), '// 상수 정의\n');
     await writeFile(path.join(rootDir, 'src/providers/index.tsx'), '// 전역 Provider\n');

package/src/generators/createMonorepo.js

@@ -2,6 +2,7 @@ import fs from 'node:fs/promises';
 import path from 'node:path';
 
 import { createApp } from './createApp.js';
+import { scaffoldReviewAutomation } from './scaffoldReviewAutomation.js';
 
 /**
  * 새 pnpm 모노레포를 스캐폴드한다. (marketd-frontend 구조 참고)
@@ -32,6 +33,7 @@ export async function createMonorepo(config) {
   await writeRootFiles(root, config, scope);
   await writeConfigTypescript(root, scope);
   await writeConfigEslint(root, scope);
+  await scaffoldReviewAutomation({ projectRoot: root, projectType: 'monorepo' });
 
   // 최초 앱 하나만 생성. 이후 추가는 `bc add`.
   const appName = config.appName;
@@ -71,9 +73,9 @@ async function writeRootFiles(root, config, scope) {
       typecheck: 'turbo run typecheck',
       'tokens:build': 'turbo run tokens:build',
       format:
-        'prettier --write "**/*.{ts,tsx,js,jsx,json,md,yml,yaml}" --ignore-path .gitignore',
+        'prettier --write "**/*.{ts,tsx,js,jsx,cjs,json,md,yml,yaml}" --ignore-path .gitignore',
       'format:check':
-        'prettier --check "**/*.{ts,tsx,js,jsx,json,md,yml,yaml}" --ignore-path .gitignore',
+        'prettier --check "**/*.{ts,tsx,js,jsx,cjs,json,md,yml,yaml}" --ignore-path .gitignore',
       clean: 'turbo run clean && rm -rf node_modules .turbo',
       preinstall: 'npx only-allow pnpm',
       // 최초 앱 실행 단축키 (bc add 시 앱마다 추가됨).

package/src/generators/createPackageJson.js

@@ -18,7 +18,10 @@ export async function createPackageJson(rootDir, config) {
           'tokens:build': 'style-dictionary build --config token.config.js',
           lint: 'eslint . --ext ts,tsx',
           preview: 'vite preview',
-          format: 'prettier --write "src/**/*.{ts,tsx,css}"',
+          format:
+            'prettier --write "src/**/*.{ts,tsx,css}" "tools/**/*.{js,cjs,json,md}"',
+          'format:check':
+            'prettier --check "src/**/*.{ts,tsx,css}" "tools/**/*.{js,cjs,json,md}"',
         }
       : {
           dev: 'next dev',
@@ -26,7 +29,10 @@ export async function createPackageJson(rootDir, config) {
           'tokens:build': 'style-dictionary build --config token.config.js',
           start: 'next start',
           lint: 'next lint',
-          format: 'prettier --write "src/**/*.{ts,tsx,css}"',
+          format:
+            'prettier --write "src/**/*.{ts,tsx,css}" "tools/**/*.{js,cjs,json,md}"',
+          'format:check':
+            'prettier --check "src/**/*.{ts,tsx,css}" "tools/**/*.{js,cjs,json,md}"',
         },
     dependencies: {
       react: isReact ? versions.react : versions['next-react'],
@@ -37,6 +43,7 @@ export async function createPackageJson(rootDir, config) {
       ...(isReact
         ? {
             axios: versions.axios,
+            'react-router-dom': versions['react-router-dom'],
           }
         : {}),
       zod: versions.zod,

package/src/generators/createProject.js

@@ -1,22 +1,18 @@
-import fs from 'fs/promises';
-import path from 'path';
-import { exec as execCallback } from 'child_process';
-import { promisify } from 'util';
+import fs from "fs/promises";
+import path from "path";
+import { exec as execCallback } from "child_process";
+import { promisify } from "util";
 
-import { createBaseFiles } from './createBaseFiles.js';
-import { createBcConfig } from './createBcConfig.js';
-import { createFolders } from './createFolders.js';
-import { createPackageJson } from './createPackageJson.js';
-import { createReadme } from './createReadme.js';
-import { scaffoldApiConventionDoc } from './apiConventionDoc.js';
+import { createBaseFiles } from "./createBaseFiles.js";
+import { createBcConfig } from "./createBcConfig.js";
+import { createFolders } from "./createFolders.js";
+import { createPackageJson } from "./createPackageJson.js";
+import { createReadme } from "./createReadme.js";
+import { scaffoldApiConventionDoc } from "./apiConventionDoc.js";
+import { scaffoldReviewAutomation } from "./scaffoldReviewAutomation.js";
+import { BYUCKCHON_PACKAGES } from "./install.js";
 
 const exec = promisify(execCallback);
-const BYUCKCHON_PACKAGES = [
-  '@byuckchon-frontend/hooks',
-  '@byuckchon-frontend/utils',
-  '@byuckchon-frontend/basic-ui',
-  '@byuckchon-frontend/core',
-];
 
 export async function createProject(config) {
   const rootDir = path.resolve(config.projectName);
@@ -27,10 +23,17 @@ export async function createProject(config) {
   await createBaseFiles(rootDir, config);
   await createReadme(rootDir, config);
   // API 코드 컨벤션 .md 를 프레임워크에 맞는 API 루트(src/api | src/lib/api)에 깐다.
-  await scaffoldApiConventionDoc({ projectRoot: rootDir, framework: config.framework });
+  await scaffoldApiConventionDoc({
+    projectRoot: rootDir,
+    framework: config.framework,
+  });
   await createBcConfig(rootDir, config);
+  await scaffoldReviewAutomation({
+    projectRoot: rootDir,
+    projectType: "single",
+  });
 
   // 최신 버전(latest 포함) 의존성을 실제로 설치해 lockfile까지 생성
-  await exec('npm install', { cwd: rootDir });
-  await exec(`npm install ${BYUCKCHON_PACKAGES.join(' ')}`, { cwd: rootDir });
+  await exec("npm install", { cwd: rootDir });
+  await exec(`npm install ${BYUCKCHON_PACKAGES.join(" ")}`, { cwd: rootDir });
 }

package/src/generators/createReadme.js

@@ -10,7 +10,7 @@ export async function createReadme(rootDir, config) {
 
 | 항목 | 내용 |
 |------|------|
-| Framework | ${isReact ? 'React 19' : 'Next.js 15 (App Router)'} |
+| Framework | ${isReact ? 'React 18' : 'Next.js 15 (App Router)'} |
 | Language | TypeScript |
 | Build Tool | ${isReact ? 'Vite' : 'Next.js built-in'} |
 | Styling | Tailwind CSS |
@@ -47,8 +47,8 @@ src/
 ├── components/    재사용 가능한 UI 컴포넌트${
     isReact
       ? `
-├── layout/        레이아웃 컴포넌트
-└── page/          페이지 컴포넌트`
+├── layouts/       레이아웃 컴포넌트
+└── pages/         페이지 컴포넌트`
       : `
 └── app/           Next.js App Router (layout, page 등)`
   }
@@ -61,7 +61,7 @@ ${
 각 레이어는 아래 방향으로만 import 해야 합니다.
 
 \`\`\`
-lib → store → api → hooks → context → components → layout → page
+lib → store → api → hooks → context → components → layouts → pages
 \`\`\`
 
 \`assets\`는 모든 레이어에서 자유롭게 참조 가능합니다.`

package/src/generators/install.js

@@ -10,6 +10,7 @@ export const BYUCKCHON_PACKAGES = [
   '@byuckchon-frontend/utils',
   '@byuckchon-frontend/basic-ui',
   '@byuckchon-frontend/core',
+  '@byuckchon-frontend/settings',
 ];
 
 async function hasPnpm() {

package/src/generators/scaffoldReviewAutomation.js

@@ -0,0 +1,105 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const TEMPLATE_ROOT = path.resolve(
+  path.dirname(fileURLToPath(import.meta.url)),
+  '../../templates/review-automation',
+);
+
+const ESLINT_WORKFLOW_BY_PROJECT_TYPE = {
+  single: 'eslint-convention-review.single.yml',
+  monorepo: 'eslint-convention-review.monorepo.yml',
+};
+
+function shouldCopyTemplateFile(source) {
+  return path.basename(source) !== '.DS_Store';
+}
+
+async function pathExists(target) {
+  try {
+    await fs.access(target);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+async function copyFileIfAllowed(source, target, overwrite) {
+  if (!overwrite && (await pathExists(target))) {
+    return false;
+  }
+
+  await fs.copyFile(source, target);
+  return true;
+}
+
+/**
+ * 프로젝트 루트에 PR 리뷰 자동화 파일을 생성한다.
+ *
+ * - tools/ 는 ESLint convention rule 및 PR 댓글 게시 스크립트를 제공한다.
+ * - .github/workflows/ 는 프로젝트 유형에 맞는 ESLint workflow 하나와
+ *   공통 workflow(AI Code Review, PR Check 등)를 제공한다.
+ *
+ * @param {object} args
+ * @param {string} args.projectRoot 새로 생성한 프로젝트의 절대 경로
+ * @param {'single' | 'monorepo'} args.projectType 생성할 프로젝트 유형
+ * @param {boolean} [args.overwrite=true] 기존 파일을 템플릿으로 덮어쓸지
+ * @returns {Promise<{ toolsDir: string, workflows: string[] }>}
+ */
+export async function scaffoldReviewAutomation({
+  projectRoot,
+  projectType,
+  overwrite = true,
+}) {
+  const eslintWorkflow = ESLINT_WORKFLOW_BY_PROJECT_TYPE[projectType];
+
+  if (!eslintWorkflow) {
+    throw new Error(`지원하지 않는 프로젝트 유형입니다: ${projectType}`);
+  }
+
+  const toolsTemplateDir = path.join(TEMPLATE_ROOT, 'tools');
+  const workflowsTemplateDir = path.join(TEMPLATE_ROOT, 'github', 'workflows');
+  const toolsTargetDir = path.join(projectRoot, 'tools');
+  const workflowsTargetDir = path.join(projectRoot, '.github', 'workflows');
+
+  await fs.cp(toolsTemplateDir, toolsTargetDir, {
+    recursive: true,
+    force: overwrite,
+    errorOnExist: false,
+    filter: shouldCopyTemplateFile,
+  });
+  await fs.mkdir(workflowsTargetDir, { recursive: true });
+
+  const workflowFiles = await fs.readdir(workflowsTemplateDir);
+  const commonWorkflows = workflowFiles.filter(
+    (fileName) =>
+      fileName.endsWith('.yml') &&
+      !fileName.startsWith('eslint-convention-review.'),
+  );
+  const copiedWorkflows = [];
+
+  for (const fileName of commonWorkflows) {
+    const copied = await copyFileIfAllowed(
+      path.join(workflowsTemplateDir, fileName),
+      path.join(workflowsTargetDir, fileName),
+      overwrite,
+    );
+    if (copied) copiedWorkflows.push(fileName);
+  }
+
+  const eslintWorkflowTarget = path.join(
+    workflowsTargetDir,
+    'eslint-convention-review.yml',
+  );
+  const copiedEslintWorkflow = await copyFileIfAllowed(
+    path.join(workflowsTemplateDir, eslintWorkflow),
+    eslintWorkflowTarget,
+    overwrite,
+  );
+  if (copiedEslintWorkflow) {
+    copiedWorkflows.push('eslint-convention-review.yml');
+  }
+
+  return { toolsDir: toolsTargetDir, workflows: copiedWorkflows };
+}

package/templates/review-automation/github/workflows/eslint-convention-review.monorepo.yml

@@ -0,0 +1,86 @@
+# ESLint 기반 기계적 컨벤션을 PR 인라인 댓글로 게시합니다.
+# typecheck/lint/build 성공 여부는 PR Check workflow가 담당합니다.
+#
+# 각 패키지의 eslint.config.mjs에는 internal 플러그인이 없으므로,
+# tools/eslint-rules/review.config.mjs 전용 config로 레포 루트에서
+# PR 변경 파일만 한 번에 검사합니다.
+
+name: ESLint Convention Review
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+    branches:
+      - dev
+
+concurrency:
+  group: eslint-convention-review-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
+
+jobs:
+  eslint-conventions:
+    name: ESLint Convention Review
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: .nvmrc
+          cache: pnpm
+
+      - name: 의존성 설치
+        run: pnpm install --frozen-lockfile
+
+      - name: PR 변경 파일 조회
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh api "repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }}/files" \
+            --paginate \
+            --jq '.[] | select(.status != "removed") | .filename | select(test("\\.(ts|tsx)$"))' \
+            > /tmp/eslint-convention-files.txt
+
+          echo "변경된 TypeScript 파일:"
+          cat /tmp/eslint-convention-files.txt
+
+      - name: ESLint 컨벤션 검사
+        run: |
+          if [[ ! -s /tmp/eslint-convention-files.txt ]]; then
+            echo "변경된 TypeScript 파일이 없습니다."
+            printf '{"source":{"name":"eslint-conventions"},"diagnostics":[]}' \
+              > /tmp/eslint-conventions.rdjson
+            exit 0
+          fi
+
+          mapfile -t changed_files < /tmp/eslint-convention-files.txt
+
+          set +e
+          pnpm exec eslint "${changed_files[@]}" \
+            --config tools/eslint-rules/review.config.mjs \
+            --no-error-on-unmatched-pattern \
+            -f tools/eslint-rules/internal-rdjson-formatter.js \
+            -o /tmp/eslint-conventions.rdjson
+          eslint_exit=$?
+          set -e
+
+          if [[ ! -f /tmp/eslint-conventions.rdjson ]]; then
+            echo "ESLint가 /tmp/eslint-conventions.rdjson 을 생성하지 못했습니다. (exit ${eslint_exit})"
+            exit "$eslint_exit"
+          fi
+
+      - name: 리뷰 댓글 게시
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PR_NUMBER: ${{ github.event.pull_request.number }}
+          REPO: ${{ github.repository }}
+          HEAD_SHA: ${{ github.event.pull_request.head.sha }}
+        run: |
+          node tools/post-eslint-review-comments.cjs \
+            /tmp/eslint-conventions.rdjson \
+            eslint-conventions

package/templates/review-automation/github/workflows/eslint-convention-review.single.yml

@@ -0,0 +1,44 @@
+name: ESLint Convention Review
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+    branches:
+      - dev
+
+concurrency:
+  group: eslint-convention-review-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
+
+jobs:
+  eslint-conventions:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+
+      - name: 의존성 설치
+        run: npm ci
+
+      - name: ESLint 컨벤션 리뷰 댓글
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PR_NUMBER: ${{ github.event.pull_request.number }}
+          REPO: ${{ github.repository }}
+          HEAD_SHA: ${{ github.event.pull_request.head.sha }}
+        run: |
+          npx eslint . --ext ts,tsx --rulesdir tools/eslint-rules \
+            --rule 'internal-blocking-conventions:error' \
+            --rule 'internal-warning-conventions:warn' \
+            -f tools/eslint-rules/internal-rdjson-formatter.js \
+            -o /tmp/eslint-conventions.rdjson || true
+          node tools/post-eslint-review-comments.cjs \
+            /tmp/eslint-conventions.rdjson \
+            eslint-conventions