byuckchon-frontend-cli 1.9.6 → 1.10.0

package/src/generators/scaffoldReviewAutomation.js

@@ -0,0 +1,115 @@
+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 PROJECT_TYPES = ['single', 'monorepo'];
+
+/**
+ * 워크플로 템플릿 이름 규칙
+ *   `<이름>.single.yml` / `<이름>.monorepo.yml` → 유형이 맞는 쪽만 `<이름>.yml` 로 복사
+ *   `<이름>.yml`                                → 유형과 무관하게 항상 복사
+ *
+ * @param {string[]} fileNames 템플릿 디렉터리의 파일 목록
+ * @param {'single' | 'monorepo'} projectType
+ * @returns {Array<{ source: string, target: string }>}
+ */
+function selectWorkflows(fileNames, projectType, exclude = []) {
+  const selected = [];
+
+  for (const fileName of fileNames) {
+    if (!fileName.endsWith('.yml')) continue;
+
+    const withoutExt = fileName.slice(0, -'.yml'.length);
+    const suffix = PROJECT_TYPES.find((type) => withoutExt.endsWith(`.${type}`));
+    const baseName = suffix
+      ? withoutExt.slice(0, -(suffix.length + 1))
+      : withoutExt;
+
+    if (exclude.includes(baseName)) continue;
+    if (suffix && suffix !== projectType) continue;
+
+    selected.push({ source: fileName, target: `${baseName}.yml` });
+  }
+
+  return selected;
+}
+
+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/ 는 프로젝트 유형에 맞는 워크플로를 제공한다.
+ *   템플릿 이름이 `<이름>.single.yml` / `<이름>.monorepo.yml` 이면 유형이 맞는 쪽만
+ *   `<이름>.yml` 로 복사되고, 접미사가 없으면 유형과 무관하게 복사된다.
+ *
+ * @param {object} args
+ * @param {string} args.projectRoot 새로 생성한 프로젝트의 절대 경로
+ * @param {'single' | 'monorepo'} args.projectType 생성할 프로젝트 유형
+ * @param {boolean} [args.overwrite=true] 기존 파일을 템플릿으로 덮어쓸지
+ * @param {string[]} [args.exclude=[]] 제외할 워크플로 이름 (확장자·유형 접미사 제외)
+ * @returns {Promise<{ toolsDir: string, workflows: string[] }>}
+ */
+export async function scaffoldReviewAutomation({
+  projectRoot,
+  projectType,
+  overwrite = true,
+  exclude = [],
+}) {
+  if (!PROJECT_TYPES.includes(projectType)) {
+    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 copiedWorkflows = [];
+
+  for (const { source, target } of selectWorkflows(workflowFiles, projectType, exclude)) {
+    const copied = await copyFileIfAllowed(
+      path.join(workflowsTemplateDir, source),
+      path.join(workflowsTargetDir, target),
+      overwrite,
+    );
+    if (copied) copiedWorkflows.push(target);
+  }
+
+  return { toolsDir: toolsTargetDir, workflows: copiedWorkflows };
+}

package/src/utils/ensureRequiredDependencies.js

@@ -7,6 +7,13 @@ const execFile = promisify(execFileCallback);
 
 const COMMON_DEPENDENCIES = ['@tanstack/react-query', 'zod'];
 
+/**
+ * 스캐폴딩되는 설정 파일들이 참조하는 패키지.
+ * tools/review.config.mjs, eslint.config, prettier.config, tsconfig 가 모두
+ * @byuckchon-frontend/settings 를 import/extends 하므로 없으면 lint·build 가 실패한다.
+ */
+const COMMON_DEV_DEPENDENCIES = ['@byuckchon-frontend/settings'];
+
 const installCommands = {
   npm: ['npm', ['install']],
   pnpm: ['pnpm', ['add']],
@@ -14,6 +21,14 @@ const installCommands = {
   bun: ['bun', ['add']],
 };
 
+/** devDependencies 로 설치할 때 붙이는 플래그 */
+const devFlags = {
+  npm: '--save-dev',
+  pnpm: '-D',
+  yarn: '-D',
+  bun: '-d',
+};
+
 export function hasDependency(pkg, packageName) {
   return Boolean(
     pkg?.dependencies?.[packageName] ||
@@ -36,11 +51,11 @@ export async function ensureRequiredDependencies({
   packageManager,
   run = execFile,
 }) {
-  const missing = requiredDependenciesForFramework(framework).filter(
-    (packageName) => !hasDependency(pkg, packageName),
-  );
+  const notInstalled = (packageName) => !hasDependency(pkg, packageName);
+  const missing = requiredDependenciesForFramework(framework).filter(notInstalled);
+  const missingDev = COMMON_DEV_DEPENDENCIES.filter(notInstalled);
 
-  if (!missing.length) {
+  if (!missing.length && !missingDev.length) {
     return { installed: [], packageManager };
   }
 
@@ -48,11 +63,22 @@ export async function ensureRequiredDependencies({
     ? packageManager
     : 'npm';
   const [command, baseArgs] = installCommands[selectedPackageManager];
-  const packageSpecs = missing.map(
-    (packageName) => `${packageName}@${versions[packageName]}`,
-  );
+  const spec = (packageName) =>
+    versions[packageName] ? `${packageName}@${versions[packageName]}` : packageName;
 
-  await run(command, [...baseArgs, ...packageSpecs], { cwd });
+  if (missing.length) {
+    await run(command, [...baseArgs, ...missing.map(spec)], { cwd });
+  }
+  if (missingDev.length) {
+    await run(
+      command,
+      [...baseArgs, devFlags[selectedPackageManager], ...missingDev.map(spec)],
+      { cwd },
+    );
+  }
 
-  return { installed: missing, packageManager: selectedPackageManager };
+  return {
+    installed: [...missing, ...missingDev],
+    packageManager: selectedPackageManager,
+  };
 }

package/src/utils/settingsAssets.js

@@ -0,0 +1,27 @@
+/**
+ * @byuckchon-frontend/settings 가 관리하는 "파일로 존재해야 하는" 설정을 읽는다.
+ *
+ * eslint / prettier / tsconfig 는 프로젝트가 import·extends 로 참조하므로 여기 없다.
+ * 아래 파일들은 참조 문법이 없어서 생성 시점에 내용을 복사해야 한다.
+ * 이후 settings 가 바뀌면 프로젝트에서 `npx byuckchon-settings-sync` 로 갱신한다.
+ */
+
+import fs from 'node:fs/promises';
+import { createRequire } from 'node:module';
+
+const require = createRequire(import.meta.url);
+
+/** settings 패키지 안의 파일 경로를 해석한다. */
+export function resolveSettingsAsset(subpath) {
+  return require.resolve(`@byuckchon-frontend/settings/${subpath}`);
+}
+
+/** settings 가 들고 있는 파일 내용을 문자열로 읽는다. */
+export async function readSettingsAsset(subpath) {
+  return fs.readFile(resolveSettingsAsset(subpath), 'utf8');
+}
+
+/** CLI 가 함께 배포되는 settings 의 실제 버전 (생성 프로젝트가 참조할 버전) */
+export function settingsVersion() {
+  return require('@byuckchon-frontend/settings/package.json').version;
+}

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

@@ -0,0 +1,88 @@
+# ESLint 기반 기계적 컨벤션을 PR 인라인 댓글로 게시합니다.
+# typecheck/lint/build 성공 여부는 PR Check workflow가 담당합니다.
+#
+# 각 패키지의 eslint.config에는 internal 플러그인이 없으므로,
+# tools/review.config.mjs 전용 config로 레포 루트에서 PR 변경 파일만 검사합니다.
+#
+# 규칙과 게시 스크립트는 @byuckchon-frontend/settings 가 제공합니다.
+# 프로젝트에 규칙 사본을 두지 않으므로, 규칙 변경은 settings 버전 업으로 반영됩니다.
+
+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/review.config.mjs \
+            --no-error-on-unmatched-pattern \
+            -f node_modules/@byuckchon-frontend/settings/src/eslint/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: |
+          npx --no-install byuckchon-eslint-review-comments \
+            /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-file: .nvmrc
+          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 . \
+            --config tools/review.config.mjs \
+            --no-error-on-unmatched-pattern \
+            -f node_modules/@byuckchon-frontend/settings/src/eslint/internal-rdjson-formatter.js \
+            -o /tmp/eslint-conventions.rdjson || true
+          npx --no-install byuckchon-eslint-review-comments \
+            /tmp/eslint-conventions.rdjson \
+            eslint-conventions

package/templates/review-automation/github/workflows/pr-check.monorepo.yml

@@ -0,0 +1,51 @@
+# PR Check — 모노레포
+#
+# 기계적인 컨벤션은 ESLint Convention Review workflow 가 인라인 댓글로 알려주고,
+# 이 workflow 는 "머지해도 되는가"(lint / typecheck / build 성공 여부)를 판정합니다.
+#
+# turbo 가 변경된 패키지만 골라 실행하고 캐시를 재사용합니다.
+# 프로젝트 사정에 맞게 자유롭게 수정하세요. 이 파일은 프로젝트 소유입니다.
+
+name: PR Check
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+    branches:
+      - dev
+
+concurrency:
+  group: pr-check-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
+
+jobs:
+  check:
+    name: Lint · Typecheck · Build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # turbo 가 변경 범위를 계산할 수 있도록 히스토리를 가져옵니다.
+          fetch-depth: 0
+
+      - uses: pnpm/action-setup@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: .nvmrc
+          cache: pnpm
+
+      - name: 의존성 설치
+        run: pnpm install --frozen-lockfile
+
+      - name: Lint
+        run: pnpm lint
+
+      - name: Typecheck
+        run: pnpm typecheck
+
+      - name: Build
+        run: pnpm build

package/templates/review-automation/github/workflows/pr-check.single.yml

@@ -0,0 +1,47 @@
+# PR Check — 단일 프로젝트
+#
+# 기계적인 컨벤션은 ESLint Convention Review workflow 가 인라인 댓글로 알려주고,
+# 이 workflow 는 "머지해도 되는가"(lint / typecheck / build 성공 여부)를 판정합니다.
+#
+# 프로젝트 사정에 맞게 자유롭게 수정하세요. 이 파일은 프로젝트 소유입니다.
+#   - 대상 브랜치가 dev 가 아니라면 아래 branches 를 바꾸세요.
+#   - 테스트가 있다면 마지막에 단계를 추가하세요.
+
+name: PR Check
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+    branches:
+      - dev
+
+concurrency:
+  group: pr-check-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
+
+jobs:
+  check:
+    name: Lint · Typecheck · Build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: .nvmrc
+          cache: npm
+
+      - name: 의존성 설치
+        run: npm ci
+
+      - name: Lint
+        run: npm run lint
+
+      - name: Typecheck
+        run: npm run typecheck
+
+      - name: Build
+        run: npm run build

package/templates/review-automation/tools/review.config.mjs

@@ -0,0 +1,9 @@
+// ESLint Convention Review 워크플로 전용 config.
+//
+// 규칙 본체(internal 플러그인 + 컨벤션 규칙)는 @byuckchon-frontend/settings 가
+// 관리합니다. 규칙이 바뀌면 settings 버전만 올리면 되고 이 파일은 그대로 둡니다.
+//
+// 이 프로젝트에만 해당하는 예외가 필요하면 아래에 이어붙이세요.
+//   import review from '@byuckchon-frontend/settings/eslint/review';
+//   export default [...review, { ignores: ['src/legacy/**'] }];
+export { default } from '@byuckchon-frontend/settings/eslint/review';