From 9ea7944414b3080bb664da2485a02fd8737c16c4 Mon Sep 17 00:00:00 2001 From: kric_jspark Date: Thu, 6 Aug 2026 17:03:20 +0900 Subject: [PATCH] =?UTF-8?q?260806=5F01=5FENH:=20Agent=20Harness=20?= =?UTF-8?q?=EC=97=B0=EB=8F=99=20=EB=B0=8F=20KriCommon=20=EB=B2=84=EC=A0=84?= =?UTF-8?q?=20=EA=B3=A0=EC=A0=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .agent/profile.yml | 16 ++ .agent/project.md | 29 +++ .gitattributes | 4 + AGENTS.md | 291 ++++++++++++++++++++++++++++++ CLAUDE.md | 1 + README.md | 20 +- src/args.ts | 31 +++- src/cli.ts | 35 +++- src/create-project.ts | 20 +- src/files.ts | 1 + src/harness.ts | 115 ++++++++++++ src/types.ts | 9 + templates/base/README.md.template | 10 +- templates/base/_agent/profile.yml | 21 +++ templates/base/_agent/project.md | 8 + templates/base/_gitattributes | 4 + templates/base/build.gradle | 2 +- 17 files changed, 605 insertions(+), 12 deletions(-) create mode 100644 .agent/profile.yml create mode 100644 .agent/project.md create mode 100644 .gitattributes create mode 100644 AGENTS.md create mode 100644 CLAUDE.md create mode 100644 src/harness.ts create mode 100644 templates/base/_agent/profile.yml create mode 100644 templates/base/_agent/project.md diff --git a/.agent/profile.yml b/.agent/profile.yml new file mode 100644 index 0000000..8c1ded0 --- /dev/null +++ b/.agent/profile.yml @@ -0,0 +1,16 @@ +schema_version: 1 + +project: + id: kri-create-spring-app + name: KriCreateSpringApp + type: scaffold-cli + layer: standalone + legacy: false + +stack: + - typescript + - java-springboot + +shared_contracts: + consumes: + - kri-common diff --git a/.agent/project.md b/.agent/project.md new file mode 100644 index 0000000..595b419 --- /dev/null +++ b/.agent/project.md @@ -0,0 +1,29 @@ +## KriCreateSpringApp Repository Rules + +### Repository Role and Contracts + +- This repository provides the Node.js 20 TypeScript CLI `@kri/create-spring-app` and the template used to create KRI Spring Boot backend applications. +- Treat command names, flags, prompts, defaults, generated paths, dependency versions, database choices, 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 Backend Invariants + +- Generated applications use Java 17, Spring Boot 3.5.7, the repository Gradle Wrapper, and `com.kri.common:starter:beta.1.6.3`. +- Keep the approved KriCommon version exact. Do not restore `latest.release` or another dynamic version. +- Preserve the selected MySQL or MSSQL driver, profile configuration, JPA/QueryDSL structure, and optional MyBatis template behavior. +- 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 `backend` layer. +- Include the selected database in the generated profile and declare consumption of the KriCommon contract. +- 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 with `--skip-build`, then inspect unresolved placeholders, encoding, and harness composition. +- A full generated Gradle build, package publication, registry access, and other network operations 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..6263738 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,291 @@ + + +# 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. + +## Java and Spring Boot + +- Treat the configured JDK, Spring Boot, Gradle, plugin, dependency, and package versions as authoritative. +- Use the repository's Gradle Wrapper. Do not substitute a machine-global Gradle installation. +- Preserve the established package layout and controller, application/service, domain, and persistence boundaries. +- Keep controllers thin, place business rules in the established service/domain layer, and prefer constructor injection. +- Apply request and configuration validation at boundaries and preserve the project's exception and response conventions. +- Make transaction boundaries explicit and narrow; do not add broad transactions to hide lifecycle or query problems. +- Preserve authentication, authorization, auditing, logging, and secret-management conventions. +- Do not edit generated QueryDSL or other generated sources. Change their source definitions and regenerate only when the repository workflow requires it. +- Use the approved KriCommon contract when the project profile includes it; do not duplicate shared backend behavior locally. +- Run the narrowest relevant Gradle compile, test, static-analysis, and build tasks. + +## KriCommon Consumer Contract + +### Dependency and API Boundary + +- Consume KriCommon as `com.kri.common:starter:` using the consumer repository's established Gradle dependency and version-management conventions. +- Import service-facing APIs from `com.kri.common.feature.*`. Treat `com.kri.common.runtime.*` as internal and do not bind application code to it unless no public API exists and the exception is explicitly documented. +- Include the matching Spring starter for any optional Web, Security, JPA, Redis, AOP, or Swagger integration the service enables; KriCommon intentionally declares many integrations as compile-only. +- Prefer the shared feature or an approved extension point over duplicating authentication, HTTP, error, enum, Excel, Redis, JSON, date/time, JPA, or utility behavior locally. + +### Configuration and Overrides + +- KriCommon configuration uses only `kri.*`. Established groups include `kri.auth.jwt`, `kri.auth.apikey`, `kri.security`, `kri.swagger`, `kri.web`, `kri.web.mdc`, `kri.http.bypass`, `kri.redis`, `kri.scheduling`, and `kri.error.expose`. +- Read the version-matched README and configuration-property classes before setting a property; do not infer a property name or default from an older service. +- Supply production JWT secrets, API keys, credentials, allowlists, and service URLs through the consumer's approved secret and configuration system. Never rely on library example or default secrets in production. +- Preserve consumer override points. KriCommon's default security chain is created only when the consumer does not provide one, and overridable beans should remain explicit. +- Adding a path to API-key allowed paths scopes where API-key authentication is attempted; it does not make the path public or grant authorization. + +### Major Optional Capabilities + +- JWT and API-key authentication integrate with Spring Security. API-key JPA preload requires Spring Data JPA; a consumer-provided claims provider can be used without JPA. +- Common Web may register error handling, tracing/MDC, request-user resolution, enum conversion, and CORS behavior. Check for overlap before defining consumer-local equivalents. +- Swagger support requires springdoc and defines the shared Bearer/API-key schemes and grouped paths. +- Redis and scheduling are opt-in through their `kri.*.enabled` settings and matching runtime dependencies. +- HTTP bypass targets are server-configured. Never accept an arbitrary full target URL from a frontend; retain allowed-path checks and do not forward hop-by-hop headers. +- The external API client returns response bodies as documented, while bypass responses preserve raw bytes and target `Content-Type`. +- `ExternalApiClient` multipart requests generate their own boundary and ignore a caller-supplied `Content-Type`. Multipart headers and `formField` values use UTF-8, while file bodies preserve the supplied bytes. +- Multipart filenames, including non-ASCII names, are sent unchanged in the quoted `filename` parameter as raw UTF-8. No ASCII fallback or `filename*` parameter is added; CR/LF rejection and quote/backslash escaping still apply. +- `JsonUtil` requires the consumer's explicit `ObjectMapper`; shared date/time helpers define KST as `Asia/Seoul` and also expose UTC semantics. + +### Upgrade and Verification + +- Review KriCommon release notes, README changes, configuration defaults, auto-configuration conditions, and affected public APIs before upgrading. +- Commit dependency-lock or resolved-version changes according to the consumer repository's policy. +- Run the consumer's focused compile and tests after an upgrade, including application-context startup tests when auto-configuration or security behavior is affected. +- Do not modify KriCommon or another consumer repository unless it is explicitly included in the approved task scope. + +## KriCreateSpringApp Repository Rules + +### Repository Role and Contracts + +- This repository provides the Node.js 20 TypeScript CLI `@kri/create-spring-app` and the template used to create KRI Spring Boot backend applications. +- Treat command names, flags, prompts, defaults, generated paths, dependency versions, database choices, 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 Backend Invariants + +- Generated applications use Java 17, Spring Boot 3.5.7, the repository Gradle Wrapper, and `com.kri.common:starter:beta.1.6.3`. +- Keep the approved KriCommon version exact. Do not restore `latest.release` or another dynamic version. +- Preserve the selected MySQL or MSSQL driver, profile configuration, JPA/QueryDSL structure, and optional MyBatis template behavior. +- 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 `backend` layer. +- Include the selected database in the generated profile and declare consumption of the KriCommon contract. +- 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 with `--skip-build`, then inspect unresolved placeholders, encoding, and harness composition. +- A full generated Gradle build, package publication, registry access, and other network operations 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 4ca9932..cc9bcea 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ KRI 표준 Spring Boot 프로젝트 생성 CLI입니다. - Java 17 - Spring Boot 3.5.7 - Gradle Groovy DSL / Gradle Wrapper 8.14.3 -- `com.kri.common:starter:latest.release` +- `com.kri.common:starter:beta.1.6.3` - JPA + QueryDSL + JdbcTemplate 벌크 처리 예제 - EmbeddedId 복합키 예제 - MyBatis 선택 설치 @@ -47,6 +47,9 @@ npx @kri/create-spring-app sample-server ```text --base-package 기본 패키지 --description 프로젝트 설명 +--project-type requested-project|internal-service|shared-service +--agent-project-id 하네스 프로젝트 ID (기본: 프로젝트명 slug) +--harness-root 중앙 Agent Harness 저장소 경로 --port 서버 포트 (기본 8080) --database mysql|mssql DB 종류 (기본 mysql) --mybatis MyBatis 예제 포함 @@ -59,11 +62,26 @@ npx @kri/create-spring-app sample-server --target-dir 생성 경로 --yes, -y 질문 없이 기본값 사용 --skip-build Gradle build 생략 +--skip-agent-compose 하네스 자동 등록·합성·검증 생략 --no-jenkins Jenkinsfile 생성 안 함 --force 비어 있지 않은 대상 폴더 사용 --help, -h 도움말 ``` +`--yes` 사용 시 프로젝트 유형은 `requested-project`입니다. + +## Agent Harness + +생성 프로젝트에는 `.agent/profile.yml`, `.agent/project.md`, `.gitattributes`가 항상 포함됩니다. + +중앙 하네스는 다음 순서로 탐색합니다. + +1. `--harness-root` +2. `KRI_AGENT_HARNESS_ROOT` 환경변수 +3. 생성 경로의 상위 디렉터리 + +하네스를 발견하면 프로젝트를 `workspace.local.yml`에 등록하고 `compose`, `verify`를 실행합니다. 하네스를 찾지 못해도 프로젝트 생성은 완료되며, 이 경우 `.agent` 원본을 중앙 하네스에서 나중에 등록·합성해야 합니다. + ## Gitea Maven 인증 개발자 PC의 `%USERPROFILE%\.gradle\gradle.properties`: diff --git a/src/args.ts b/src/args.ts index 9077bfa..7a5ddb7 100644 --- a/src/args.ts +++ b/src/args.ts @@ -1,5 +1,5 @@ import path from "node:path"; -import type { DatabaseType, ParsedArguments } from "./types.js"; +import type { DatabaseType, ParsedArguments, ProjectType } from "./types.js"; const requireValue = (args: string[], index: number, option: string): string => { const value = args[index + 1]; @@ -14,12 +14,22 @@ const parseDatabase = (value: string): DatabaseType => { throw new Error("--database는 mysql 또는 mssql이어야 합니다."); }; +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, build: true, jenkins: true, mybatis: false, + skipAgentCompose: false, force: false, help: false, }; @@ -54,6 +64,21 @@ export function parseArguments(argv: string[]): ParsedArguments { case "--mybatis": parsed.mybatis = true; 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; @@ -119,6 +144,9 @@ export function printHelp(): void { 옵션: --base-package 기본 패키지 --description 프로젝트 설명 + --project-type requested-project|internal-service|shared-service + --agent-project-id 하네스 프로젝트 ID (기본: 프로젝트명 slug) + --harness-root 중앙 Agent Harness 저장소 경로 --port 서버 포트 (기본 8080) --database mysql|mssql DB 종류 (기본 mysql) --mybatis MyBatis 예제 포함 @@ -131,6 +159,7 @@ export function printHelp(): void { --target-dir 생성 경로 --yes, -y 질문 없이 기본값 사용 --skip-build Gradle build 생략 + --skip-agent-compose 하네스 자동 등록·합성·검증 생략 --no-jenkins Jenkinsfile 생성 안 함 --force 비어 있지 않은 대상 폴더 사용 --help, -h 도움말 diff --git a/src/cli.ts b/src/cli.ts index 0d86c87..b866a2f 100644 --- a/src/cli.ts +++ b/src/cli.ts @@ -2,13 +2,14 @@ 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, DatabaseType } from "./types.js"; const PROJECT_NAME_PATTERN = /^[a-z0-9][a-z0-9._-]*$/; const PACKAGE_PATTERN = /^[a-z][a-z0-9_]*(?:\.[a-z][a-z0-9_]*)+$/; +const AGENT_PROJECT_ID_PATTERN = /^[a-z0-9]+(?:-[a-z0-9]+)*$/; function validateProjectName(name: string): string { const normalized = name.trim(); @@ -18,6 +19,21 @@ function validateProjectName(name: string): string { return normalized; } +function defaultAgentProjectId(projectName: string): string { + return projectName + .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; +} + function defaultBasePackage(projectName: string): string { const suffix = projectName .toLowerCase() @@ -64,6 +80,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 basePackageDefault = defaultBasePackage(projectName); const basePackage = validateBasePackage( parsed.basePackage ?? (parsed.yes ? basePackageDefault : await ask("Base package", basePackageDefault)), @@ -99,6 +128,8 @@ async function resolveOptions(): Promise { return { projectName, + agentProjectId, + projectType, targetDir, basePackage, applicationClass, @@ -115,6 +146,8 @@ async function resolveOptions(): Promise { yes: parsed.yes, 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 af27f76..e703576 100644 --- a/src/create-project.ts +++ b/src/create-project.ts @@ -8,6 +8,7 @@ import { removeMyBatisFiles, replacePlaceholders, } from "./files.js"; +import { composeAgentHarness } from "./harness.js"; import { run } from "./process.js"; import type { CliOptions } from "./types.js"; @@ -55,6 +56,10 @@ 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, + "__DATABASE__": options.database, "__BASE_PACKAGE__": options.basePackage, "__APPLICATION_CLASS__": options.applicationClass, "__DESCRIPTION__": options.description, @@ -75,13 +80,14 @@ export async function createProject(options: CliOptions): Promise { if (!options.build) { console.log("[SKIP] Gradle build"); - return; + } else { + console.log("\n[1/1] Gradle clean build 검증"); + if (process.platform === "win32") { + await run("gradlew.bat", ["clean", "build"], options.targetDir); + } else { + await run("./gradlew", ["clean", "build"], options.targetDir); + } } - console.log("\n[1/1] Gradle clean build 검증"); - if (process.platform === "win32") { - await run("gradlew.bat", ["clean", "build"], options.targetDir); - } else { - await run("./gradlew", ["clean", "build"], options.targetDir); - } + await composeAgentHarness(options); } diff --git a/src/files.ts b/src/files.ts index 24907a9..862ccb0 100644 --- a/src/files.ts +++ b/src/files.ts @@ -4,6 +4,7 @@ import path from "node:path"; const ROOT_RENAMES: Record = { "_gitignore": ".gitignore", "_gitattributes": ".gitattributes", + "_agent": ".agent", "README.md.template": "README.md", "Jenkinsfile.template": "Jenkinsfile", }; 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 a845cbc..af394ed 100644 --- a/src/types.ts +++ b/src/types.ts @@ -1,7 +1,10 @@ export type DatabaseType = "mysql" | "mssql"; +export type ProjectType = "requested-project" | "internal-service" | "shared-service"; export interface CliOptions { projectName: string; + agentProjectId: string; + projectType: ProjectType; targetDir: string; basePackage: string; applicationClass: string; @@ -18,11 +21,15 @@ export interface CliOptions { yes: boolean; build: boolean; jenkins: boolean; + harnessRoot?: string; + skipAgentCompose: boolean; force: boolean; } export interface ParsedArguments { projectName?: string; + agentProjectId?: string; + projectType?: ProjectType; targetDir?: string; basePackage?: string; description?: string; @@ -38,6 +45,8 @@ export interface ParsedArguments { yes: 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 04eaa8a..c529902 100644 --- a/templates/base/README.md.template +++ b/templates/base/README.md.template @@ -6,7 +6,7 @@ __DESCRIPTION__ - Java 17 - Spring Boot 3.5.7 -- `com.kri.common:starter:latest.release` +- `com.kri.common:starter:beta.1.6.3` - JPA + QueryDSL + JdbcTemplate - EmbeddedId 예제 - MyBatis는 생성 옵션에 따라 포함 @@ -71,3 +71,11 @@ kri: ``` 프로젝트 내부에 JWT/API Key 필터를 중복 구현하지 않습니다. + +## 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..031f566 --- /dev/null +++ b/templates/base/_agent/profile.yml @@ -0,0 +1,21 @@ +schema_version: 1 + +project: + id: __AGENT_PROJECT_ID__ + name: __AGENT_PROJECT_NAME_YAML__ + type: __AGENT_PROJECT_TYPE__ + layer: backend + legacy: false + +stack: + - java-springboot + +shared_contracts: + consumes: + - kri-common + +databases: + - id: primary + engine: __DATABASE__ + role: primary + access: read-write diff --git a/templates/base/_agent/project.md b/templates/base/_agent/project.md new file mode 100644 index 0000000..a554f9e --- /dev/null +++ b/templates/base/_agent/project.md @@ -0,0 +1,8 @@ +## Generated Spring Boot Repository Rules + +- This backend application was generated by `@kri/create-spring-app` with Java 17 and Spring Boot 3.5.7. +- Consume KriCommon through `com.kri.common:starter:beta.1.6.3`; do not change that approved version or duplicate shared behavior without explicit approval. +- The selected primary database is `__DATABASE__`. Preserve its configured dialect, driver, transaction, schema, and migration conventions. +- Keep controllers thin and preserve the generated service, DTO, persistence, configuration, QueryDSL, JDBC, and optional MyBatis boundaries. +- `AGENTS.md` and `CLAUDE.md` are central-harness generated outputs. Never edit them directly; update `.agent/profile.yml` or `.agent/project.md` and recompose. +- Use the repository Gradle Wrapper and run `.\gradlew.bat compileJava` followed by focused tests for relevant changes. diff --git a/templates/base/_gitattributes b/templates/base/_gitattributes index 8af972c..e081a32 100644 --- a/templates/base/_gitattributes +++ b/templates/base/_gitattributes @@ -1,3 +1,7 @@ /gradlew text eol=lf *.bat text eol=crlf *.jar binary +/AGENTS.md text eol=lf +/CLAUDE.md text eol=lf +/.agent/*.md text eol=lf +/.agent/*.yml text eol=lf diff --git a/templates/base/build.gradle b/templates/base/build.gradle index 9051e59..7efdbf4 100644 --- a/templates/base/build.gradle +++ b/templates/base/build.gradle @@ -45,7 +45,7 @@ configurations.configureEach { } dependencies { - implementation 'com.kri.common:starter:latest.release' + implementation 'com.kri.common:starter:beta.1.6.3' implementation 'org.springframework.boot:spring-boot-starter-web' implementation 'org.springframework.boot:spring-boot-starter-security'