루트 항목 하나를 옮기려면 코드 7곳의 루트 경로 목록을 같이 고쳐야 했다(복사 대상, 비밀값 검사 범위, 공급망 시험의 필수 입력, 이력 문서 검사, 규모 입력, vite 입력, TS 전용 규칙). 서로 다른 부분집합이고 한 곳에서 선언하지 않았다. 목록이 갈라져 공급망 생성이 깨진 적도 있다 (removal-fixture.ts 주석). 루트에는 JSON Schema 5개만 담은 `schemas/`가 `config/` 옆에 따로 있었다. `artifacts/`(출력 폴더)에는 사람이 쓴 수동 a11y 기록이, `config/hosting/`(호스트 계약)에는 시험 fixture가 섞였다. 고른 방법(design-docs repo-structure/04-frontend-layout.md 9.2절 3단계, 11절 R1·R2, 소유자 승인 2026-11-07): - `config/repository-layout.json`이 루트 항목마다 종류·역할·읽는 곳과 들어가는 목록(`sets`, 항목 안 경로는 `setPaths`)을 적는다. `scripts/lib/repository-layout.ts`가 읽고 검증한다. 6곳은 이름 붙은 집합을 고른다. JSON인 비밀값 검사 정책은 집합의 사본을 두고 시험이 같은지 본다(정책 파일은 릴리스 후보에 실려 형식을 바꾸지 않았다). 공급망 시험의 필수 입력 목록은 그 시험으로 대신한다. - `tests/unit/repository-layout.test.ts`: 등록부에 없는 루트 항목이 추적되면 실패(R1). 7곳이 등록부 모듈을 쓰고 루트 이름 둘 이상의 문자열 배열을 갖지 않는지(R2). - `schemas/artifacts/` → `config/schemas/artifacts/`, recipe 카탈로그 스키마 → `config/schemas/recipes/`. 정책 입력 순서(ASCII)에 맞춰 `config/schemas/`가 `config/security/` 앞에 온다. - 수동 a11y 기록 3개 → `docs/accessibility/route-reviews/`. `artifacts/`는 `.gitkeep`만 추적한다. 기록은 단위 시험이 읽어서 drill 사본에도 복사한다(`fixture-copy` 집합의 `docs/accessibility/route-reviews`). - `config/hosting/response-headers.fixture.json` → `tests/fixtures/hosting/response-headers.json`. 버린 것: 비밀값 검사 정책이 집합 이름을 참조하게 바꾸는 방법. 정책 파일은 릴리스 후보와 로컬 증거 평가가 읽는 형식이라 바꾸면 릴리스 증거 계약이 바뀐다. 루트 항목이 지워졌는데 등록부에 남는 경우는 시험하지 않았다. drill 사본은 일부만 복사해 그 방향을 볼 수 없다. 그런 항목은 그 집합을 쓰는 곳(복사, 비밀값 검사)에서 실패한다. 위험: 하네스 작업(fe-c)이 더할 `AGENTS.md`·`.claude/`를 미리 등록했다 (optional). 등록부가 이력 문서(`SPEC.md`)와 `CLAUDE.md` 이름을 적어서 이력 문서 검사에서 등록부 파일은 뺐다. 다운스트림은 자기 루트 항목을 등록부에 더해야 한다(CHANGELOG). CI 계약 기준선을 다시 받았다(a11y 기록 산출물 id·경로). 검증(desktop): 아래 4단계 커밋까지 쌓은 트리에서 test:unit, check:types, check:ci, lint, verify:documentation을 돌렸다(그 커밋에 적음). 이 커밋 단독으로 test:unit·check:ci·check:types를 돌렸다. Refs: design-docs repo-structure/04-frontend-layout.md 2.4·9.2·11절, README.md 3.4절
142 lines
5.5 KiB
TypeScript
142 lines
5.5 KiB
TypeScript
import { readFileSync } from "node:fs";
|
|
|
|
/**
|
|
* The repository root registry, config/repository-layout.json (R1 in
|
|
* docs/manual/03-outside-feature-folder.md). Every tracked root item has an
|
|
* entry, and every list of root paths is a named set chosen from it (R2).
|
|
* Seven places used to keep their own literal lists of root paths, each a
|
|
* different subset, so moving one root item meant editing all seven
|
|
* (design-docs repo-structure/04-frontend-layout.md §2.4).
|
|
*/
|
|
|
|
export const REPOSITORY_LAYOUT_SETS = Object.freeze([
|
|
"fixture-copy",
|
|
"fixture-documents",
|
|
"secret-scan",
|
|
"history-free",
|
|
"scale-source",
|
|
"vite-build",
|
|
"typescript-only",
|
|
] as const);
|
|
export type RepositoryLayoutSet = (typeof REPOSITORY_LAYOUT_SETS)[number];
|
|
|
|
export const REPOSITORY_LAYOUT_KINDS = Object.freeze([
|
|
"source",
|
|
"tool-convention",
|
|
"gate-input",
|
|
"document",
|
|
"history",
|
|
"output",
|
|
] as const);
|
|
export type RepositoryLayoutKind = (typeof REPOSITORY_LAYOUT_KINDS)[number];
|
|
|
|
export type RepositoryLayoutEntry = Readonly<{
|
|
/** A root item name: one path segment, no slash. */
|
|
path: string;
|
|
kind: RepositoryLayoutKind;
|
|
role: string;
|
|
readBy: string;
|
|
/** A removal drill or a product copy may not have it; a selection skips it when absent. */
|
|
optional: boolean;
|
|
/** The sets that select the whole item. */
|
|
sets: readonly RepositoryLayoutSet[];
|
|
/** The sets that select only these paths inside the item. */
|
|
setPaths: Readonly<Partial<Record<RepositoryLayoutSet, readonly string[]>>>;
|
|
}>;
|
|
|
|
export const REPOSITORY_LAYOUT_FILE = "config/repository-layout.json";
|
|
|
|
export function parseRepositoryLayout(value: unknown): readonly RepositoryLayoutEntry[] {
|
|
const document = record(value, "layout");
|
|
if (document["schemaVersion"] !== 1) throw new Error("layout: schemaVersion must be 1");
|
|
const entries = document["entries"];
|
|
if (!Array.isArray(entries) || entries.length === 0) {
|
|
throw new Error("layout: entries must be a non-empty array");
|
|
}
|
|
const seen = new Set<string>();
|
|
return Object.freeze(
|
|
entries.map((raw, index) => {
|
|
const entry = record(raw, `entries[${index}]`);
|
|
const at = `entries[${index}]`;
|
|
const itemPath = text(entry["path"], `${at}.path`);
|
|
if (itemPath.includes("/")) throw new Error(`${at}.path: a root item has no slash: ${itemPath}`);
|
|
if (seen.has(itemPath)) throw new Error(`${at}.path: duplicate root item ${itemPath}`);
|
|
seen.add(itemPath);
|
|
const kind = text(entry["kind"], `${at}.kind`);
|
|
if (!(REPOSITORY_LAYOUT_KINDS as readonly string[]).includes(kind)) {
|
|
throw new Error(`${at}.kind: unknown kind ${kind}`);
|
|
}
|
|
const sets = (entry["sets"] ?? []) as unknown;
|
|
if (!Array.isArray(sets)) throw new Error(`${at}.sets must be an array`);
|
|
const setPaths = record(entry["setPaths"] ?? {}, `${at}.setPaths`);
|
|
for (const set of [...sets, ...Object.keys(setPaths)]) {
|
|
if (!(REPOSITORY_LAYOUT_SETS as readonly string[]).includes(set as string)) {
|
|
throw new Error(`${at}: unknown set ${String(set)}`);
|
|
}
|
|
}
|
|
for (const [set, paths] of Object.entries(setPaths)) {
|
|
if (!Array.isArray(paths) || paths.length === 0) {
|
|
throw new Error(`${at}.setPaths.${set} must be a non-empty array`);
|
|
}
|
|
for (const inner of paths) {
|
|
if (typeof inner !== "string" || !inner.startsWith(`${itemPath}/`)) {
|
|
throw new Error(`${at}.setPaths.${set}: ${String(inner)} is not inside ${itemPath}`);
|
|
}
|
|
}
|
|
if (sets.includes(set)) throw new Error(`${at}: ${set} selects the whole item and paths in it`);
|
|
}
|
|
return Object.freeze({
|
|
path: itemPath,
|
|
kind: kind as RepositoryLayoutKind,
|
|
role: text(entry["role"], `${at}.role`),
|
|
readBy: text(entry["readBy"], `${at}.readBy`),
|
|
optional: entry["optional"] === true,
|
|
sets: Object.freeze([...sets] as RepositoryLayoutSet[]),
|
|
setPaths: Object.freeze(setPaths as Partial<Record<RepositoryLayoutSet, readonly string[]>>),
|
|
});
|
|
}),
|
|
);
|
|
}
|
|
|
|
export const REPOSITORY_LAYOUT: readonly RepositoryLayoutEntry[] = parseRepositoryLayout(
|
|
JSON.parse(readFileSync(new URL(`../../${REPOSITORY_LAYOUT_FILE}`, import.meta.url), "utf8")),
|
|
);
|
|
|
|
/** The paths a set selects, in registry order. */
|
|
export function selectRepositoryPaths(
|
|
set: RepositoryLayoutSet,
|
|
layout: readonly RepositoryLayoutEntry[] = REPOSITORY_LAYOUT,
|
|
): readonly string[] {
|
|
return Object.freeze(
|
|
layout.flatMap((entry) =>
|
|
entry.sets.includes(set) ? [entry.path] : [...(entry.setPaths[set] ?? [])],
|
|
),
|
|
);
|
|
}
|
|
|
|
/** Like selectRepositoryPaths, with whether a drill or a copy may lack each path. */
|
|
export function selectRepositoryEntries(
|
|
set: RepositoryLayoutSet,
|
|
layout: readonly RepositoryLayoutEntry[] = REPOSITORY_LAYOUT,
|
|
): readonly Readonly<{ path: string; optional: boolean }>[] {
|
|
return Object.freeze(
|
|
layout.flatMap((entry) =>
|
|
(entry.sets.includes(set) ? [entry.path] : [...(entry.setPaths[set] ?? [])]).map(
|
|
(selected) => Object.freeze({ path: selected, optional: entry.optional }),
|
|
),
|
|
),
|
|
);
|
|
}
|
|
|
|
function record(value: unknown, at: string): Record<string, unknown> {
|
|
if (typeof value !== "object" || value === null || Array.isArray(value)) {
|
|
throw new Error(`${at} must be an object`);
|
|
}
|
|
return value as Record<string, unknown>;
|
|
}
|
|
|
|
function text(value: unknown, at: string): string {
|
|
if (typeof value !== "string" || value.trim() === "") throw new Error(`${at} must be a non-empty string`);
|
|
return value;
|
|
}
|