Files
clean-architecture-frontend…/scripts/scale/collect-tsc-diagnostics.ts
T
DongHyeonka b26517e6f2 fix(docs): 설계 주석에 문서 이름을 붙이고 지운 뒤 끊기는 링크를 없앤다 (1101/14-01)
문제: 코드 주석 87곳(74파일, .dependency-cruiser.json 포함)이 "Spec §N"
처럼 문서 이름 없이 절 번호만 적는다(대문자 83, 소문자 "spec §" 4).
가리키는 설계서는 README가 복사 뒤 지워도 된다고 한 docs/reviews/ 안에
있었다. 지울 수 있는 기록 검사는 경로 문자열만 찾아 이 참조를 잡지
못했다. 현재 계약 문서도 지울 수 있는 파일로 링크한다:
docs/reviews/adapters/INVENTORY.md 145행이 옆의 adapter 리뷰로,
docs/operations/adapter-remediation-ledger.md가 adapter 리뷰와
docs/superpowers/plans의 계획으로.

고른 방법:
- 주석의 "Spec §"/"spec §"를 "scale-architecture.md §"로 바꾼다(앞
  커밋이 옮긴 docs/architecture/scale-architecture.md). 설명 문장과 절
  번호는 그대로다. 절 번호가 없는 "Spec §"는 없었다.
- tests/unit/deletable-history-documents.test.ts에 "spec" + 선택 공백 +
  "§"(대소문자 무시)를 거부하는 검사를 더하고, 검사 대상에
  .dependency-cruiser.json을 넣는다.
- README "Files you can delete after copying"에서 INVENTORY.md 한 파일
  대신 docs/reviews/adapters/ 폴더를 남기게 하고 이유(INVENTORY 행과
  ledger가 그 리뷰로 링크한다)를 적는다. docs/README.md §3도 같게 고친다.
  INVENTORY의 행 구조는 바꾸지 않는다.
- 남긴 adapter 리뷰와 ledger가 docs/superpowers/plans로 거는 링크 5곳은
  링크를 풀고 "작업 이력 계획, 복사본은 지울 수 있다"로 적는다.
버린 대안: INVENTORY 145칸의 링크를 그룹 이름으로 바꾸기. 템플릿에서도
상세 리뷰로 가는 길이 없어지고 수정이 145곳이다. 계획 3개도 지우기
목록에서 빼기. 지울 수 있는 폴더 안에 예외가 흩어지고, 계획이 다시
다른 이력을 가리키면 남길 목록이 계속 커진다.

위험·한계: 검사는 "HTML spec §4"처럼 다른 명세를 "spec §"로 부르는
주석도 거부한다. 그때는 "HTML Standard §4"처럼 이름을 쓴다.
src/contracts/storage-keys.ts:79의 "release-coherence plan Task 6"처럼
이름 없는 계획 참조는 이 검사가 잡지 않는다. 복사한 프로젝트가 이미
docs/reviews/adapters/를 지웠다면 링크는 계속 끊겨 있다. CHANGELOG.md의
이력 언급 4곳(:15 두 경로, :75 PRODUCT.md, :93)은 고치지 않았다.
check:remediation-ledger는 이 변경 전후 같은 4줄로 실패한다(이미 있던
실패, 게이트 밖). tests/unit/telemetry.test.ts의 describe 이름 하나가
바뀐다.

검증:
- RED: 치환 전 새 검사가 87줄을 들어 실패(1 failed | 1 passed).
- GREEN: 같은 테스트 2 passed. 변이 "// Spec §4. budgets live here"를
  src/platform/errors/app-error.ts에 넣으면 그 한 줄로 실패, 되돌림.
- 치환 diff: 바뀐 87줄 쌍이 토큰 외에 같음(스크립트 대조, 불일치 0).
- 삭제 실험(작업 트리 복사본에서 README 목록대로 지움): 끊긴 링크
  148→0, 끊긴 경로 언급 10→4(남은 4는 CHANGELOG.md), 이름 없는 설계
  참조 87→0, scale-architecture.md §N 87곳 중 없는 절 0. 같은 복사본에서
  verify-documentation-readiness PASS_SCOPED, 지울 수 있는 기록 테스트
  2 passed.
