Files
clean-architecture-frontend…/scripts/lib/feature-residue.ts
T
DongHyeonka b05bf19c05 fix(scripts): 제거 드릴의 빌드 잔여물 검사도 이름 단위로 찾는다
문제: 앞 커밋으로 `src` 검사는 이름 단위가 됐지만, 빌드한 `dist`는 여전히
기능 ID를 대소문자 무시 부분 문자열로 찾았다. desktop에서
`create:feature product-feature` 뒤 그 기능을 지우는 드릴을 돌리면 `src`
검사는 통과하고 `built-fixture-id-residue`가 템플릿 자기 청크
`platform-overview-page-*.js`(`data-product-feature` 속성)로 실패했다.

고친 것: 이름 단위 규칙을 `featureNamePattern`으로 꺼내 `src` 본문과
빌드 결과에 같이 쓴다.

위험·한계: 빌드 결과에서도 대소문자를 가린다. 기능 ID와 폴더는 소문자
kebab이라 놓치는 경우는 없다고 본다.

검증(desktop): feature-residue·feature-removal-argument 15개 통과,
check:types·eslint rc=0(로그 /tmp/claude-gates/w2fe2-res3/). 고치기 전
드릴 실패는 /tmp/claude-gates/w2fe2-resx3/.

Refs: 1105/16-04
2026-11-13 05:25:04 +09:00

144 lines
6.7 KiB
TypeScript

