루트 항목 하나를 옮기려면 코드 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절
90 lines
3.4 KiB
TypeScript
90 lines
3.4 KiB
TypeScript
import { readdir, readFile, stat } from "node:fs/promises";
|
|
import path from "node:path";
|
|
|
|
import { describe, expect, it } from "vitest";
|
|
|
|
import { selectRepositoryPaths } from "../../scripts/lib/repository-layout.ts";
|
|
|
|
/**
|
|
* README.md, "Files you can delete after copying", tells a new project that
|
|
* the build and the gates read none of the history documents except
|
|
* `docs/reviews/adapters/INVENTORY.md`. The removal fixtures rely on the same
|
|
* promise: they do not copy `docs/`. A test that opens a review document broke
|
|
* all three removal checks (fix of 11-04), so the promise is checked here.
|
|
*/
|
|
// The history-free set of config/repository-layout.json (R2). The registry
|
|
// itself names every root item, history documents included (R1); naming a
|
|
// root item is not reading it.
|
|
const CODE_PATHS = selectRepositoryPaths("history-free");
|
|
const LAYOUT_REGISTRY = "config/repository-layout.json";
|
|
|
|
// Built from pieces so that this file does not match itself.
|
|
const REVIEWS = ["docs", "reviews", ""].join("/");
|
|
const KEPT = `${REVIEWS}adapters/INVENTORY.md`;
|
|
// The 2026-09-25 round's task folder moved into the history folder on
|
|
// 2026-11-07 (docs/README.md §3), so the history pattern covers it. A pattern
|
|
// for the old root folder would now only catch a product's own route or
|
|
// folder of that name.
|
|
const DELETABLE = [
|
|
new RegExp(`${REVIEWS}(?!adapters/INVENTORY\\.md)`, "u"),
|
|
new RegExp(["docs", "superpowers"].join("/"), "u"),
|
|
new RegExp(["docs", "history"].join("/"), "u"),
|
|
new RegExp(`\\b${"SPEC"}\\.md\\b`, "u"),
|
|
new RegExp(`\\b${"CLAUDE"}\\.md\\b`, "u"),
|
|
];
|
|
/**
|
|
* 1101/14-01. A section number without a document name cannot be followed,
|
|
* and the scale design it meant used to live only in the history bundle a
|
|
* copy deletes. Cite it as `scale-architecture.md §N`
|
|
* (docs/architecture/scale-architecture.md, a current contract).
|
|
*/
|
|
const UNNAMED_SECTION = new RegExp(`\\b${"spec"} ?§`, "iu");
|
|
|
|
async function codeFiles(directory: string): Promise<string[]> {
|
|
const entries = await readdir(directory, { withFileTypes: true }).catch(
|
|
() => [],
|
|
);
|
|
const files = await Promise.all(
|
|
entries.map(async (entry) => {
|
|
const target = path.join(directory, entry.name);
|
|
if (entry.isDirectory())
|
|
return entry.name === "node_modules" ? [] : codeFiles(target);
|
|
return /\.(?:[cm]?[jt]sx?|json|ya?ml)$/u.test(entry.name) ? [target] : [];
|
|
}),
|
|
);
|
|
return files.flat();
|
|
}
|
|
|
|
async function linesMatching(patterns: readonly RegExp[]): Promise<string[]> {
|
|
const files = (
|
|
await Promise.all(
|
|
CODE_PATHS.map(async (entry) =>
|
|
(await stat(entry).catch(() => null))?.isDirectory() ? codeFiles(entry) : [entry],
|
|
),
|
|
)
|
|
).flat();
|
|
const matches: string[] = [];
|
|
for (const file of files) {
|
|
if (file === LAYOUT_REGISTRY) continue;
|
|
const lines = (await readFile(file, "utf8").catch(() => "")).split("\n");
|
|
lines.forEach((line, index) => {
|
|
if (patterns.some((pattern) => pattern.test(line)))
|
|
matches.push(`${file}:${index + 1}`);
|
|
});
|
|
}
|
|
return matches;
|
|
}
|
|
|
|
describe("deletable history documents", () => {
|
|
it("are read by no code, test, script or configuration", async () => {
|
|
expect(await linesMatching(DELETABLE), `only ${KEPT} may be read`).toEqual([]);
|
|
});
|
|
|
|
it("are not cited as an unnamed design section", async () => {
|
|
expect(
|
|
await linesMatching([UNNAMED_SECTION]),
|
|
"name the document: scale-architecture.md §N",
|
|
).toEqual([]);
|
|
});
|
|
});
|