Files
clean-architecture-frontend…/docs/manual/reference/create-feature.md
T
DongHyeonka 12f3bb7862 refactor(contracts)!: V2 API 행을 지우고 FE-REG-API를 HTTP descriptor에서 뽑는다
문제
기능 하나가 같은 HTTP API를 두 번 적는다. *-api-contract.ts의 V2 행
(defineRestOperation)은 check:registries(FE-REG-API)가 검사하는 선언이고,
contract contribution의 V3 descriptor가 실제로 실행된다. 둘이 어긋나지 않게
http-operation-v2-v3-parity 테스트를 따로 둔다. 048f490으로 V2 클라이언트가
없어져 V2 행을 읽는 실행 코드는 없고, 검사만 남은 두 번째 사본이다. V2 행을
위한 기능별 runtimeSchemas·mappers 레지스트리와 V2 보안 프로필 해석
(resolveRestSecurityProfiles)도 같이 남아 있다. 사용자 지시: 최신 경로 하나만
남기고, 레지스트리 기준선 재승인을 승인했다.

고른 방법
- src/contracts/api-operations.ts를 projectApiOperationRows 하나로 바꿨다.
  조립된 contribution의 descriptor마다 operationId, featureId, method, path,
  authProfileId, retrySemantics, requestBody, responseBody, responseEnvelope,
  request/response/problemSchema(검증기 schemaId) 행을 만든다. FE-REG-API는
  같은 export(API_OPERATIONS)를 읽고, governance 정의를 이 필드로 바꿨다.
  requestSchema·responseSchema는 그대로 FE-REG-SCHEMA를 참조한다.
- FeatureRuntime은 apiContract 대신 schemas(FE-REG-SCHEMA 행)만 받는다.
  installed-feature-runtime-registries는 schemas로 스키마 레지스트리를 만들고
  FE-REG-API 행을 descriptor에서 뽑는다. RUNTIME_SCHEMA_CODECS, MAPPER_REGISTRY,
  REST_PROFILE_BINDINGS_VALID, API_RUNTIME_BINDINGS_VALID를 지웠다.
- realtime snapshot 바인딩은 ApiOperationRow를 받고 method GET과
  retrySemantics SAFE·IDEMPOTENT를 본다(V2의 contractVersion·semantics·
  replayPolicy 대신).
- rest-profiles.ts에서 V2 행용 provider·CSRF 프로필 해석을 지웠다. V3는 조립
  때 auth profile을 검사하고 자격증명 헤더를 프로필로 거른다.
- 참조 기능: reference-api-contract.ts를 reference-schema-metadata.ts로
  바꾸고(스키마 행만), V2 runtime codec·operation mapper·레지스트리 mapper를
  지웠다. V3 descriptor가 쓰지 않는 NoRequest 스키마 행도 지웠다.
- create:feature: <base>-api-contract.ts 대신 <base>-schema-metadata.ts를
  만든다. codec·mapper 레지스트리 행과 그 테스트를 만들지 않는다.
- 레지스트리 기준선을 update:registry-baseline으로 다시 만들고 승인했다
  (digest 16f72742…, 승인자 DongHyeonka, 이유에 사용자 승인을 적음).
- 매뉴얼 01·02·reference, starter-experience, 계약 문서의 V2 설명을 지웠다.

버린 대안
- V2 행을 남기고 V3에서 생성하기: 생성 단계와 생성물이 하나 더 생긴다. 행은
  실행되지 않으므로 메모리에서 뽑아 검사하면 충분하다.
- 스키마 메타데이터(FE-REG-SCHEMA 행)도 검증기에서 뽑기: boundary·
  unknownFieldPolicy·owner는 검증기에 없고, 라우트 스키마도 같은 레지스트리를
  쓴다. 이 행은 V2가 아니라 스키마 레지스트리라 남겼다.

위험·한계
- BREAKING: FeatureRuntime 모양, contracts·rest-profiles·loaded-feature-runtimes
  의 이름이 바뀌거나 없어졌다. memento-frontend의 memento-web이 V2 행을 쓴다.
  옮기는 법은 CHANGELOG에 적는다.
- V2 보안 프로필 일관성 검사(auth "none"과 ANONYMOUS, 쿠키 프로필의 CSRF
  모드)가 사라졌다. V3 descriptor에는 그 칸이 없다.
- BoundedPollOperationContract(realtime polling recipe)는 contractVersion: 2
  필드를 갖지만 자체 계약이라 바꾸지 않았다.

검증
- check:types, lint, check:architecture, check:registries(11 registries PASS,
  compatibility=none), check:ci, check:diagnostics, check:adapter-inventory,
  verify:documentation 통과.