import { readdir, readFile } from "node:fs/promises";
import path from "node:path";
/**
* 1105/16-04. What a product feature leaves behind after
* `test:sample-removal -- --feature=<id>` deleted its folders, in the copy the
* drill made.
*
* - `src/`: any file whose path or text still names the feature ID or its
* folder. Platform source never names a product feature, so a name left
* there is a reference the type checker cannot see (a catalog key, a
* runtime override, a link). The name counts as a whole name only: in the
* text, case-sensitive with no identifier character (`[A-Za-z0-9_-]`) on
* either side; in the path, a segment equal to it or whose part before the
* first `.` is. A substring search counted ten template files for
* `product-feature` (`product-features.ts`, `product-features-port.ts` and
* their importers). `src/.generated/` is derived from the feature list and
* left out. A one-word ID that is an ordinary word in the template
* (`search`) can still be found in its text.
* - `tests/`: a file named after the feature (the same path rule; the
* template's `product-feature-switch.test.tsx` is not), or one that imports from the
* feature's `src/features/<dir>/` or `tests/features/<dir>/`. A vitest
* test's text is not searched for the bare name: the template's own tests
* use example IDs as data (`tests/unit/create-feature.test.ts` writes
* `invoice-feature`, the manual's example, 51 times), and the drill flagged
* them as residue of a product feature that took that name. A vitest test
* that still depends on the removed feature fails `test:all`, which the
* drill runs.
* - 1106/16-01. `test:all` runs vitest only (the `*.test.ts(x)` files under
* `tests/`, vitest.config.ts), and no step of the drill runs a Playwright
* spec. So a spec (`*.spec.ts`) that names the feature only in its text,
* such as `test.describe("invoice-feature", ...)`, is residue: its text is
* searched for the ID or folder name as written, case-sensitive, with no
* identifier character (`[A-Za-z0-9_-]`) on either side. A longer name
* that contains it (`generate-product-feature-index.ts` for
* `product-feature`, `KO_MESSAGES` for `messages`) does not count.
* Diff review DR-02: only a name with a hyphen is searched. A one-word ID
* or folder (`status`, `reports`, `messages`) is an ordinary word in the
* template's own specs (`status: 200`, `getByRole("status")`, "reports" in
* a test title), and no text rule tells that from a reference.
* - 0925 FOLLOW-UP 09-07. A spec that opens the feature by its URL alone
* (`page.goto("/invoices")`) failed only in FE-GATE-008, after the drill
* passed. `routePaths` are the removed feature's route paths: a spec with a
* string that starts with one, up to its first parameter (`/invoices` of
* `/invoices/:id`) and followed by the string's end or `/`, `?`, `#`, is
* residue. A path that is `/` up to its first parameter is not searched.
* What is still not found: a spec that names only a one-word ID, or builds
* the URL from parts. 03's hand list removes the feature's specs.
*
* The drill applies the same rule to a sample a project lists in
* scripts/lib/removable-template-features.ts.
*/
function escapeRegExp(value: string): string {
return value.replace(/[.*+?^${}()|[\]\\]/gu, "\\$&");
}
/**
* The feature ID or folder as a whole name: case-sensitive, with no
* identifier character (`[A-Za-z0-9_-]`) on either side. The drill searches
* `src` text and the built `dist` with it; the template's own bundle holds
* `data-product-feature` and `product-features`, which a substring search
* counted for a feature named `product-feature`.
*/
export function featureNamePattern(featureId: string, directory: string): RegExp {
const names = [...new Set([featureId, directory])].map(escapeRegExp).join("|");
return new RegExp(`(?<![A-Za-z0-9_-])(?:${names})(?![A-Za-z0-9_-])`, "u");
}
async function filesUnder(directory: string): Promise<string[]> {
const entries = await readdir(directory, { withFileTypes: true }).catch(() => []);
const nested = await Promise.all(
entries.map((entry) => {
const target = path.join(directory, entry.name);
return entry.isDirectory() ? filesUnder(target) : Promise.resolve([target]);
}),
);
return nested.flat();
}
/** The part of a route path before its first parameter or wildcard, or null for `/`. */
function staticRoutePrefix(routePath: string): string | null {
const segments: string[] = [];
for (const segment of routePath.split("/").filter(Boolean)) {
if (segment.startsWith(":") || segment.includes("*")) break;
segments.push(segment);
}
return segments.length === 0 ? null : `/${segments.join("/")}`;
}
export async function productFeatureResidue(
root: string,
featureId: string,
directory: string,
routePaths: readonly string[] = [],
): Promise<string[]> {
const nameSet = new Set([featureId, directory]);
const names = [...nameSet].map(escapeRegExp).join("|");
const wholeAnyName = featureNamePattern(featureId, directory);
const pathNames = (relativePath: string) =>
relativePath
.split("/")
.some((segment) => nameSet.has(segment) || nameSet.has(segment.split(".")[0] ?? ""));
const imported = new RegExp(
String.raw`(?:\bfrom\s*|\bimport\s*\(\s*|\bimport\s+|\bmock\s*\(\s*)["'][^"'\n]*/features/(?:${names})/`,
"u",
);
const specNames = [...new Set([featureId, directory])]
.filter((name) => name.includes("-"))
.map(escapeRegExp);
const wholeName =
specNames.length === 0
? null
: new RegExp(`(?<![A-Za-z0-9_-])(?:${specNames.join("|")})(?![A-Za-z0-9_-])`, "u");
const prefixes = [
...new Set(routePaths.map(staticRoutePrefix).filter((prefix): prefix is string => prefix !== null)),
].map(escapeRegExp);
const routeString =
prefixes.length === 0
? null
: new RegExp(`["'\`](?:${prefixes.join("|")})(?=["'\`/?#])`, "u");
const playwrightSpec = /\.spec\.[cm]?[jt]sx?$/u;
const residue: string[] = [];
const relative = (file: string) => path.relative(root, file).split(path.sep).join("/");
for (const file of await filesUnder(path.join(root, "src"))) {
const name = relative(file);
if (name.startsWith("src/.generated/")) continue;
if (pathNames(name) || wholeAnyName.test(await readFile(file, "utf8"))) residue.push(name);
}
for (const file of await filesUnder(path.join(root, "tests"))) {
const name = relative(file);
const text = await readFile(file, "utf8");
if (
pathNames(name) ||
imported.test(text) ||
(playwrightSpec.test(name) &&
((wholeName !== null && wholeName.test(text)) ||
(routeString !== null && routeString.test(text))))
) {
residue.push(name);
}
}
return residue.sort();
}