diff --git a/.agent/profile.yml b/.agent/profile.yml new file mode 100644 index 0000000..f596df1 --- /dev/null +++ b/.agent/profile.yml @@ -0,0 +1,18 @@ +schema_version: 1 + +project: + id: kri-create-next-app + name: KriCreateNextApp + type: scaffold-cli + layer: standalone + legacy: false + +stack: + - typescript + - react + - nextjs + +shared_contracts: + consumes: + - kri-front-common + - kri-ui-registry diff --git a/.agent/project.md b/.agent/project.md new file mode 100644 index 0000000..aa4bd5a --- /dev/null +++ b/.agent/project.md @@ -0,0 +1,29 @@ +## KriCreateNextApp Repository Rules + +### Repository Role and Contracts + +- This repository provides the Node.js 20 TypeScript CLI `@kri/create-next-app` and the template used to create KRI Next.js frontend applications. +- Treat command names, flags, prompts, defaults, generated paths, dependency policy, template structure, and validation order as public contracts. +- `src` is authoritative. `dist` is ignored build output and must not be edited or committed directly. +- Keep the CLI implementation, help text, README, and templates synchronized whenever generated behavior changes. + +### Generated Frontend Invariants + +- Generated applications use TypeScript, React, Next.js, `@kri/common`, shadcn, and the KRI UI Registry contract declared by this repository profile. +- Install `@kri/common@latest` and record the resolved dependency as an exact version using the existing npm workflow. +- Prefer shadcn and approved KRI UI Registry components over new local primitives when a suitable component exists. +- Do not introduce new frontend type or interface names ending in `Dto` or `DTO`. +- Generate `.agent/profile.yml`, `.agent/project.md`, and harness line-ending policy for every project. Never copy a stale precomposed `AGENTS.md` into the template. + +### Harness Integration + +- Generated projects default to `requested-project`; allow the supported explicit project-type override without changing the fixed `frontend` layer. +- When the central harness is available, register the project locally and run compose followed by verify. Central-harness absence must not prevent project creation. +- `AGENTS.md` and `CLAUDE.md` in this repository are harness-generated outputs. Never edit either file directly; edit `.agent` sources and recompose. +- Do not commit user-specific absolute harness paths or credentials. Explicit paths are runtime inputs only. + +### Verification and Publication + +- Run `npm.cmd run typecheck` and `npm.cmd run build` on Windows for CLI changes. +- Validate template changes by generating into a disposable directory without network installation first, then inspect unresolved placeholders, encoding, and harness composition. +- Package publication, registry access, and network installation require separate explicit approval. diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..a67f1ff --- /dev/null +++ b/.gitattributes @@ -0,0 +1,4 @@ +/AGENTS.md text eol=lf +/CLAUDE.md text eol=lf +/.agent/*.md text eol=lf +/.agent/*.yml text eol=lf diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..f7bca2b --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,314 @@ + + +# KRI Development Base Instructions + +This document defines the shared working rules for KRI development repositories. +Keep project-specific facts and commands in the project profile and project rules. + +## Instruction Resolution + +Apply repository instructions in this order: + +1. Base rules +2. Project-type rules +3. Technology-stack rules +4. Shared consumer contracts +5. Project-specific rules +6. The explicitly approved task scope + +Later and more specific instructions may override earlier general instructions only within their stated scope. + +- Apply a shared consumer contract only when `.agent/profile.yml` declares it. +- Do not silently resolve a material instruction conflict. Report the conflicting rules and request a decision before changing files. +- Rules involving destructive actions, credentials, external systems, production, deployment, databases, or Git publication require explicit authorization even when a later rule is less restrictive. + +## Communication + +- Respond to the user in Korean unless the user requests another language. +- Keep code identifiers, commands, paths, protocol names, and external API terms in their original form. +- Follow the repository's existing language conventions for code comments and user-facing messages. +- Lead with the result or decision, then provide only the detail needed to verify it. +- Do not create or retain a full session transcript. + +## Work Authorization + +- The default workflow is discussion first and explicit execution approval second. +- During discussion, perform only read-only investigation needed to understand the task and propose a concrete plan, unless the user prohibits inspection. +- Read-only investigation may include file inspection, code search, encoding checks, `git status`, `git diff`, `git log`, and sanitized official-documentation lookup. +- Before execution approval, do not edit files, install dependencies, run builds or tests, start services, connect to databases, or change local or external state. +- Before requesting approval, describe the intended scope, affected areas, validation plan, and material risks. +- Treat approval as limited to the presented scope. Pause and discuss again if the work materially expands. +- If the user explicitly requests immediate execution without prior discussion, the discussion gate may be skipped for the stated scope. +- Fast-track authorization does not implicitly authorize protected operations such as destructive commands, production changes, deployments, database mutations, Git publication, or external messages. + +## Local Development Environment + +- Primary OS: Windows 11. +- Primary shell: PowerShell. +- Use Git Bash only when the repository already depends on Bash or POSIX shell behavior. +- Prefer repository-provided wrappers and scripts over globally installed commands. +- Do not assume that GNU utilities, WSL, Docker, or a Unix-compatible shell are available unless the project profile confirms them. +- Detect Java, Node.js, .NET, Python, package-manager, and database-tool versions from repository configuration. +- Do not install or modify global toolchains as part of a project task. + +Preferred human-facing tools: + +- Classic ASP: Visual Studio Code +- Java and Spring Boot: IntelliJ IDEA +- C# and .NET: JetBrains Rider +- JavaScript, TypeScript, and Next.js: JetBrains WebStorm +- Python: JetBrains PyCharm +- Microsoft SQL Server: SQL Server Management Studio +- Other databases: JetBrains DataGrip + +- These preferences do not authorize launching or controlling a GUI application. +- Prefer IDE-independent commands that can also run in CI. +- Do not modify global IDE settings. +- Do not create or modify `.idea`, `.vscode`, workspace, or run-configuration files unless the approved task requires it. +- Preserve existing shared IDE configuration when it is already tracked. + +## PowerShell and Path Safety + +- Quote paths containing spaces, brackets, parentheses, Korean characters, or PowerShell metacharacters. +- Prefer `-LiteralPath` when operating on an exact filesystem path. +- Use project-relative paths in committed configuration and documentation. Do not commit machine-specific paths such as `D:\_____Dev\...`. +- Do not pass filesystem targets between PowerShell, `cmd.exe`, and Bash for destructive or recursive operations. +- Keep a filesystem operation within one shell from target resolution through execution. +- Before a recursive delete or move, resolve and verify every absolute target. +- Never use a drive root, workspace root, user profile, unresolved variable, wildcard, or broad glob as a recursive delete target. +- Prefer recoverable operations when practical. + +## Change Discipline + +- Preserve all existing user changes, including uncommitted and untracked work. +- Keep changes minimal but complete for the approved objective. +- Avoid unrelated cleanup, formatting, renaming, dependency upgrades, and architectural refactoring. +- Do not overwrite or revert unrelated changes. +- Stop and report when the requested change overlaps existing work in a way that cannot be handled safely. +- Prefer changing an authoritative source over editing generated output. +- Treat files marked as generated as read-only unless regeneration is part of the approved plan. +- Do not edit vendored dependencies, build outputs, caches, or generated clients unless explicitly required. +- Do not regenerate a broad set of files for a narrow change without first explaining the expected output scope. + +## Text Encoding and Korean Content Safety + +- Treat the existing file encoding, BOM state, and line-ending style as part of the file's contract. +- Preserve Korean comments, user-facing messages, error messages, identifiers, and documentation exactly unless the task explicitly requires changing them. +- Do not assume that garbled terminal output means the file itself is corrupted. Verify bytes and encoding before modifying suspicious text. +- Before editing an existing text file, determine its current encoding and BOM state when repository configuration does not already guarantee them. +- Do not convert encoding, add or remove a BOM, or normalize line endings as a side effect of an unrelated change. +- Avoid whole-file rewrites for small changes. +- Do not rewrite source files through `Get-Content | Set-Content`, `Out-File`, shell redirection, or another method whose encoding behavior is implicit. +- Do not use a patching or formatting tool on a non-UTF-8 file unless it is known to preserve that file's encoding. +- Treat a console display problem and an on-disk encoding problem as separate issues. +- After editing Korean text, inspect the diff for replacement characters (`�`), mojibake, unexpected escapes, BOM changes, and unrelated line-ending changes. +- Run `.agent/tools/check-encoding.ps1` when it is available and the change touches Korean text or a non-default encoding. +- If encoding cannot be identified confidently, stop before writing and report the affected file and evidence. +- For a new text file, follow repository configuration. If no rule exists, use UTF-8 without BOM. + +## Git Safety + +- Use `git status`, `git diff`, and `git log` for read-only investigation. +- Do not run `commit`, `push`, `pull`, `fetch`, `merge`, `rebase`, `reset`, `checkout`, `switch`, `stash`, `clean`, `tag`, or force operations unless that specific operation is explicitly approved. +- Source-edit approval does not include commit or push approval. +- Never amend an existing commit unless explicitly requested. +- Before an approved commit, show the intended files, validation results, and proposed commit message. +- Never push directly to a protected branch unless the user names the target branch and explicitly authorizes the push. + +## Dependencies and External Actions + +- Use the package manager, lockfile, and toolchain already selected by the repository. +- Do not install global packages. +- Do not add, remove, or upgrade a dependency unless it was included in the approved plan. +- Pause for approval if an unplanned dependency becomes necessary. +- Keep lockfiles synchronized with approved dependency changes. +- Do not deploy, publish packages, create releases, send messages or email, call business APIs, or modify external services unless explicitly requested. +- Never upload proprietary source code, internal documents, credentials, customer data, or database contents to an external service. +- Remove secrets and unnecessary internal identifiers from external search queries. + +## Database Safety + +- Treat writing or reviewing SQL as source code separately from executing SQL against a database. +- SQL files, migrations, schema proposals, and query drafts may be created within an approved source-change scope. +- Do not connect to a shared, staging, or production database without explicit authorization for that environment. +- Read-only queries against a non-local database also require authorization because results may contain sensitive data. +- Do not execute DDL, DML, stored procedures, migrations, administrative commands, or data-correction scripts against a non-disposable database without separate authorization for the exact target and operation. +- Source-change approval does not authorize migration execution. +- Use a disposable local or test database for approved validation only after verifying its identity and disposable nature. +- Never place credentials, connection strings, or sensitive query results in source files, logs, generated documents, or chat output. + +## Secrets and Sensitive Data + +- Never add credentials, tokens, passwords, private keys, connection strings, session identifiers, or production data to source control. +- Read sensitive files only when the approved task requires it and no safer source exists. +- Prefer inspecting configuration keys and schemas without displaying secret values. +- Never echo secrets into terminal output, chat responses, logs, diffs, generated documents, test fixtures, or screenshots. +- Redact sensitive values when reporting errors or command output. +- If a possible secret is discovered, do not repeat it. Report only its location, type, and recommended containment action. +- Do not rotate, revoke, copy, or otherwise modify credentials unless that exact action is explicitly authorized. + +## Validation + +- Discover supported build, test, lint, type-check, and formatting commands from repository files and project instructions. Do not invent commands. +- Include intended validation in the discussion-phase plan. +- After approved changes, run the narrowest relevant validation first, then broader checks when appropriate. +- Limit formatting to files within the approved scope. +- Do not run tests that require a shared database, production service, paid external API, or sensitive data unless separately authorized. +- Do not claim that a check passed unless it was executed successfully. +- If a check cannot be run, state the exact reason. +- Distinguish a current-change failure from a pre-existing failure or an undetermined failure. +- Do not fix unrelated failures without expanding the approved scope. +- Inspect the worktree after validation for unexpected generated files, formatting churn, encoding changes, or lockfile changes. + +## Artifacts and Session Records + +- Do not create full-session transcripts, automatic HTML copies, analysis reports, or extra documentation unless explicitly requested. +- Store durable information in the repository's existing documentation structure. +- Do not place generated reports or temporary analysis files in the repository root. +- Remove task-specific temporary files created by the current task after validation when removal is safe. + +## Completion Report + +When implementation is complete, report in Korean: + +- what changed and why; +- the main affected files or components; +- validation commands actually executed and their results; +- checks not executed and the reason; +- remaining risks, assumptions, or follow-up work; +- database, deployment, dependency, encoding, and compatibility impact when applicable. + +- Do not report completion while required validation is failing or known encoding corruption is unresolved. +- Keep the report concise and do not include a full session transcript. + +## Scaffold CLI Project Rules + +- Treat both the CLI interface and the generated project structure as public contracts. +- Preserve existing command names, flags, defaults, prompts, exit behavior, and generated paths unless a breaking change is explicitly approved. +- Keep generation deterministic for the same input and template version. +- Do not embed credentials, user-specific absolute paths, local machine state, or uncommitted source files in templates. +- Never overwrite a non-empty target directory unless the user explicitly selected and authorized the supported force behavior. +- Validate template changes by generating a project in a newly created, disposable directory. +- Validate the generated project with its own type-check, build, or compile commands when practical. +- Inspect generated output for unresolved placeholders, accidental secrets, invalid encodings, machine-specific paths, and unexpected files. +- Keep README usage, CLI help, templates, and implementation synchronized. +- Preserve operation when the central Agent Harness is not installed. +- Generate the committed Agent Harness file set by default for every new project. +- Updating embedded harness templates does not authorize publishing the CLI package. + +## TypeScript + +- Treat the repository's current TypeScript version, `tsconfig` files, module system, path aliases, and package manager as authoritative. +- Preserve or strengthen existing strictness. Do not weaken compiler options or hide errors with broad `any`, `@ts-ignore`, or unsafe assertions. +- Prefer narrow domain types, discriminated unions, and explicit boundary types over duplicated or overly generic shapes. +- Validate untrusted runtime input even when a compile-time type exists. +- Keep imports, exports, aliases, and generated-code boundaries consistent with the repository. +- Do not introduce a JavaScript-to-TypeScript conversion outside the approved scope. +- Run the repository's focused type-check, lint, test, and build commands as applicable. + +## React + +- Treat the current React version, component style, state management, routing, styling, and test approach as authoritative. +- Do not perform unrelated class-to-hook, JavaScript-to-TypeScript, state-library, styling-system, or React-to-Next.js migrations. +- Keep components focused and follow the repository's established split between presentation, state, data access, and side effects. +- Keep effects dependency-correct and clean up subscriptions, timers, listeners, and in-flight work where applicable. +- Use stable semantic keys and preserve accessibility, loading, empty, error, disabled, and success states. +- Preserve public component props and shared UI contracts unless a coordinated breaking change is explicitly approved. +- Treat any planned Next.js migration as a separate policy and task; the current React application remains authoritative until that migration slice is approved. + +## Next.js + +- Treat the repository's current Next.js and React versions, routing model, rendering model, and package manager as authoritative. +- Preserve server and client component boundaries. Add `use client` only when browser APIs, state, effects, or client-only libraries require it. +- Keep secrets, privileged data access, and server-only modules out of client bundles. +- Preserve established route, layout, middleware, authentication, authorization, caching, revalidation, and error-handling conventions. +- Validate request parameters, payloads, headers, cookies, and external responses at runtime. +- Do not create new frontend TypeScript type or interface names ending in `Dto` or `DTO`. Use domain- or purpose-specific names such as `User`, `UserInput`, `UserRequest`, or `UserResponse`; do not rename existing types solely to enforce this rule outside the approved scope. +- Use the approved KRI frontend and UI contracts when the project profile includes them; do not copy shared implementations into an application. +- Avoid incidental routing-model or rendering-strategy migrations. +- Run the repository's focused lint, type-check, test, and production build commands as applicable. + +## KriFrontCommon Consumer Contract + +### Package Usage + +- Consume this contract through the published `@kri/common` package and only through entry points declared in its `package.json` `exports` map. +- Use the package root for runtime-neutral object, URL, date, string, and shared type utilities. +- Use a focused subpath such as `@kri/common/http`, `@kri/common/browser`, `@kri/common/server`, `@kri/common/security`, `@kri/common/hooks`, `@kri/common/query`, `@kri/common/config`, `@kri/common/jotai`, or `@kri/common/noti-hub` for the corresponding capability. +- Do not import from `@kri/common/src/*`, `@kri/common/dist/*`, or another undeclared deep path. +- Do not copy or fork a shared utility locally merely to avoid using an available public entry point. Propose a backward-compatible library addition when the shared contract is genuinely missing. + +### Runtime and Optional Integrations + +- Keep browser, server, and runtime-neutral imports on their intended side of the application boundary. +- A consumer that uses React hooks, TanStack Query, or Jotai integrations must provide the compatible optional peer dependency required by its selected entry point. +- Preserve the project's established HTTP client, authentication, error-policy, query-client, storage, and environment conventions when adopting a shared helper. +- Validate external data at runtime; a shared TypeScript type alone does not validate an API response or persisted value. +- Prefer named public exports and retain the consumer project's current module system and bundler conventions. + +### Change Safety + +- Pin or constrain the package version according to the consumer repository's dependency policy and commit its lockfile changes. +- Review release notes and the actual affected API before upgrading. Run the consumer's focused type-check, test, and build commands after an upgrade. +- Do not modify KriFrontCommon or another consumer repository unless it is explicitly included in the approved task scope. + +## KriUiRegistry Consumer Contract + +### UI Component Selection + +When implementing or changing frontend UI, use this order: + +1. Reuse an existing shared component in the project when it already meets the requirement. +2. Prefer an approved component from KriUiRegistry. +3. Otherwise, prefer a suitable shadcn/ui component. +4. Create a new custom component only when the preceding options cannot meet the requirement without an unsafe or misleading adaptation. + +### Installation and Ownership + +- Inspect the registry item and its dependencies before installation. Use the shadcn CLI with the approved registry endpoint under `https://ui-registry.kric.com/r/` instead of copying files from `dist/r` manually. +- Respect the consumer project's component aliases, target paths, package manager, styling system, React version, and existing design tokens. +- The shadcn workflow copies component source into the consumer repository. After installation, treat that copy as project-owned code; do not assume registry updates propagate automatically. +- Do not overwrite an existing project component without reviewing the diff and confirming that local behavior and accessibility are preserved. +- Keep package and lockfile changes produced by an installation within the approved scope. + +### Adaptation and Verification + +- Adapt business data and application behavior outside the shared component when possible. Avoid embedding project-specific API, route, authentication, or environment logic into a reusable component. +- Preserve the installed component's public props, accessibility, keyboard behavior, responsive layout, and loading, empty, error, and disabled states unless the task explicitly changes them. +- If the registry lacks a generally reusable capability, propose it in KriUiRegistry; do not modify that repository unless it is explicitly in scope. +- Run the consumer repository's focused type-check, lint, tests, and build after installation or upgrade. + +## KriCreateNextApp Repository Rules + +### Repository Role and Contracts + +- This repository provides the Node.js 20 TypeScript CLI `@kri/create-next-app` and the template used to create KRI Next.js frontend applications. +- Treat command names, flags, prompts, defaults, generated paths, dependency policy, template structure, and validation order as public contracts. +- `src` is authoritative. `dist` is ignored build output and must not be edited or committed directly. +- Keep the CLI implementation, help text, README, and templates synchronized whenever generated behavior changes. + +### Generated Frontend Invariants + +- Generated applications use TypeScript, React, Next.js, `@kri/common`, shadcn, and the KRI UI Registry contract declared by this repository profile. +- Install `@kri/common@latest` and record the resolved dependency as an exact version using the existing npm workflow. +- Prefer shadcn and approved KRI UI Registry components over new local primitives when a suitable component exists. +- Do not introduce new frontend type or interface names ending in `Dto` or `DTO`. +- Generate `.agent/profile.yml`, `.agent/project.md`, and harness line-ending policy for every project. Never copy a stale precomposed `AGENTS.md` into the template. + +### Harness Integration + +- Generated projects default to `requested-project`; allow the supported explicit project-type override without changing the fixed `frontend` layer. +- When the central harness is available, register the project locally and run compose followed by verify. Central-harness absence must not prevent project creation. +- `AGENTS.md` and `CLAUDE.md` in this repository are harness-generated outputs. Never edit either file directly; edit `.agent` sources and recompose. +- Do not commit user-specific absolute harness paths or credentials. Explicit paths are runtime inputs only. + +### Verification and Publication + +- Run `npm.cmd run typecheck` and `npm.cmd run build` on Windows for CLI changes. +- Validate template changes by generating into a disposable directory without network installation first, then inspect unresolved placeholders, encoding, and harness composition. +- Package publication, registry access, and network installation require separate explicit approval. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..43c994c --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +@AGENTS.md diff --git a/README.md b/README.md index c941d12..f9925b5 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,17 @@ npx @kri/create-next-app survey-front --yes 주요 옵션은 `--help`로 확인합니다. +Agent Harness 관련 기본값과 옵션: + +```text +--project-type requested-project|internal-service|shared-service +--agent-project-id 하네스 프로젝트 ID (기본: 프로젝트명 slug) +--harness-root 중앙 Agent Harness 저장소 경로 +--skip-agent-compose 하네스 자동 등록·합성·검증 생략 +``` + +`--yes` 사용 시 프로젝트 유형은 `requested-project`입니다. + ## 생성 과정 1. 표준 템플릿 복사 @@ -42,9 +53,22 @@ npx @kri/create-next-app survey-front --yes 4. KRI UI Registry 9개 항목 설치 5. TypeScript 검사 6. Next.js production build +7. Agent Harness 로컬 등록, `AGENTS.md`/`CLAUDE.md` 합성 및 검증 UI Registry: `https://ui-registry.kric.com/r` +## Agent Harness + +생성 프로젝트에는 `.agent/profile.yml`, `.agent/project.md`, `.gitattributes`가 항상 포함됩니다. + +중앙 하네스는 다음 순서로 탐색합니다. + +1. `--harness-root` +2. `KRI_AGENT_HARNESS_ROOT` 환경변수 +3. 생성 경로의 상위 디렉터리 + +하네스를 발견하면 프로젝트를 `workspace.local.yml`에 등록하고 `compose`, `verify`를 실행합니다. 하네스를 찾지 못해도 프로젝트 생성은 완료되며, 이 경우 `.agent` 원본을 중앙 하네스에서 나중에 등록·합성해야 합니다. + ## 생성되는 환경 파일 `.env`, `.env.local`, `.env.development`, `.env.production`, `.env.example`을 생성합니다. `.env.local`과 `.env`는 기본적으로 Git에서 제외되며, `.env.development`와 `.env.production`은 Jenkins 빌드에 사용할 수 있도록 추적 가능합니다. diff --git a/src/args.ts b/src/args.ts index 93120ea..128d860 100644 --- a/src/args.ts +++ b/src/args.ts @@ -1,5 +1,5 @@ import path from "node:path"; -import type { ParsedArguments } from "./types.js"; +import type { ParsedArguments, ProjectType } from "./types.js"; const requireValue = (args: string[], index: number, option: string): string => { const value = args[index + 1]; @@ -9,6 +9,15 @@ const requireValue = (args: string[], index: number, option: string): string => return value; }; +export const parseProjectType = (value: string): ProjectType => { + if (value === "requested-project" || value === "internal-service" || value === "shared-service") { + return value; + } + throw new Error( + "--project-type은 requested-project, internal-service, shared-service 중 하나여야 합니다.", + ); +}; + export function parseArguments(argv: string[]): ParsedArguments { const parsed: ParsedArguments = { yes: false, @@ -16,6 +25,7 @@ export function parseArguments(argv: string[]): ParsedArguments { installUi: true, build: true, jenkins: true, + skipAgentCompose: false, force: false, help: false, }; @@ -55,6 +65,21 @@ export function parseArguments(argv: string[]): ParsedArguments { case "--no-jenkins": parsed.jenkins = false; break; + case "--skip-agent-compose": + parsed.skipAgentCompose = true; + break; + case "--project-type": + parsed.projectType = parseProjectType(requireValue(argv, index, arg)); + index += 1; + break; + case "--agent-project-id": + parsed.agentProjectId = requireValue(argv, index, arg); + index += 1; + break; + case "--harness-root": + parsed.harnessRoot = path.resolve(requireValue(argv, index, arg)); + index += 1; + break; case "--target-dir": parsed.targetDir = path.resolve(requireValue(argv, index, arg)); index += 1; @@ -112,6 +137,9 @@ export function printHelp(): void { 옵션: --display-name 화면 표시 이름 --description 프로젝트 설명 + --project-type requested-project|internal-service|shared-service + --agent-project-id 하네스 프로젝트 ID (기본: 프로젝트명 slug) + --harness-root 중앙 Agent Harness 저장소 경로 --port 개발/실행 포트 (기본 4000) --repo-url Gitea 저장소 URL --app-root Ubuntu 배포 경로 @@ -123,6 +151,7 @@ export function printHelp(): void { --skip-install npm 설치, UI 설치, 검증 생략 --skip-ui KRI UI Registry 설치 생략 --skip-build typecheck/build 생략 + --skip-agent-compose 하네스 자동 등록·합성·검증 생략 --no-jenkins Jenkinsfile 생성 안 함 --force 비어 있지 않은 대상 폴더 사용 --help, -h 도움말 diff --git a/src/cli.ts b/src/cli.ts index 5b0c522..0b5fbe0 100644 --- a/src/cli.ts +++ b/src/cli.ts @@ -2,12 +2,13 @@ import path from "node:path"; import process from "node:process"; -import { parseArguments, printHelp } from "./args.js"; +import { parseArguments, parseProjectType, printHelp } from "./args.js"; import { createProject } from "./create-project.js"; import { ask, confirm } from "./prompts.js"; import type { CliOptions } from "./types.js"; const PROJECT_NAME_PATTERN = /^(?:@[a-z0-9][a-z0-9._-]*\/)?[a-z0-9][a-z0-9._-]*$/; +const AGENT_PROJECT_ID_PATTERN = /^[a-z0-9]+(?:-[a-z0-9]+)*$/; function validateProjectName(name: string): string { const normalized = name.trim(); @@ -17,6 +18,22 @@ function validateProjectName(name: string): string { return normalized; } +function defaultAgentProjectId(projectName: string): string { + const unscopedName = projectName.split("/").at(-1) ?? projectName; + return unscopedName + .toLowerCase() + .replace(/[^a-z0-9]+/g, "-") + .replace(/^-+|-+$/g, ""); +} + +function validateAgentProjectId(value: string): string { + const normalized = value.trim(); + if (!AGENT_PROJECT_ID_PATTERN.test(normalized)) { + throw new Error("Agent Harness 프로젝트 ID는 영문 소문자, 숫자, 하이픈으로 구성된 slug여야 합니다."); + } + return normalized; +} + async function resolveOptions(): Promise { const parsed = parseArguments(process.argv.slice(2)); if (parsed.help) { @@ -29,6 +46,19 @@ async function resolveOptions(): Promise { if (!projectName) throw new Error("프로젝트명이 필요합니다."); projectName = validateProjectName(projectName); + const agentProjectId = validateAgentProjectId( + parsed.agentProjectId ?? defaultAgentProjectId(projectName), + ); + const projectType = parsed.projectType + ?? (parsed.yes + ? "requested-project" + : parseProjectType( + (await ask( + "Project type (requested-project/internal-service/shared-service)", + "requested-project", + )).toLowerCase(), + )); + const displayName = parsed.displayName ?? (parsed.yes ? projectName : await ask("프로젝트 표시 이름", projectName)); const description = parsed.description @@ -54,6 +84,8 @@ async function resolveOptions(): Promise { return { projectName, + agentProjectId, + projectType, targetDir, displayName, description, @@ -68,6 +100,8 @@ async function resolveOptions(): Promise { installUi: parsed.installUi, build: parsed.build, jenkins, + harnessRoot: parsed.harnessRoot, + skipAgentCompose: parsed.skipAgentCompose, force: parsed.force, }; } diff --git a/src/create-project.ts b/src/create-project.ts index 01fc782..d857756 100644 --- a/src/create-project.ts +++ b/src/create-project.ts @@ -3,6 +3,7 @@ import path from "node:path"; import { writeFile } from "node:fs/promises"; import { KRI_REGISTRY_ITEMS, REGISTRY_BASE_URL } from "./constants.js"; import { copyTemplate, ensureTargetDirectory, removeJenkinsfile, replacePlaceholders } from "./files.js"; +import { composeAgentHarness } from "./harness.js"; import { run } from "./process.js"; import type { CliOptions } from "./types.js"; @@ -58,6 +59,9 @@ export async function createProject(options: CliOptions): Promise { await replacePlaceholders(options.targetDir, { "__PROJECT_NAME__": options.projectName, + "__AGENT_PROJECT_ID__": options.agentProjectId, + "__AGENT_PROJECT_NAME_YAML__": JSON.stringify(options.projectName), + "__AGENT_PROJECT_TYPE__": options.projectType, "__DISPLAY_NAME__": options.displayName, "__DESCRIPTION__": options.description, "__PORT__": String(options.port), @@ -77,6 +81,7 @@ export async function createProject(options: CliOptions): Promise { if (!options.install) { console.log("[SKIP] npm install"); + await composeAgentHarness(options); return; } @@ -103,12 +108,14 @@ export async function createProject(options: CliOptions): Promise { if (options.build) { if (!options.installUi) { console.warn("[WARN] --skip-ui 때문에 typecheck/build를 생략합니다."); - return; + } else { + console.log("\n[4/4] TypeScript 및 production build 검증"); + await run("npm", ["run", "typecheck"], options.targetDir); + await run("npm", ["run", "build"], options.targetDir); } - console.log("\n[4/4] TypeScript 및 production build 검증"); - await run("npm", ["run", "typecheck"], options.targetDir); - await run("npm", ["run", "build"], options.targetDir); } else { console.log("[SKIP] typecheck/build"); } + + await composeAgentHarness(options); } diff --git a/src/files.ts b/src/files.ts index a0e5f16..e584f24 100644 --- a/src/files.ts +++ b/src/files.ts @@ -3,6 +3,8 @@ import path from "node:path"; const RENAMES: Record = { "_gitignore": ".gitignore", + "_gitattributes": ".gitattributes", + "_agent": ".agent", "_npmrc": ".npmrc", "_env": ".env", "_env.local": ".env.local", diff --git a/src/harness.ts b/src/harness.ts new file mode 100644 index 0000000..e969de4 --- /dev/null +++ b/src/harness.ts @@ -0,0 +1,115 @@ +import { access } from "node:fs/promises"; +import path from "node:path"; +import process from "node:process"; +import { spawn } from "node:child_process"; + +const HARNESS_DIRECTORY_NAME = "_________AgentHarnessBase"; +const HARNESS_CLI_PATH = path.join("dist", "cli.cjs"); + +interface HarnessOptions { + targetDir: string; + agentProjectId: string; + harnessRoot?: string; + skipAgentCompose: boolean; +} + +async function isHarnessRoot(candidate: string): Promise { + try { + await Promise.all([ + access(path.join(candidate, "workspace.yml")), + access(path.join(candidate, HARNESS_CLI_PATH)), + ]); + return true; + } catch { + return false; + } +} + +async function configuredHarnessRoot(candidate: string, source: string): Promise { + const resolved = path.resolve(candidate); + if (!(await isHarnessRoot(resolved))) { + throw new Error(`${source}에 유효한 Agent Harness가 없습니다: ${resolved}`); + } + return resolved; +} + +async function findHarnessRoot(options: HarnessOptions): Promise { + if (options.harnessRoot) { + return configuredHarnessRoot(options.harnessRoot, "--harness-root"); + } + + const environmentRoot = process.env.KRI_AGENT_HARNESS_ROOT?.trim(); + if (environmentRoot) { + return configuredHarnessRoot(environmentRoot, "KRI_AGENT_HARNESS_ROOT"); + } + + let current = path.resolve(options.targetDir); + while (true) { + const candidate = path.join(current, HARNESS_DIRECTORY_NAME); + if (await isHarnessRoot(candidate)) return candidate; + + const parent = path.dirname(current); + if (parent === current) return undefined; + current = parent; + } +} + +function workspaceRelativePath(harnessRoot: string, targetDir: string): string { + const workspaceRoot = path.dirname(harnessRoot); + const relative = path.relative(workspaceRoot, path.resolve(targetDir)); + if (!relative || path.isAbsolute(relative) || relative === ".." || relative.startsWith(`..${path.sep}`)) { + throw new Error(`생성 경로가 Agent Harness 워크스페이스 밖에 있습니다: ${targetDir}`); + } + return relative.split(path.sep).join("/"); +} + +async function runHarness(harnessRoot: string, args: string[]): Promise { + const cliPath = path.join(harnessRoot, HARNESS_CLI_PATH); + await new Promise((resolve, reject) => { + const child = spawn(process.execPath, [cliPath, ...args], { + cwd: harnessRoot, + env: process.env, + stdio: "inherit", + shell: false, + windowsHide: true, + }); + + child.once("error", reject); + child.once("exit", (code, signal) => { + if (code === 0) { + resolve(); + return; + } + reject(new Error( + `Agent Harness ${args[0]} 실패 (code=${code ?? "null"}, signal=${signal ?? "none"})`, + )); + }); + }); +} + +export async function composeAgentHarness(options: HarnessOptions): Promise { + if (options.skipAgentCompose) { + console.log("[SKIP] Agent Harness 자동 등록·합성·검증"); + return; + } + + const harnessRoot = await findHarnessRoot(options); + if (!harnessRoot) { + console.warn( + "[WARN] 중앙 Agent Harness를 찾지 못했습니다. .agent 원본은 생성했지만 AGENTS.md와 CLAUDE.md는 아직 합성되지 않았습니다.", + ); + return; + } + + const projectPath = workspaceRelativePath(harnessRoot, options.targetDir); + console.log("\n[Agent Harness] 로컬 등록·합성·검증"); + await runHarness(harnessRoot, [ + "register", + "--project", + options.agentProjectId, + "--path", + projectPath, + ]); + await runHarness(harnessRoot, ["compose", "--project", options.agentProjectId]); + await runHarness(harnessRoot, ["verify", "--project", options.agentProjectId]); +} diff --git a/src/types.ts b/src/types.ts index 3162e4f..49740fc 100644 --- a/src/types.ts +++ b/src/types.ts @@ -1,5 +1,9 @@ +export type ProjectType = "requested-project" | "internal-service" | "shared-service"; + export interface CliOptions { projectName: string; + agentProjectId: string; + projectType: ProjectType; targetDir: string; displayName: string; description: string; @@ -14,11 +18,15 @@ export interface CliOptions { installUi: boolean; build: boolean; jenkins: boolean; + harnessRoot?: string; + skipAgentCompose: boolean; force: boolean; } export interface ParsedArguments { projectName?: string; + agentProjectId?: string; + projectType?: ProjectType; targetDir?: string; displayName?: string; description?: string; @@ -33,6 +41,8 @@ export interface ParsedArguments { installUi: boolean; build: boolean; jenkins: boolean; + harnessRoot?: string; + skipAgentCompose: boolean; force: boolean; help: boolean; } diff --git a/templates/base/README.md.template b/templates/base/README.md.template index b5ce420..eb1a476 100644 --- a/templates/base/README.md.template +++ b/templates/base/README.md.template @@ -33,3 +33,11 @@ npm run dev npm run typecheck npm run build ``` + +## Agent Harness + +- 프로젝트 ID: `__AGENT_PROJECT_ID__` +- 프로젝트 유형: `__AGENT_PROJECT_TYPE__` +- 권위 원본: `.agent/profile.yml`, `.agent/project.md` + +`AGENTS.md`와 `CLAUDE.md`는 중앙 Agent Harness가 합성합니다. 두 파일을 직접 수정하지 않습니다. diff --git a/templates/base/_agent/profile.yml b/templates/base/_agent/profile.yml new file mode 100644 index 0000000..6144ae5 --- /dev/null +++ b/templates/base/_agent/profile.yml @@ -0,0 +1,18 @@ +schema_version: 1 + +project: + id: __AGENT_PROJECT_ID__ + name: __AGENT_PROJECT_NAME_YAML__ + type: __AGENT_PROJECT_TYPE__ + layer: frontend + legacy: false + +stack: + - typescript + - react + - nextjs + +shared_contracts: + consumes: + - kri-front-common + - kri-ui-registry diff --git a/templates/base/_agent/project.md b/templates/base/_agent/project.md new file mode 100644 index 0000000..7db9d97 --- /dev/null +++ b/templates/base/_agent/project.md @@ -0,0 +1,9 @@ +## Generated Next.js Repository Rules + +- This frontend application was generated by `@kri/create-next-app`. +- Keep the generated Next.js routing, server/client boundary, authentication, environment, state, query, and application-shell conventions unless an approved task changes them. +- Prefer shadcn and approved KRI UI Registry components over new local primitives when a suitable component exists. +- Do not create new TypeScript type or interface names ending in `Dto` or `DTO`. +- Consume shared frontend behavior from `@kri/common` and the KRI UI Registry instead of copying provider implementations into this repository. +- `AGENTS.md` and `CLAUDE.md` are central-harness generated outputs. Never edit them directly; update `.agent/profile.yml` or `.agent/project.md` and recompose. +- Run `npm run typecheck` and `npm run build` after relevant source or configuration changes. diff --git a/templates/base/_gitattributes b/templates/base/_gitattributes new file mode 100644 index 0000000..a67f1ff --- /dev/null +++ b/templates/base/_gitattributes @@ -0,0 +1,4 @@ +/AGENTS.md text eol=lf +/CLAUDE.md text eol=lf +/.agent/*.md text eol=lf +/.agent/*.yml text eol=lf