- test:unit 2,566(새 tests/unit/api-operation-rows.test.ts 3건 포함),
  test:integration 114, test:component 245, test:contract 23,
  test:runtime-schema 56, tests/features 99 통과.
- tests/unit/second-api-feature-registries.test.ts: V3 descriptor만 가진 두
  번째 기능을 복사본에 넣으면 기준선을 고치지 않고 check:registries가 통과한다.
- check:bundle 통과. 초기 JS 201,598 → 200,911 B.
- test:feature-scaffold 16개, test:sample-removal 23개 검사 통과.

BREAKING CHANGE: FeatureRuntime이 apiContract 대신 schemas를 받는다.
defineRestOperation, ApiOperation, RestOperationV2, composeApiOperations,
validateApiRuntimeBindings, getApiOperation, contracts의 API_OPERATIONS,
createRestProviderProfile, RestProviderProfile, resolveRestSecurityProfiles,
validateRestProfileBindings, REST_CSRF_PROFILES, RestCsrfProfile,
loaded-feature-runtimes의 RUNTIME_SCHEMA_CODECS, MAPPER_REGISTRY,
REST_PROFILE_BINDINGS_VALID, API_RUNTIME_BINDINGS_VALID가 없어졌다. 기능은
operation을 contract contribution에만 적고, schemas 행을 feature-runtime에
넘긴다.
2026-11-03 21:37:48 +09:00

7.1 KiB

create:feature 참조

모든 merge 게이트를 통과하는 가장 작은 기능을 만드는 명령이다. 정본은 scripts/create-feature.ts다. 템플릿 문자열이 그 파일 안에 있고, 참조 기능을 import하지 않는다. 그래서 참조 기능을 지운 프로젝트에서도 동작한다.

사용법

corepack pnpm create:feature <id> [--context <context id>] [--package @scope/name@x.y.z --digest sha256:<64 hex> --revision <hex>]
인자 규칙
<id> 케밥 표기, 40자 이하. 기존 기능·context ID와 겹치면 거부
--context 기존 context ID. 없으면 <base>-context를 새로 만든다
--package @scope/name@<정확한 버전>. --digest, --revision과 함께만
--digest sha256: + 소문자 hex 64자리
--revision 소스 리비전. 소문자 hex 7~64자리
  • <base>: ID에서 끝의 -feature를 뗀 것이다. invoice-feature면 invoice. 모든 전역 ID의 접두어가 된다.
  • 패키지 인자가 없으면 자리표시자 신원을 쓰고 표준 오류로 경고한다.
  • 패키지 인자가 있으면 계약 조립기와 같은 신원 검사(composeContractContributions)로 형식을 확인한다.

하는 일

인자 파싱 (틀리면 사용법 출력, 종료 코드 2)
  → 생성기로 선언을 읽고, 설치된 라우트·topic·문구 키를 읽는다
  → 계획: ID 검사, 충돌 검사, topic 생성, navigationOrder 계산
  → 쓰기: 쓸 경로와 기능 폴더가 하나라도 있으면 아무것도 쓰지 않고 거부
  → 생성기 실행: 거부하면 만든 파일을 모두 지운다
  → 출력: 만든 파일, 다음 할 일 (종료 코드 0)

실패하면 create:feature: <메시지>를 표준 오류에 쓰고 종료 코드 1로 끝난다. 메시지는 errors.md에 있다.

만드는 파일

기능 폴더 src/features/<id>/:

  • feature-module.ts: 선언 헤더(FEATURE_MODULE_ID, FEATURE_CONTEXT_ID)와 FEATURE_MODULE
  • feature-runtime.ts: 실행 쪽. feature-module.ts가 동적으로만 import한다
  • context-routes.ts: context가 적재하는 라우트
  • contracts/<base>-feature-contract.ts: 라우트, 무효화, 계약 패키지 신원
  • contracts/<base>-schemas.ts: zod 스키마와 zodValidator 검증기
  • contracts/<base>-mapper.ts: 와이어 값 → 화면 값
  • contracts/<base>-schema-metadata.ts: 스키마 메타데이터(FE-REG-SCHEMA 행)
  • contracts/<base>-contract-contribution.ts: HTTP descriptor와 계약 기여. FE-REG-API 행은 여기서 뽑는다
  • contracts/<base>-message-catalog.ts: ko-KR·en-US 문구
  • application/<base>-feature-api.ts: input, gateway port, ApplicationFeatureInputs 보강
  • adapters/<base>-http-gateway.ts: HTTP gateway
  • adapters/create-<base>-feature-input.ts: 조립 기여(needs: ["http", "telemetry"])
  • presentation/<base>-feature-runtime.ts: 지연 로드 페이지 표
  • presentation/<base>-routes.ts: route ID → URL 함수(buildRouteUrl)
  • presentation/use-<base>-items.ts: 쿼리 바인딩
  • presentation/<base>-list-page.tsx: CollectionPage 목록 페이지

