문제 README는 참조 기능을 지울 수 있다고 적는다. 그러나 매뉴얼·입구 문서 10개가 참조 기능과 그 드릴 전용 파일의 경로를 백틱으로 적고, verify:documentation(FE-GATE-017)은 백틱 경로의 존재를 검사한다. 그래서 참조 기능을 지운 복사본에서 문서 게이트가 경로 24개로 실패한다. 제거 드릴(test:sample-removal)은 문서를 복사하지 않고 그 게이트와 lint· check:i18n·check:design-system을 돌리지 않아 이 충돌을 보지 못했다. 고른 방법 - 리뷰 5.2절 (b): 참조 기능이 가진 경로는 백틱 없이 "예제(참조 기능)"으로 적는다. 기능 공통 모양은 생성 경로 꼴(`src/features/<id>/domain`)로 적는다. 규칙은 docs/manual/reference/patterns.md 첫머리에 적었다. - 드릴은 REMOVAL_FIXTURE_DOCUMENT_TARGETS(README·CHANGELOG·docs)까지 복사하고, 지운 뒤와 생성 기능을 더한 뒤 두 번 모두 lint, verify:documentation, check:i18n, check:design-system을 돈다 (FOLLOW-UP 09-07). 문서 테스트 두 개도 fixture에서 다시 돈다. - 버린 대안: 검사기가 참조 기능 경로를 "없어도 되는 경로"로 보기(5.2 (c)). 매뉴얼이 없는 파일을 가리키는 상태를 허용한다. 참조 기능을 지울 수 없게 하기(5.2 (d)). README 약속과 드릴의 존재 이유가 바뀐다. 위험·한계 - 템플릿 자신에서도 참조 기능 경로의 존재를 문서 검사가 더는 보지 않는다. 참조 기능 파일 이름을 바꾸면 그 문장은 사람이 고쳐야 한다. - 드릴 시간이 lint·문서 검사 두 번만큼 는다. - 드릴 실제 실행 결과는 이 커밋 메시지에 적지 않았다(공유 잠금 대기). 검증 - 참조 기능·참조 context·SAMPLE_EXTRAS를 지운 복사본(scratchpad sim-sample-docs.sh)에서 수정 전 FAIL_UNVERIFIED(문서 10개), 수정 뒤 PASS_SCOPED. - 저장소에서 verify:documentation PASS_SCOPED, documentation-readiness 14건 통과, eslint 통과. Refs: docs/reviews/2026-11-03-maturity-review/14-template-product-docs.md 14-04
140 lines
7.1 KiB
Markdown
140 lines
7.1 KiB
Markdown
# create:feature 참조
|
|
|
|
모든 merge 게이트를 통과하는 가장 작은 기능을 만드는 명령이다. 정본은 `scripts/create-feature.ts`다.
|
|
템플릿 문자열이 그 파일 안에 있고, 참조 기능을 import하지 않는다. 그래서 참조 기능을 지운 프로젝트에서도 동작한다.
|
|
|
|
## 사용법
|
|
|
|
```bash
|
|
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`)로 형식을 확인한다.
|
|
|
|
## 하는 일
|
|
|
|
```text
|
|
인자 파싱 (틀리면 사용법 출력, 종료 코드 2)
|
|
→ 생성기로 선언을 읽고, 설치된 라우트·topic·문구 키를 읽는다
|
|
→ 계획: ID 검사, 충돌 검사, topic 생성, navigationOrder 계산
|
|
→ 쓰기: 쓸 경로와 기능 폴더가 하나라도 있으면 아무것도 쓰지 않고 거부
|
|
→ 생성기 실행: 거부하면 만든 파일을 모두 지운다
|
|
→ 출력: 만든 파일, 다음 할 일 (종료 코드 0)
|
|
```
|
|
|
|
실패하면 `create:feature: <메시지>`를 표준 오류에 쓰고 종료 코드 1로 끝난다. 메시지는 [errors.md](errors.md#생성-명령-createfeature)에 있다.
|
|
|
|
## 만드는 파일
|
|
|
|
기능 폴더 `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 기록에 서명하지 않는다.
|
|
- 실제 계약 패키지를 설치하지 않는다.
|
|
|
|
## 출력
|
|
|
|
표준 출력:
|
|
|
|
```text
|
|
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: ...
|
|
```
|
|
|
|
패키지 인자가 없을 때 표준 오류:
|
|
|
|
```text
|
|
create:feature warning: no --package was given, so src/features/<id>/contracts/<base>-feature-contract.ts pins the placeholder contract identity. ...
|
|
```
|
|
|
|
이 경고가 나오면 [03 문서의 "자리표시자 계약 신원 교체"](../03-outside-feature-folder.md#자리표시자-계약-신원-교체)를 릴리스 전에 한다.
|
|
|
|
## 되돌리기
|
|
|
|
생성한 기능을 지우려면 만든 것을 지우고 생성기를 다시 돌린다.
|
|
|
|
```bash
|
|
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를 고른다.
|