- node scripts/verify-documentation-readiness.ts: PASS_SCOPED
- node scripts/check-adapter-inventory.ts: PASS
- node scripts/run-vitest.ts run tests/unit/deletable-history-documents.test.ts
  tests/unit/documentation-readiness.test.ts tests/unit/telemetry.test.ts:
  50 passed. tests/architecture: 39 passed.
- npx tsc --noEmit (app·node·test): 모두 통과. 바꾼 TS 74파일 eslint 통과.
  .dependency-cruiser.json JSON 파싱 통과.
- 미실행: check:architecture(pnpm 필요).
2026-11-03 07:17:49 +09:00

209 lines
7.2 KiB
TypeScript

import { spawnSync } from "node:child_process";
import { mkdir, rm, writeFile } from "node:fs/promises";
import { join, resolve } from "node:path";
import {
assertLinearOrBetter,
growthExponents,
} from "../../src/platform/cardinality/growth-regression.ts";
/**
* scale-architecture.md §38. TypeScript scale gate.
*
* Parses `tsc --extendedDiagnostics` and measures bounded local fixtures:
* generated feature modules composed by one context, at increasing local
* cardinality. S3/S4 are never compiled; they are verified as topology.
*/
export type TscDiagnostics = Readonly<{
files: number;
lines?: number;
types: number;
symbols: number;
instantiations: number;
memoryKb?: number;
totalTimeSeconds?: number;
}>;
const FIELD_NAMES: Readonly<Record<string, keyof TscDiagnostics>> = Object.freeze({
Files: "files",
Lines: "lines",
Types: "types",
Symbols: "symbols",
Instantiations: "instantiations",
"Memory used": "memoryKb",
"Total time": "totalTimeSeconds",
});
export function parseTscExtendedDiagnostics(text: string): TscDiagnostics {
const parsed: Partial<Record<keyof TscDiagnostics, number>> = {};
for (const line of text.split(/\r?\n/u)) {
const match = /^\s*([A-Za-z][A-Za-z ]*?):\s+([\d.]+)\s*([KMs]?)\s*$/u.exec(line);
if (!match) continue;
const field = FIELD_NAMES[match[1] as string];
if (!field) continue;
const value = Number(match[2]);
if (!Number.isFinite(value)) continue;
parsed[field] = match[3] === "M" ? value * 1024 : value;
}
for (const required of ["files", "types", "symbols", "instantiations"] as const) {
if (parsed[required] === undefined) {
throw new TypeError(`tsc diagnostics missing ${required}`);
}
}
return Object.freeze(parsed) as TscDiagnostics;
}
export function runTscDiagnostics(project: string, cwd = process.cwd()): TscDiagnostics {
const tsc = resolve(cwd, "node_modules/.bin/tsc");
const result = spawnSync(tsc, ["--project", project, "--noEmit", "--extendedDiagnostics"], {
cwd,
encoding: "utf8",
maxBuffer: 16 * 1024 * 1024,
});
if (result.status !== 0) {
throw new Error(`tsc failed for ${project}: ${(result.stdout + result.stderr).slice(-2_000)}`);
}
return parseTscExtendedDiagnostics(result.stdout);
}
/**
* Generates one bounded local app: `features` feature modules, each with its
* own typed contract, composed by one generated index. The shape mirrors the
* repository's feature-module/generated-index pattern.
*/
export async function writeLocalTscFixture(
root: string,
features: number,
): Promise<string> {
await rm(root, { recursive: true, force: true });
await mkdir(join(root, "features"), { recursive: true });
const imports: string[] = [];
const members: string[] = [];
for (let index = 0; index < features; index += 1) {
const id = `feature${index}`;
await writeFile(
join(root, "features", `${id}.ts`),
`export type ${id}Input = Readonly<{ id: string; limit: number; tags?: readonly string[] }>;\n` +
`export type ${id}Output = Readonly<{ items: readonly Readonly<{ id: string; name: string }>[] }>;\n` +
`export const ${id} = Object.freeze({\n` +
` id: "${id}" as const,\n` +
` routes: Object.freeze({ ${id.toUpperCase()}_LIST: "/${id}" }),\n` +
` execute(input: ${id}Input): ${id}Output {\n` +
` return { items: [{ id: input.id, name: String(input.limit) }] };\n` +
` },\n` +
`});\n`,
);
imports.push(`import { ${id} } from "./features/${id}.ts";`);
members.push(` ${id},`);
}
await writeFile(
join(root, "index.ts"),
`${imports.join("\n")}\nexport const LOCAL_FEATURES = Object.freeze([\n${members.join("\n")}\n] as const);\n` +
`export type LocalFeatureId = (typeof LOCAL_FEATURES)[number]["id"];\n`,
);
const tsconfig = join(root, "tsconfig.json");
await writeFile(
tsconfig,
JSON.stringify(
{
compilerOptions: {
target: "ES2022",
module: "ESNext",
moduleResolution: "Bundler",
allowImportingTsExtensions: true,
strict: true,
noEmit: true,
skipLibCheck: true,
types: [],
lib: ["ES2022"],
},
include: ["index.ts", "features/*.ts"],
},
null,
2,
),
);
return tsconfig;
}
export type TscScaleReport = Readonly<{
passed: boolean;
app: TscDiagnostics;
local: readonly Readonly<{ features: number; diagnostics: TscDiagnostics }>[];
checks: readonly Readonly<{ name: string; passed: boolean; detail: string }>[];
}>;
export async function collectTscScale(
localSizes: readonly number[],
cwd = process.cwd(),
): Promise<TscScaleReport> {
const app = runTscDiagnostics("tsconfig.app.json", cwd);
const local: { features: number; diagnostics: TscDiagnostics }[] = [];
for (const features of localSizes) {
const tsconfig = await writeLocalTscFixture(
resolve(cwd, ".tmp/scale-tsc", `local-${features}`),
features,
);
local.push({ features, diagnostics: runTscDiagnostics(tsconfig, cwd) });
}
const checks: { name: string; passed: boolean; detail: string }[] = [];
for (const metric of ["types", "symbols", "instantiations"] as const) {
const series = local.map(({ features, diagnostics }) => ({
n: features,
// Library/baseline cost is constant; growth is judged on what the local
// features add on top of the smallest fixture.
cost: Math.max(1, diagnostics[metric]),
}));
try {
assertLinearOrBetter(series, { maxExponent: 1.3 });
checks.push({
name: `tsc:${metric}`,
passed: true,
detail: `exponents ${growthExponents(series).map((value) => value.toFixed(2)).join(", ")}`,
});
} catch (error) {
checks.push({
name: `tsc:${metric}`,
passed: false,
detail: error instanceof Error ? error.message : String(error),
});
}
}
return Object.freeze({
passed: checks.every((check) => check.passed),
app,
local: Object.freeze(local),
checks: Object.freeze(checks),
});
}
async function main(): Promise<void> {
const artifactArg = process.argv.find((argument) => argument.startsWith("--artifact="));
const sizesArg = process.argv.find((argument) => argument.startsWith("--local-sizes="));
const sizes = (sizesArg?.slice("--local-sizes=".length) ?? "25,100,400")
.split(",")
.map(Number)
.filter((value) => Number.isSafeInteger(value) && value > 0);
const artifact = resolve(
artifactArg?.slice("--artifact=".length) ?? "artifacts/scale/tsc-diagnostics.json",
);
const report = await collectTscScale(sizes);
await mkdir(resolve(artifact, ".."), { recursive: true });
await writeFile(
artifact,
`${JSON.stringify({ schemaVersion: 1, generatedAt: new Date().toISOString(), ...report }, null, 2)}\n`,
);
process.stdout.write(
`tsc app: files=${report.app.files} types=${report.app.types} instantiations=${report.app.instantiations}\n`,
);
for (const check of report.checks) {
process.stdout.write(`${check.passed ? "PASS" : "FAIL"} ${check.name} (${check.detail})\n`);
}
process.stdout.write(`tsc diagnostics artifact: ${artifact}\n`);
if (!report.passed) process.exitCode = 1;
}
if (import.meta.url === `file://${process.argv[1]}`) {
await main();
}