domain/은 만들지 않는다. 업무 규칙이 생기면 사람이 만든다.

기능 테스트 폴더 tests/features/<id>/:

  • <base>-feature-input.test.ts: input과 mapper 단위 테스트
  • <base>-list-page.test.tsx: 라우터를 거치는 페이지 테스트(목록, 빈 목록, 실패 후 다시 시도)

기능 폴더 밖:

  • src/contexts/<base>-context/context-module.ts: 새 context일 때만
  • artifacts/tests/a11y-manual/<ROUTE_ID>.md: pending 기록

뼈대 모양

  • 라우트 1개: 파라미터·검색값 없는 목록, session-required, feature-boundary.
  • GET 1개: SAFE, EXTERNAL_BEARER, 응답은 항목 배열.
  • 쿼리 1개: LIST_STANDARD profile.
  • 무효화 topic 1개, namespace 1개, edge 1개.
  • 빈 배열 응답은 공유 빈 상태 화면으로 그린다. tests/e2e/accessibility.spec.ts가 모든 API에 []를 답하기 때문이다.

한도·마감 같은 숫자는 scripts/create-feature.ts의 템플릿이 정본이다.

생성된 문구는 자리 채움이다. ko-KR 설명 문구가 "제품 문구로 바꾸세요"라고 적혀 있다. 제품 문구로 바꾼다.

하지 않는 일

  • 레지스트리 기준선, governance, 중앙 카탈로그를 고치지 않는다. 고칠 필요가 없다.
  • README.md나 문서를 고치지 않는다.
  • tests/mocks/ 공유 파일을 고치지 않는다.
  • package.json, src/bootstrap/product-composition.ts, src/contracts/product-contracts.ts를 고치지 않는다.
  • a11y 기록에 서명하지 않는다.
  • 실제 계약 패키지를 설치하지 않는다.

출력

표준 출력:

create:feature: <id> in <context> (new context), route <ROUTE_ID> at <path>
  created <파일> ...

Next:
  1. Before a release, have a person review and sign artifacts/tests/a11y-manual/<ROUTE_ID>.md (FE-GATE-028). ...
  2. Run the merge gates: corepack pnpm check:types, lint, ...
     The feature's own tests: node scripts/run-vitest.ts run tests/features/<id> ...
  The registry baseline does not change: ...

패키지 인자가 없을 때 표준 오류:

create:feature warning: no --package was given, so src/features/<id>/contracts/<base>-feature-contract.ts pins the placeholder contract identity. ...

이 경고가 나오면 03 문서의 "자리표시자 계약 신원 교체"를 릴리스 전에 한다.

되돌리기

생성한 기능을 지우려면 만든 것을 지우고 생성기를 다시 돌린다.

rm -r src/features/<id> tests/features/<id> artifacts/tests/a11y-manual/<ROUTE_ID>.md
rm -r src/contexts/<base>-context   # 새 context를 만들었을 때만
corepack pnpm generate:feature-index

이 명령을 지키는 검사

  • tests/unit/create-feature.test.ts (test:unit, FE-GATE-005)
    • 렌더 결과만 본다. 저장소를 건드리지 않는다.
    • 접두어, 참조 기능 이름이 없음, topic 형식과 충돌, navigationOrder, 거부 조건, 덮어쓰기 거부와 되돌리기.
  • test:feature-scaffold (FE-GATE-020)
    • 저장소 복사본에 기능 하나를 만들고 커밋한 뒤 게이트를 돈다.
    • 타입, lint, 아키텍처, 레지스트리, i18n, 디자인 시스템, 진단, 문서, unit, component, integration, 기능 테스트, 커버리지, CI 계약, 빌드.
  • test:sample-removal (FE-GATE-020)
    • 참조 기능을 지운 복사본에서 이 명령으로 기능을 만들고 같은 게이트를 다시 돈다. 명령이 참조 기능에 기대지 않는다는 증거다.

알려진 한계

  • --context reference-context로 참조 context에 넣으면 tests/features/reference-feature/installed-context-routing.test.ts가 깨진다. 그 테스트는 참조 context의 라우트 수를 정확히 비교한다.
  • 드릴은 check:bundle(FE-GATE-012), 브라우저 테스트(test:a11y, test:e2e)를 돌리지 않는다.
  • 새 context는 앱이 하나일 때만 만든다. 앱이 여럿이면 --context로 기존 context를 고른다.