Files
clean-architecture-frontend…/docs/manual/reference/create-feature.md
T
DongHyeonka 8b2048763b docs(manual): 새 기능 추가 매뉴얼을 docs/manual에 쓴다 (U9, 1101/16-01)
문제
- 새 기능을 추가하는 절차가 starter-experience.md의 영어 단계 7개와
  폴더 밖 파일 표뿐이다. 무엇을 고르는지(context, 계약 출처, 재시도 의미,
  결과 불명, 인증, 페이지 템플릿), 어느 검사가 무엇을 못 잡는지, 실패
  메시지가 어느 파일을 가리키는지는 리뷰 문서(16 영역 8절)에만 있다.
  리뷰 문서는 복사한 프로젝트가 지울 수 있는 작업 이력이다.
- create:feature(U7)가 생겼지만 그 인자, 만드는 파일, 사람이 해야 하는 일
  (a11y 서명, 자리표시자 계약 신원 교체)을 설명하는 문서가 없다.

고른 방법
- docs/manual/을 한국어로 쓴다(결정 5). README(독자, 읽는 순서, 두는 것과
  안 두는 것), 01 작업 순서 0~11단계, 02 결정표 6개, 03 기능 폴더 밖 파일,
  reference/ 4개(create-feature, global-ids, patterns, errors).
- 01은 1단계에서 create:feature로 시작하는 길을 기본으로 두고, 단계마다
  정할 것, 기준, 잡는 검사(명령·게이트 ID·메시지)와 못 잡는 것, 쓸 스킬을
  적는다. 리뷰 시점의 "못 잡음"은 지금 코드로 다시 확인해 고쳤다(예: 루트
  밖 라우트는 이제 앱 모듈이 적재 때 거부한다).
- 실패 메시지는 src·scripts의 문자열을 그대로 옮기고 값 자리만 <...>로
  바꿨다.
- 목록 대신 정본 위치를 적는다(공통 원칙 8). route ID는 ROUTE_REGISTRY,
  게이트는 config/ci/gates.json, 백엔드 멱등성 응답은 백엔드 템플릿
  docs/web/http-contract.md §2를 가리키고 표를 옮기지 않는다. 공통 원칙은
  design-docs의 conventions/feature-design-principles.md를 번호로만
  가리킨다.
- 03은 starter-experience.md의 폴더 밖 표를 정본으로 링크하고 복사하지
  않는다. 생성 명령이 하는 것 / 사람이 꼭 하는 것 / 조건부 / 고치지 않는
  것으로 나누고, 표에 없는 절차(a11y 서명, 자리표시자 교체, 기능 삭제)만
  더한다.
- 16 영역 8.4의 금지 목록(목표 디렉터리 구조 절, 예전 폴더 밖 표, 참조
  페이지의 경로 문자열)은 링크하지 않고 README에 그 이유를 적는다.
- 버린 대안: 리뷰 8절을 그대로 옮기기(리뷰 시점 사실이 지금 코드와 다르고
  지울 수 있는 이력에 기댄다), starter-experience.md에 한국어 절을 더하기
  (입구 문서는 영어이고 다른 에이전트 소유다), 실패 메시지를 요약해 쓰기
  (메시지로 문서를 검색할 수 없다).

위험·한계
- docs/README.md §1 링크는 넣지 않았다(오케스트레이터 몫). 링크하기 전에는
  verify:documentation이 이 폴더를 검사하지 않는다. 폴더 링크는 바로 아래
  .md만 검사하므로 reference/도 따로 링크해야 한다.
- 플랫폼 규칙 근거는 다른 에이전트가 옮기는 scale-architecture.md를 절
  번호로 가리킨다. 이 커밋에는 그 파일이 없어 링크 대신 백틱 이름으로 썼다.
- 매뉴얼로 막을 수 없는 것이 남는다. 기능 전용 e2e spec은 tests/e2e에만
  둘 수 있어 기능 폴더 밖이다. --context reference-context는 참조 기능
  테스트 하나를 깨뜨린다. 생성 드릴은 check:bundle을 돌리지 않는다.
- "실험 E를 매뉴얼만 보고 다시 하기"는 문서로만 점검했고 실제로 다시
  돌리지 않았다.

검증
- docs/README.md §1에 manual/, manual/reference/ 링크를 임시로 넣고
  node scripts/verify-documentation-readiness.ts: PASS_SCOPED. 7개 문서
  모두 missingPaths·missingScripts·unknownGateIds 0. 임시 링크는 되돌렸다.
- 변이: patterns.md에 없는 경로·script·게이트 ID를 넣으면 세 항목을 모두
  말하며 FAIL_UNVERIFIED.
- 메시지 대조 스크립트: 백틱 안 148개 문구 중 106개는 코드에 그대로 있고,
  42개는 코드가 조각을 이어 만드는 문구(접두어·필드 이름·값 채움)라 하나씩
  코드에서 확인했다.
- node scripts/run-vitest.ts run tests/unit/documentation-readiness.test.ts
  tests/unit/deletable-history-documents.test.ts
  tests/unit/repository-file-inventory.test.ts: 3파일 38건 통과.
2026-11-03 07:27:36 +09:00

7.0 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: 와이어 값 → 화면 값, 레지스트리 mapper
  • contracts/<base>-api-contract.ts: V2 행
  • contracts/<base>-contract-contribution.ts: V3 descriptor와 계약 기여
  • 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를 고른다.