2026-11-07~08의 정리(문서 이동, 참조 기능 삭제, CI 재편) 뒤 살아 있는 문서가 지금 코드와 다른 말을 한다. - 현재 계약 문서 둘과 스타터 문서가 기록(docs/design/)을 정본으로 가리킨다. 정본을 frontend-application-foundation.md·src/bootstrap/, 패턴 표·계층 규칙으로 바꾸고 설계서는 배경으로 둔다(1112/02-06). - 실시간 대응표 둘(짝 백엔드 출구, poll attempt 결과)이 기록에만 있었다. optional-adapter-recipes.md로 옮기고 코드 주석·매뉴얼 03·설계서 머리 블록이 옮긴 곳을 가리킨다(1112/09-02). - 실행 격리 변수 목록을 설계 기록이 아니라 scripts/lib/run-isolation.ts로 가리킨다(1112/08-17). - 계약 소유 절 이름(「판단 규칙」), pin 대조 시험의 게이트(005·007), drift 검사 범위(1112/02-07). INVENTORY 머리의 손 숫자와 지킬 수 없는 꼬리 문장(1112/02-08). - 검증 안내: 검사기를 바꾸면 FE-GATE-029, 문서면 desktop verify:documentation(1112/08-05, 08-04). FE-GATE-012는 merge 단계다 (08-16). N6이 알리는 파일을 좁혀 적는다(08-10). 한 파일 시험은 verify.sh exec(08-11). 문서 검사 범위의 손 사본을 정본 한 곳으로(08-07). - create:feature 참조의 Next: 3과 되돌리기(08-08), 손으로 옮긴 숫자 (08-19), 라운드 없는 리뷰 ID 17곳에 0925를 붙인다(08-15). - secret scan 범위 설명(1112/07-03), lab이 기능 라우트를 읽는 문장 (1103/16-06), README 동기화 기준점·제품 소유 파일·선택 기능 결함 몫 (0929/14-02, 14-03, 13-10), 커밋을 다시 지은 모든 통합의 해시 대조 (1106/14-02). 고른 방법: 문장을 코드에 맞춘다. 표는 옮기고 숫자는 정본을 가리킨다. 버린 대안: 기록 문서 본문 고치기(기록은 머리 블록만 고친다). 위험·한계: 문서 검사 범위 목록을 지운 ci-quality-gates.md는 이제 docs/README.md 5절과 gates.md 7절을 읽어야 한다. 매뉴얼 02 7절 업로드 예의 declare module 문제(1112/09-01)는 고치는 방향이 check:architecture 규칙과 부딪쳐 결정 대기로 남긴다. 검증: scripts/verify.sh docs(노트북) 통과. desktop verify:documentation과 FE-GATE-005(문서를 읽는 시험)는 PR 본문에 적는다. Refs: 1112/02-06, 1112/02-07, 1112/02-08, 1112/07-03, 1112/08-04, 1112/08-05, 1112/08-07, 1112/08-08, 1112/08-10, 1112/08-11, 1112/08-15, 1112/08-16, 1112/08-17, 1112/08-19, 1112/09-02, 1103/16-06, 0929/14-02, 0929/14-03, 0929/13-10, 1106/14-02
121 lines
14 KiB
Markdown
121 lines
14 KiB
Markdown
# 구조 기준 — 폴더·모듈·코드
|
|
|
|
폴더 구조와 import의 규칙은 이미 코드와 게이트에 있다. 이 문서는 **구조를 바꿀 때 어느 정본을 같이 고쳐야 하는지**, **리뷰에서 구조 결함으로 볼 것과 보지 않을 것**, 그리고 **게이트가 지키지 못해 반복된 코드 결함을 막는 기준**을 적는다. 괄호 안 `결함 패턴 X0`은 [defect-patterns.md](defect-patterns.md)의 행이다.
|
|
|
|
```text
|
|
src/ 최상위 폴더 ── 역할: docs/architecture/layers.md 표
|
|
│ 규칙: .dependency-cruiser.json (check:architecture, FE-GATE-010)
|
|
├─ adapters/<그룹>/index.ts ── 공개 경계(배럴)
|
|
│ └─ platform/** 등 kernel 3곳만 그룹을 넘어 import 가능
|
|
├─ features/<id>/ ── 지울 수 있는 기능 하나 (제거 드릴, FE-GATE-020)
|
|
└─ contexts/, apps/ ── 기능 묶음과 배포 단위
|
|
```
|
|
|
|
## 1. 정본
|
|
|
|
| 무엇 | 정본 | 검사 |
|
|
| --- | --- | --- |
|
|
| 최상위 `src/` 폴더와 각 역할 | `docs/architecture/layers.md` 표 | `verify:documentation`이 폴더 목록·설명 일치를 본다 |
|
|
| import 규칙 | `.dependency-cruiser.json` `forbidden`, 설명은 `docs/architecture/layers.md` | `check:architecture` |
|
|
| adapter kernel | `docs/architecture/layers.md`, 규칙 `adapters-do-not-know-other-concrete-adapters` | `check:architecture` |
|
|
| 규칙 예외의 이유·담당·재검토 조건 | 그 규칙의 `comment` | 사람이 본다 |
|
|
| adapter 그룹의 공개 경계 | 규칙 `adapter-groups-are-reached-through-their-barrel` | `check:architecture`, 고정 fixture `tests/fixtures/architecture/dependency-graph/barrel` |
|
|
| adapter 파일 목록 | `docs/reviews/adapters/INVENTORY.md` | `check:adapter-inventory`(FE-GATE-010) |
|
|
| 공유 타입·프리미티브를 어디에 둘지 | `docs/architecture/contract-ownership.md` 「판단 규칙」 | 사람이 본다 |
|
|
| 기능 폴더의 모양 | `docs/manual/01-add-a-feature.md`, `create:feature`가 만드는 파일 | FE-GATE-020의 `test:feature-scaffold` |
|
|
| 재시도 의미, 결과 불명, 인증, 업로드의 판단 기준 | `docs/manual/02-decision-tables.md` | 사람이 본다 |
|
|
| 오류·재시도·실패 경계·trace 모델 | `docs/architecture/scale-architecture.md`(코드 주석의 `scale-architecture.md §N`) | 사람이 본다 |
|
|
| 짝 백엔드 쓰기 응답의 판정 표 | `src/adapters/http/backend-envelope.ts`의 `REFUSED_BEFORE_WRITE`, 근거 `docs/architecture/backend-api-and-server-state-contract.md` 6.1절 | 짝 계약 대조 테스트 |
|
|
|
|
## 2. 이 repo의 고정 전제
|
|
|
|
1. **확장 지점은 남긴다.** 소비자 없는 코드와 빈 레지스트리는 다운스트림용이다. 죽은 코드로 보고 지우지 않는다(소유자 결정 2026-09-16).
|
|
2. **갈라진 중복 복사본은 하나로.** 같은 일을 하는 코드가 두 벌이고 서로 달라지기 시작했으면 결함이다(결함 패턴 S3). 합칠 곳은 kernel(`src/adapters/platform/`)이나 `src/contracts/`다.
|
|
3. **배럴이 공개 경계다.** 그룹 바깥(`src/bootstrap`, `src/features`, `src/presentation`)은 그룹의 `index.ts`만 import한다. 배럴 폐지안은 2026-09-16에 기각됐다. 2단계 `index.ts`는 공개 배럴이 아니다(예외: `storage/indexeddb`, `storage/opfs` 서브배럴).
|
|
4. **kernel 예외는 셋뿐이다.** `src/adapters/platform/` 폴더 전체, `src/adapters/browser-file-storage/result.ts`, `src/adapters/cross-context-invalidation/index.ts`. 새 파일 단위 예외를 제안하지 않는다. 새 공유 프리미티브는 `src/adapters/platform/`에 넣는다. 폴더 전체가 예외라 규칙을 바꿀 필요가 없다.
|
|
5. **실행 형태는 브라우저 SPA + 정적 호스팅 + Service Worker다.** 서버 메모리 상태·다중 인스턴스 경쟁 기준은 적용하지 않는다. 탭 사이 경쟁은 적용한다.
|
|
|
|
## 3. 바꿀 때 같이 고칠 것
|
|
|
|
| 바꾸는 것 | 같은 커밋에서 고칠 것 |
|
|
| --- | --- |
|
|
| 최상위 `src/` 폴더 추가·삭제 | `docs/architecture/layers.md` 표 한 행. 같은 설명 문장을 루트 `README.md`, `docs/architecture/overview.md`, `docs/architecture/frontend-application-foundation.md`에 그대로(`verify:documentation`이 대조한다) |
|
|
| import 규칙 추가·이름 변경 | `.dependency-cruiser.json`, `docs/architecture/layers.md` 규칙 표의 행 |
|
|
| 규칙 예외 | 그 규칙의 `pathNot`과 `comment`(이유·담당·재검토 조건). 파일 단위 kernel 예외는 만들지 않는다 |
|
|
| adapter 파일 추가·이동·삭제 | `docs/reviews/adapters/INVENTORY.md` |
|
|
| adapter 그룹 공개 표면 | 그 그룹의 `index.ts` |
|
|
| 기능·context 경계 | `src/features/<id>/`와 `tests/features/<id>/`. 기능끼리, context끼리 import하지 않는다 |
|
|
| 지울 수 있는 단위(기능, recipe, 선택 runtime) | 그 단위의 제거 드릴이 함께 지울 목록(`scripts/test-sample-removal.ts` 머리말) |
|
|
|
|
## 4. 문서 위치와 지워도 되는 문서
|
|
|
|
- 지금 코드가 지키는 규칙은 제자리의 살아 있는 문서(`docs/README.md` 1절 지도), 설계서는 `docs/design/`, 결정 기록은 `docs/adr/`, 계획·증거는 `docs/history/`, 리뷰는 `docs/reviews/`(앞 둘은 복사한 프로젝트가 지울 수 있다), 새 기능 절차는 `docs/manual/`, 작업 절차는 `docs/work/`, 여러 repo에 걸친 설계는 repo 밖 design-docs다.
|
|
- 코드·테스트·스크립트·설정은 지워도 되는 문서(루트 `README.md`의 지워도 되는 파일 표)를 읽지 않는다. 예외는 `docs/reviews/adapters/INVENTORY.md` 하나다. `tests/unit/deletable-history-documents.test.ts`가 검사한다. 테스트가 리뷰 문서를 열어 제거 드릴 셋을 깨뜨린 일이 있다.
|
|
- 루트 `AGENTS.md`·`CLAUDE.md`, `.claude/`, `docs/work/`는 지워도 되는 문서가 아니다. 복사한 프로젝트가 받는 템플릿 계약이다(소유자 결정 2026-11-07).
|
|
- 현재 계약 문서는 작업 이력 문서에 기대지 않는다.
|
|
|
|
## 5. 리뷰에서 구조 결함으로 보는 것
|
|
|
|
| 결함으로 본다 | 결함으로 보지 않는다 |
|
|
| --- | --- |
|
|
| 갈라진 중복 복사본(결함 패턴 S3) | 소비자 없는 확장 지점, 빈 레지스트리 |
|
|
| 같은 사실을 여러 곳에 손으로 다시 적는다(결함 패턴 S1) | 인터페이스가 많다는 사실만으로 |
|
|
| 문서가 없는 폴더·규칙을 말한다 | kernel 폴더가 크다는 사실만으로 |
|
|
| 템플릿 파일을 고쳐야 기능을 더하거나 지울 수 있다(결함 패턴 S4) | 다운스트림이 쓰지 않는 선택 runtime |
|
|
| 지울 수 있다고 한 단위를 지우면 게이트가 실패한다 | |
|
|
|
|
## 6. 코드 기준 — 판정 규칙은 한 곳에
|
|
|
|
- **실패 분류는 status 하나로 하지 않는다.** status와 code를 함께 본다. 표 밖의 값은 안전한 쪽(결과 불명)으로 둔다. 업무 거절이 결과 불명으로, 일시 오류가 무결성 실패로 분류되는 결함이 여러 영역에서 났다(결함 패턴 C1).
|
|
- **짝 백엔드 쓰기 응답의 판정 표는 `REFUSED_BEFORE_WRITE` 하나다.** 실행 경로가 둘이어도 같은 표를 읽는다. operation 단위 예외는 descriptor의 `commandEffect.refusedBeforeWrite` code 목록으로만 선언한다.
|
|
- **결과 불명 쓰기를 다시 보내는 모든 입구를 함께 본다.** 재전송 버튼, hook 재제출, 실행기 재시도, poll 재시도, 업로드 재시도. 하나를 막으면 다른 입구에서 다시 나왔다. 키 없는 쓰기(`NEVER`)는 결과 불명 뒤 재전송하지 않는다. 키 있는 쓰기는 같은 키로만 다시 보낸다(결함 패턴 C2).
|
|
- **판정 규칙의 경계를 테스트로 고정한다.** 경계 하나를 바꾸는 변이가 게이트에서 실패해야 한다([testing.md](testing.md) 3절).
|
|
|
|
## 7. 코드 기준 — 실패는 드러나게
|
|
|
|
- **원인과 추적값을 싣는다.** 실패 객체·진단에 effect, reason, `traceId`, 어느 참여자인지를 싣는다. 서로 다른 실패를 같은 reason으로 남기지 않는다. 진단 reason은 이 repo가 소유한 닫힌 목록이고 서버 code를 그대로 넣지 않는다. 서버 code는 실패의 `AppFailure.code`에 남는다. 새 adapter도 같은 기준으로 리뷰한다(결함 패턴 C6).
|
|
- **오지 않을 신호를 기다리지 않는다.** 모든 대기에는 끝나는 조건(예산 소진, 마감, 취소)이 있다 **[제안]**(결함 패턴 C3).
|
|
- **손상 한 건이 전체를 멈추지 않게 한다.** 손상 행은 건너뛰고 수를 보고한다(결함 패턴 C4).
|
|
- **결과를 사실대로 보고한다.** 다 하지 못했으면 `COMPLETED`·`verified`·`active`를 보고하지 않는다. 읽은 시점과 보고 시점 사이에 다른 작업(다른 탭의 put, release)이 끼어들 수 있으면, 같은 잠금 아래에서 다시 대조하거나 끝난 뒤 한 번 더 센다. 테스트는 객체 셋 이상으로 한다(결함 패턴 C5).
|
|
- **실패·복구 전이 뒤 화면이 다음 행동을 남긴다.** 실패 표시에서 고친 포커스·안내를 복구 성공, 확인, 진행 중 전이에도 쓴다. 페이지마다 복사하지 않고 공용 폼 hook 안에서 한다(결함 패턴 C11).
|
|
- **확인하지 못한 판정은 `PASS`가 아니라 `UNVERIFIED`다.** 코드에 상수 `true` 판정을 두지 않는다.
|
|
|
|
## 8. 코드 기준 — 같은 사실은 한 곳에
|
|
|
|
- **repo 안:** 스키마 메타, 레지스트리 행, 허용 키 목록, 빌드 입력 목록, 저장 키를 원본(zod 스키마, descriptor, registry)에서 뽑는다. 손으로 다시 적어야 하면 원본과 대조하는 테스트를 같이 둔다. 두 검사기가 같은 산출물을 다른 키 목록으로 읽어 merge 게이트가 항상 실패한 일이 있다(결함 패턴 S1).
|
|
- **이미 갈라진 복사본은 하나로 합친다.** 갈라진 recipe port는 지우고 `src` port를 다시 내보낸다.
|
|
- **두 템플릿 사이:** 짝 백엔드의 프로토콜·오류 code·응답 모양·생성기 규칙을 옮길 때는 백엔드 문서만 보지 않고 **코드까지 따라간다**(백엔드 생성기, 프론트 폼까지). 판정 표를 백엔드 계약 문서만으로 정해 High를 만든 일이 있다. 옮긴 사실은 기준 커밋(`config/contracts/backend-contract-pin.json`)과 대조 테스트로 묶는다. drift 검사(`check:backend-contract-drift`)는 계약 문서 글자, 답 표 JSON(pin 사본과), 생성기 원본 파일이 pin 뒤에 바뀌었는지를 본다. 옮긴 사실의 내용 자체는 대조하지 않는다(결함 패턴 S2).
|
|
- 짝 백엔드 repo는 읽기만 한다. 백엔드가 바꿔야 할 것은 "백엔드에 넘길 것"으로 적는다.
|
|
|
|
## 9. 코드 기준 — 지우거나 바꿀 때
|
|
|
|
- **그 코드가 지키던 것을 찾는다.** 실행 동작만 옮기면 지운 행·테스트·분기가 지키던 규칙이 조용히 사라진다. 지우기 전에 그 코드를 읽는 테스트와 검사를 `git grep`으로 찾고, 각각이 지키던 규칙이 새 경로에도 있는지 적는다(결함 패턴 T10).
|
|
- **이름을 바꿀 때는** 새 이름을 내고 옛 이름은 한 릴리스 동안 `@deprecated` 별칭으로 남긴다. 이름 하나가 여러 뜻을 가지거나 한 뜻이 여러 이름을 가지면 결함이다(결함 패턴 C10).
|
|
- **공개 포트는 추가만 한다.** 깨야 하면 결정 표에 적고 BREAKING으로 커밋한다.
|
|
|
|
## 10. 코드 기준 — 설정·환경, 동시성, 확장 지점
|
|
|
|
- **같은 설정을 경로마다 다르게 읽지 않는다.** 번들, 빌드 스크립트, Service Worker 빌드가 같은 출처에서 읽는다(결함 패턴 C8).
|
|
- **URL은 router base path를 따른다.** `/`부터 직접 조립하지 않는다. 기본 게이트가 루트 경로만 돌아 드러나지 않는다. 하위 경로 빌드 테스트로 확인한다(결함 패턴 C7).
|
|
- **테스트가 띄우는 빌드·서버의 env는 테스트가 정한다**([gates.md](gates.md) 4절).
|
|
- **환경 가정은 적고, 확인하고, 없으면 이유를 말하며 실패한다.** 글꼴, user namespace, 옆 checkout(결함 패턴 G6).
|
|
- **여러 탭이 같은 저장소·구독·잠금을 건드리는 경로**는 Web Locks로 직렬화하거나 잠금 없이도 안전한 이유를 적는다. 잠금을 기다리는 작업에는 abort와 상한이 있다(결함 패턴 C9).
|
|
- **제품마다 다른 것은 제품 소유 파일에 둔다.** 제품이 템플릿 소유 파일을 고쳐야 하면 결함이다. 동기화마다 같은 파일이 충돌한다. 제품 소유 자리의 예: `src/bootstrap/product-composition.ts`, `src/contracts/product-contracts.ts`, `config/ci/product-gates.json`. 효과는 다음 동기화 충돌 수로 잰다(결함 패턴 S4).
|
|
- **경계 예외는 실제 쓰임만큼만 연다.** kernel 폴더에는 공유 메커니즘만 둔다(결함 패턴 S5).
|
|
- **두 모듈이 이어지는 곳을 지나는 테스트를 둔다.** 한쪽이 보내는 결과를 다른 쪽이 다른 뜻으로 받는 결함은 연결 지점에서만 보인다(결함 패턴 S6).
|
|
|
|
## 11. 고칠 때 — 수정이 새로 가정하는 것
|
|
|
|
2026-11-05 리뷰의 새 발견 48건 중 22건은 원인이 지난 수정이었다. 수정 커밋마다 본문 「위험·한계」에 적는다(결함 패턴 G13).
|
|
|
|
1. 이 변경이 새로 가정하는 상태(빈 제품 파일, CI env 없음, 객체 하나, 기능 0개 등).
|
|
2. 그 가정이 깨지는 지원 구성에서 한 번 돌렸는가([../improve.md](../improve.md) 4.2절 6단계).
|
|
3. 이 변경이 다른 검사를 약하게 했는가. 경로를 백틱 밖으로 옮겨 문서 검사를 피한 수정이 그 경로를 검사 밖으로 냈다. 위험을 커밋 본문에 적고도 테스트하지 않아 다운스트림 게이트가 항상 실패한 수정도 있다.
|
|
|
|
## 12. 제거 가능성
|
|
|
|
지울 수 있는 단위는 merge 게이트 FE-GATE-020의 드릴이 지킨다. 드릴 목록은 `config/ci/gates.json`의 FE-GATE-020 `commandIds`다.
|
|
|
|
- 구조를 바꾸면 드릴을 돌린다. 드릴 fixture가 복사하는 목록(`scripts/lib/removal-fixture.ts`, 이 목록 하나만 쓴다)이 바뀐 구조를 아는지 본다. 그 목록에 `README.md`·`CHANGELOG.md`가 없어 드릴 넷 중 셋이 항상 실패한 일이 있다(결함 패턴 G11).
|
|
- 드릴은 오래 걸린다(FE-GATE-020은 14~21분). desktop에서 잠금 아래 돌린다.
|