정리 4단계의 R2 검사는 등록부를 쓰는 7곳만 봤다. 그 밖에 루트 이름을 담은 목록이 코드 15파일에 19개 따로 있어, 루트 항목 하나를 옮기면 여전히 여러 곳을 같이 고쳐야 했다. - 등록부에 집합 12개를 더했다. 사본 복사에서 건너뛰는 항목 셋 (checkout·provider·공급망 fixture), fixture 코드 범위, pnpm 매니페스트, Playwright 설정, visual 증거, 문서 입력, 에이전트 하네스, tsconfig 묶음 셋. 각 집합 설명에 읽는 파일을 적었다. - 사본이 건너뛰는 node_modules·dist·.tmp 같은 추적 안 하는 항목은 종류 untracked(optional)로 적는다. 추적 파일이 있으면 시험이 실패한다. - 19개 목록이 모두 집합을 고른다. 집합의 원소는 전과 같아 동작은 바뀌지 않는다. - R2 시험이 추적되는 코드 파일 전체를 본다. 루트 항목(이나 그 안 경로)만 담은 문자열 배열에 추적되는 루트 이름이 둘 이상이면 실패. 인자 목록은 `--` 뒤만 본다. main의 옛 목록 18개를 이 검사가 잡는 것을 확인했다. - 집합마다 selectRepositoryPaths·selectRepositoryEntries로 고르는 코드가 있는지 본다. 문서를 복사하지 않는 제거 drill(FE-GATE-020)은 문서 시험(REMOVAL_FIXTURE_DOCUMENT_TESTS)을 지우는데, 집합 셋 (agent-harness·documentation-inputs·feature-typecheck)은 그 시험만 읽는다. 시험이 이 셋을 적어 두고, 문서 시험이 지워진 사본에서만 셋이 비는 것을 허용한다. 셋이 바뀌면 전체 checkout에서 실패한다. - 파서가 kinds·sets 설명과 코드의 목록이 같은지 본다. - .gitignore 주석이 a11y 기록을 아직 artifacts/ 아래라고 적던 것을 고쳤다(정리 3단계에서 docs/로 옮김). 검증(desktop): test:unit, check:types, check:ci, lint, verify:documentation. repository-layout 시험을 문서 없는 제거 사본과 feature-scaffold 사본에서도 돌렸고, 집합 하나의 읽는 곳을 지우면 두 곳 모두 실패한다.
142 lines
6.0 KiB
TypeScript
142 lines
6.0 KiB
TypeScript
import { spawnSync } from "node:child_process";
|
|
import { existsSync } from "node:fs";
|
|
import { cp, mkdir, mkdtemp, readdir, readFile, rm, writeFile } from "node:fs/promises";
|
|
import { tmpdir } from "node:os";
|
|
import path from "node:path";
|
|
|
|
import { afterAll, describe, expect, it } from "vitest";
|
|
|
|
import { linkFixtureNodeModules } from "../../scripts/lib/fixture-node-modules.ts";
|
|
import { REMOVAL_FIXTURE_COPY_TARGETS } from "../../scripts/lib/removal-fixture.ts";
|
|
import { selectRepositoryPaths } from "../../scripts/lib/repository-layout.ts";
|
|
|
|
/**
|
|
* 2026-11-07. The template ships no sample feature: what the generated
|
|
* feature does not show, docs/manual shows as code blocks a product copies
|
|
* into its feature folder. Each such block has `<!-- manual-code-block: <path> -->`
|
|
* above it, the path in the feature `create:feature invoice-feature
|
|
* --with-create` writes. Here a copy of the repository gets that feature, each
|
|
* block goes to its path unchanged, and the app and test typecheck programs,
|
|
* lint and the feature's tests run on it. A block that is a test runs as it
|
|
* is; what the other blocks do is checked by tests/fixtures/manual-code-blocks.
|
|
*/
|
|
const MANUAL = "docs/manual";
|
|
const FEATURE_ID = "invoice-feature";
|
|
const CHECKS = "tests/fixtures/manual-code-blocks";
|
|
const MARKED_BLOCK = /<!-- manual-code-block: (\S+) -->\n```tsx?\n([\s\S]*?)\n```/gu;
|
|
|
|
async function manualDocuments(directory: string): Promise<string[]> {
|
|
const documents: string[] = [];
|
|
for (const entry of await readdir(directory, { withFileTypes: true })) {
|
|
const target = path.join(directory, entry.name);
|
|
if (entry.isDirectory()) documents.push(...(await manualDocuments(target)));
|
|
else if (entry.name.endsWith(".md")) documents.push(target);
|
|
}
|
|
return documents.sort();
|
|
}
|
|
|
|
/** Each marked block by the path it goes to. */
|
|
async function markedBlocks(): Promise<ReadonlyMap<string, string>> {
|
|
const blocks = new Map<string, string>();
|
|
for (const document of await manualDocuments(MANUAL)) {
|
|
for (const [, target = "", body = ""] of (await readFile(document, "utf8")).matchAll(MARKED_BLOCK)) {
|
|
if (blocks.has(target)) throw new Error(`${target} is marked twice in ${MANUAL}`);
|
|
blocks.set(target, `${body}\n`);
|
|
}
|
|
}
|
|
return blocks;
|
|
}
|
|
|
|
const roots: string[] = [];
|
|
|
|
afterAll(async () => {
|
|
await Promise.all(roots.map((root) => rm(root, { recursive: true, force: true })));
|
|
});
|
|
|
|
async function copyRepository(): Promise<string> {
|
|
const root = await mkdtemp(path.join(tmpdir(), "manual-code-blocks-"));
|
|
roots.push(root);
|
|
for (const entry of REMOVAL_FIXTURE_COPY_TARGETS) {
|
|
// A removal drill runs this test in a copy that has already lost some.
|
|
if (!existsSync(path.resolve(entry))) continue;
|
|
await cp(path.resolve(entry), path.join(root, entry), {
|
|
recursive: true,
|
|
filter: (source) => !source.includes(`${path.sep}.generated`),
|
|
});
|
|
}
|
|
await linkFixtureNodeModules(root);
|
|
return root;
|
|
}
|
|
|
|
function run(root: string, command: string, args: readonly string[]) {
|
|
const result = spawnSync(command, args, { cwd: root, encoding: "utf8", maxBuffer: 64 * 1024 * 1024 });
|
|
return { status: result.status, output: `${result.stdout}${result.stderr}` };
|
|
}
|
|
|
|
describe("docs/manual code blocks, pasted into a generated feature", () => {
|
|
it("marks each block with a path in the feature it is written for", async () => {
|
|
const targets = [...(await markedBlocks()).keys()].sort();
|
|
|
|
expect(targets).toEqual([
|
|
"src/features/invoice-feature/adapters/invoice-problem-mapping.ts",
|
|
"src/features/invoice-feature/contracts/invoice-list-search.ts",
|
|
"src/features/invoice-feature/contracts/invoice-problem-details.ts",
|
|
"src/features/invoice-feature/domain/invoice.ts",
|
|
"src/features/invoice-feature/presentation/use-invoice-failure-action.ts",
|
|
"src/features/invoice-feature/presentation/use-invoice-list-filters.ts",
|
|
"tests/features/invoice-feature/invoice-forbidden.test.tsx",
|
|
]);
|
|
});
|
|
|
|
it("typechecks, lints and does what the manual says", async () => {
|
|
const blocks = await markedBlocks();
|
|
const root = await copyRepository();
|
|
const node = process.execPath;
|
|
|
|
// The generator runs first, as `corepack pnpm create:feature` does.
|
|
const indexed = run(root, node, ["scripts/generate-product-feature-index.ts"]);
|
|
expect(indexed.status, indexed.output).toBe(0);
|
|
const created = run(root, node, ["scripts/create-feature.ts", FEATURE_ID, "--with-create"]);
|
|
expect(created.status, created.output).toBe(0);
|
|
|
|
for (const [target, block] of blocks) {
|
|
const file = path.join(root, target);
|
|
// A block adds a file; it never stands in for one the command wrote.
|
|
expect(existsSync(file), `${target} exists before the block is pasted`).toBe(false);
|
|
await mkdir(path.dirname(file), { recursive: true });
|
|
await writeFile(file, block);
|
|
}
|
|
const checks = (await readdir(CHECKS)).filter((name) => name.endsWith(".check.tsx"));
|
|
expect(checks.length).toBeGreaterThan(0);
|
|
for (const check of checks) {
|
|
await writeFile(
|
|
path.join(root, "tests/features", FEATURE_ID, check.replace(/\.check\.tsx$/u, ".test.tsx")),
|
|
(await readFile(path.join(CHECKS, check), "utf8")).replaceAll("{{feature}}", FEATURE_ID),
|
|
);
|
|
}
|
|
|
|
for (const program of selectRepositoryPaths("feature-typecheck")) {
|
|
const typecheck = run(root, path.resolve("node_modules/.bin/tsc"), ["--project", program]);
|
|
expect(typecheck.output, program).toBe("");
|
|
expect(typecheck.status, program).toBe(0);
|
|
}
|
|
const lint = run(root, path.resolve("node_modules/.bin/eslint"), [
|
|
`src/features/${FEATURE_ID}`,
|
|
`tests/features/${FEATURE_ID}`,
|
|
"--max-warnings=0",
|
|
]);
|
|
expect(lint.output).toBe("");
|
|
expect(lint.status).toBe(0);
|
|
const architecture = run(root, node, ["scripts/check-architecture.ts"]);
|
|
expect(architecture.status, architecture.output).toBe(0);
|
|
|
|
const tests = run(root, node, [
|
|
"scripts/run-vitest.ts",
|
|
"run",
|
|
`tests/features/${FEATURE_ID}`,
|
|
"--reporter=dot",
|
|
]);
|
|
expect(tests.status, tests.output).toBe(0);
|
|
}, 300_000);
|
|
});
|