Audit remaining tools/ TypeScript files (#225 Phase 2)#240
Merged
Conversation
Phase 2 for #225. All 17 remaining tools/ files, 109 flagged comments. tools/ is now fully audited. Declaration-level rationale moved to JSDoc across binary format tables (ico), Unicode range tables (symbol-chars), field-tuning marker configs (glyph-markers, font-subsets), function preambles in the JSON generators, and helper utilities. In-body rationale rewritten as single-clause WHY: / INVARIANT: markers: - verify-steel-wrench-filter: four filter-condition explanations. - prefab-files: suffix ordering INVARIANT. - generate-labels-jsons, print-png-pixel-stat, generate-prefab- properties-jsons, bench-prefab-filter, generate-font-subsets, generate-glyph-markers: various WHY: on specific choices. - build.ts: serve-static exists because esbuild's serve drops response bodies under CI load (issue #202). Deleted where variable names, guard structure, or test title already conveyed the intent (Keep alive loop, No jpg ENOENT catch, section markers, restated pass-through labels). Style: single-clause sentences using because / so / since for causation, no ; / — / colon-elaboration per the #235-#236 memo. EXCLUDED_PATHS shrinks from 65 to 48.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Phase 2 for #225: audit all remaining
tools/TypeScript files in one sweep (17 files, 109 flagged comments). Drops the corresponding 17 entries fromEXCLUDED_PATHS.Coverage
tools/lib/symbol-chars.tsSYMBOL_RANGESandEXTRA_CODE_POINTStools/lib/ico.tsbuildIcotools/generate-prefab-properties-jsons.tsextractMeshSizes,parseYOffset,extractDensityScores,extractDistrictColors; one in-bodyWHY:on the zero-footprint skiptools/generate-font-subsets.tsJOBS; in-array note reshaped as one-lineWHY:;countGlyphspreamble → JSDoctools/generate-glyph-markers.tsWHY:eachtools/extract-added-prefabs.tsVERSIONSpreamble folded into JSDoc on the consttools/lib/utils.tsvanillaDir,compactStringify,collapseLeafArraystools/verify-steel-wrench-filter.tsWHY:each; two section markers (// Compareetc.) deletedtools/lib/prefab-files.tsINVARIANT:onPREFAB_SUFFIXES; ignored-XML predicate note → JSDoctools/bench-prefab-filter.tsWHY:tools/copy-map-files.tsWORLD_CONCURRENCYpreamble → JSDoctools/build.ts// Keep alivedeleted;serve-staticregression note (issue #202) kept as one-lineWHY:tools/print-png-pixel-stat.tsWHY:tools/generate-labels-jsons.tsWHY:tools/print-tts.tstools/generate-prefab-html.ts// No jpgin ENOENT branch deletedtools/generate-favicon.tsSIZESStyle
All new markers are single-clause sentences (or period-split two-sentence) with
because/so/sincefor causation. No;,—, colon-elaboration, or parenthetical elaboration on prose per the memo established in #235 / #236 review.tools/lib/prefab-html.ts,tools/lib/xmls/*and the binary parsers were audited in earlier PRs (#238, #235, #239).Test plan
deno task ci:lintpassesdeno task ci:fmt-checkpassesdeno task ci:type-checkpassesdeno task test— 41 tests / 241 steps passProgress
EXCLUDED_PATHS: 65 → 48.tools/is now fully audited.