매뉴얼 예제 칸 14곳(S4 3.3절)과 산문 30여 곳이 참조 기능을 가리킨다. problem details(Envelope가 아닌 백엔드) 응답 매핑의 예는 참조 기능에만 있다. 생성기 출력이 그 모양을 만들면 그 경로로 바꿨다. 없으면 매뉴얼 안 코드 조각으로 썼다: problem details의 분류와 매핑(02 결정표 4절, 소유자 결정 D1), 도메인 모델, 검색값 스키마와 hook, 실패 행동 hook, 403 페이지 시험. 조각마다 manual-code-block 표식에 둘 경로를 적는다. tests/unit/manual-code-blocks.test.ts가 저장소 사본에 create:feature invoice-feature --with-create를 만들고 조각을 그 경로에 그대로 넣어 tsc(app, test), eslint, check:architecture, 그 기능 폴더의 vitest를 돈다. 조각의 동작은 tests/fixtures/manual-code-blocks/가 본다. 위험: 403 조각은 본문 없는 403으로 답한다. 공유 시나리오 forbidden-403(JSON 본문)은 jsdom + MSW에서 실행기의 본문 cancel이 끝나지 않아 화면이 로딩에 머물렀다. 실행기는 고치지 않았다. 사본에 이미 invoice-feature가 있는 프로젝트에서는 이 시험이 생성 단계에서 실패한다. 검증(desktop): test:unit 213 files 3096 passed(이 커밋까지), verify:documentation PASS_SCOPED, lint 통과.
12 KiB
create:feature 참조
모든 merge 게이트를 통과하는 가장 작은 기능을 만드는 명령이다. 정본은 scripts/create-feature.ts이고, --with-create가 더하는 부분은 scripts/create-feature-write-slice.ts다.
test:feature-scaffold가 생성한 기능으로 config/ci/gates.json의 merge 단계 명령을 돌려 확인한다. 브라우저 게이트(FE-GATE-008·009의 브라우저 명령)와 test:system은 빼고 돈다. 뺀 명령과 이유는 scripts/lib/feature-scaffold-drill.ts에 있다.
템플릿 문자열이 두 파일 안에 있고, 다른 기능을 import하지 않는다. 그래서 기능이 하나도 없는 템플릿에서도 동작한다.
사용법
corepack pnpm create:feature <id> [--context <context id>] [--with-create [--keyed]] [--package @scope/name@x.y.z --digest sha256:<64 hex> --revision <hex>]
| 인자 | 규칙 |
|---|---|
<id> |
케밥 표기, 40자 이하. 기존 기능·context ID와 겹치면 거부 |
--context |
기존 context ID. 없으면 <base>-context를 새로 만든다 |
--with-create |
짝 백엔드 new-feature.sh의 작성(POST /<plural>)·상세(GET /<plural>/{id})와 그 페이지를 더한다. 작성은 NEVER |
--keyed |
--with-create와 함께만. 작성을 KEYED로 만든다. 백엔드 create를 멱등성 executor 뒤에 둔 뒤에 쓴다 |
--package |
@scope/name@<정확한 버전>. --digest, --revision과 함께만 |
--digest |
sha256: + 소문자 hex 64자리 |
--revision |
소스 리비전. 소문자 hex 7~64자리 |
<base>: ID에서 끝의-feature를 뗀 것이다.invoice-feature면invoice. 모든 전역 ID의 접두어가 된다.- API 경로: 짝 백엔드
new-feature.sh와 같은 규칙이다.<base>의 camel 표기 뒤에 s, x, ch, sh로 끝나면es, 자음+y로 끝나면 y를ies로, 그 밖에는s를 붙인다.invoice→/invoices,purchase-order→/purchaseOrders,company→/companies. 백엔드의api-base-path는API_BASE_URL에 붙인다. - 패키지 인자가 없으면 자리표시자 신원을 쓰고 표준 오류로 경고한다.
- 패키지 인자가 있으면 계약 조립기와 같은 신원 검사(
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_MODULEfeature-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 gatewayadapters/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목록 페이지. 결과 수는meta.page.total
--with-create가 더하는 파일:
presentation/<base>-route-codecs.ts: 상세 라우트 params codecpresentation/use-<base>-item.ts: 상세 쿼리presentation/use-<base>-create.ts: 작성 뮤테이션 정책(commandMutationIdentity)presentation/<base>-form.ts: 폼 스키마. 이름 길이는 요청 스키마의 상수(<BASE>_NAME_MAX_LENGTH= 백엔드NAME_MAX_LENGTH100)를 쓴다presentation/<base>-detail-page.tsx:DetailPagepresentation/<base>-create-page.tsx:FormPage. 저장하면 상세를 연다. 저장 중에 화면을 떠났으면 옮기지 않는다. 결과 불명이면AsyncSurface를 보인다
domain/은 만들지 않는다. 업무 규칙이 생기면 사람이 만든다.
기능 테스트 폴더 tests/features/<id>/:
<base>-test-app.tsx: 앱 전체를 조립해 로그인하고 URL로 들어가는 도우미. 페이지 테스트가 같이 쓴다<base>-feature-input.test.ts: input 단위 테스트<base>-list-page.test.tsx: 라우터를 거치는 페이지 테스트(목록,meta.page.total, 빈 목록, 실패 후 다시 시도)<base>-http-gateway.test.ts: 짝 백엔드 본문을 손으로 적은 gateway 테스트. 하네스의 재시도 상한은 앱 기본값 2다<base>-create-page.test.tsx(--with-create): 201 저장 뒤 상세, 400<FEATURE>_INVALID필드 오류와 다시 저장, 응답을 잃은 저장(NEVER는 다시 보내기 없음,KEYED는 같은 키로 다시 보내기), 저장 중 목록으로 간 뒤 끝난 저장(목록에 머문다)
기능 폴더 밖:
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, 응답은 Envelope 안의 항목 배열. 목록 값은{ items, total }이다. --with-create: 라우트<BASE>_DETAIL(<목록>/items/:<base>Id)·<BASE>_CREATE(<목록>/new), operation<BASE>_GET_ITEM·<BASE>_CREATE_ITEM.- 작성
NEVER:retryBudget: 0, 멱등 키 없음. 응답을 잃으면 결과 불명이고 다시 보내기 버튼이 없다. - 작성
KEYED(--keyed):commandRecoveryIDEMPOTENCY_REPLAY,retryBudget: 1(503IDEMPOTENCY_UNAVAILABLE뒤 같은 키로 한 번). - 둘 다
acceptedStatuses: [201],refusedBeforeWrite: ["<BASE>_INVALID"],classifyStatus는 401·403·429를NOT_APPLIED로 본다. 값과 이유는 02 결정표 3절.
- 작성
- 모든 operation이
responseEnvelope: "ENVELOPE_V1"이다. - 쿼리 1개:
LIST_STANDARDprofile. - 무효화 topic 1개, namespace 1개, edge 1개.
- 빈 배열 응답은 공유 빈 상태 화면으로 그린다.
tests/e2e/accessibility.spec.ts는 이 목록 조회에 빈 목록을 Envelope 모양으로 답하고, 경고 상자가 없는지 본 뒤 axe를 돌린다. 그래서 생성한 목록 라우트는 빈 상태 화면으로 검사된다. --with-create의 상세 라우트는 자원 하나를 읽는다. 빈 목록으로 답할 수 없어 실패 화면에서만 axe를 돌린다. 그래서artifacts/tests/a11y.json은 이 라우트를 통과(scope)로 세지 않고notChecked에 이유와 함께 적는다. 화면 내용의 접근성은 수동 검토 기록(artifacts/tests/a11y-manual/<ROUTE_ID>.md)이 맡는다.
한도·마감 같은 숫자는 scripts/create-feature.ts의 템플릿이 정본이다.
생성된 문구는 자리 채움이다. ko-KR 설명 문구가 "제품 문구로 바꾸세요"라고 적혀 있다. 제품 문구로 바꾼다.
하지 않는 일
- 레지스트리 기준선, governance, 중앙 카탈로그를 고치지 않는다. 고칠 필요가 없다.
README.md나 문서를 고치지 않는다.tests/mocks/공유 파일을 고치지 않는다.package.json,src/features/product-capabilities.ts,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 ci:gate -- FE-GATE-<NNN> for each gate of the merge stage ...
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
node scripts/write-dev-release-manifest.ts # dev manifest에서 그 기능의 계약 패키지를 뺀다
생성 명령은 public/release-manifest.json(dev server가 내주는 manifest)의 contractSet에 기능의 계약 패키지를 더한다. 기능과 함께 커밋한다. 낡으면 tests/unit/dev-release-manifest.test.ts가 다시 쓰는 명령을 말하며 실패하고, corepack pnpm dev는 CONTRACT_SET_PACKAGE_MISSING·CONTRACT_SET_PACKAGE_UNEXPECTED로 부팅하지 못한다.
이 명령을 지키는 검사
tests/unit/create-feature.test.ts(test:unit, FE-GATE-005)- 렌더 결과만 본다. 저장소를 건드리지 않는다.
- 접두어, 예전 참조 샘플 이름이 없음, topic 형식과 충돌,
navigationOrder, 거부 조건, 덮어쓰기 거부와 되돌리기. - 백엔드 경로 규칙,
--with-create·--keyed의 descriptor 값, 모든 operation의 Envelope 선언. - 생성한 context 선언을 임시 폴더에 써서 생성기의 선언 읽기(
createFileSystemDeclarationSource)로 읽고, 그 모듈을 import해 라우트 루트가 기능 라우트를 모두 받는지 앱 모듈 조립으로 확인한다.
test:feature-scaffold(FE-GATE-020)- 저장소 복사본에 기능 둘(기본 하나,
--with-create --keyed하나)을 만들고 커밋한 뒤 게이트를 돈다. - 타입, lint, 아키텍처, 레지스트리, i18n, 디자인 시스템, 진단, 문서, unit, component, integration, 기능 테스트, 커버리지, CI 계약, 빌드.
- 저장소 복사본에 기능 둘(기본 하나,
test:sample-removal(FE-GATE-020)- 참조 기능을 지운 복사본에서 이 명령(
--with-create)으로 기능을 만들고 같은 게이트를 다시 돈다. 명령과 쓰기 slice가 참조 기능에 기대지 않는다는 증거다.
- 참조 기능을 지운 복사본에서 이 명령(
알려진 한계
- 드릴은 브라우저 테스트(FE-GATE-008·009의
test:e2e,test:a11y등)와test:system을 돌리지 않는다.check:bundle(FE-GATE-012)은 돈다. - 새 context는 앱이 하나일 때만 만든다. 앱이 여럿이면
--context로 기존 context를 고른다.