Commit 7338058
committed
refactor(codegen-ts): apply pre-merge review findings to templateGenerator
Acts on the consensus findings from the code-review and code-simplifier
passes on the rc.12 templateGenerator() factory + docsFile() refactor.
All 497 codegen-ts tests still green; docs-file-basic byte-identity
gate preserved.
Findings applied (numbered per the agent reports):
#1 — drop the walk-mutation cleverness in docs-file.ts.
The rc.12 docsFile() wrapped templateGenerator() and mutated
tgOpts.walk per generate() call. Concurrency-unsafe (two docs-file
generators against different targets would race) and obscured the
intent. Replaced with a direct render() + projectProvider() call,
which is shorter than the wrapper anyway. The cross-port pillar of
"templateGenerator for ctx-free walks" is unaffected — other adopters
still use the factory; docs-file is a peer that needs ctx for the
outputLayout-driven path.
#2 — thread project root through GenContext.
Adds `projectRoot?: string` to GenContext, populated by the runner
from opts.projectRoot. templateGenerator() and docsFile() now read
ctx.projectRoot instead of process.cwd(). Falls back to cwd with a
ctx.warn() naming the problem ("running `meta gen` from a sub-dir
breaks project-template overrides"). Critical reviewer finding — a
silent foot-gun in the rc.12 release.
#3 — wrap render() with error context.
Both templateGenerator() and docsFile() now wrap render() in
try/catch that prepends `${generator name} on ${output path}: …` so
template-resolution failures surface a useful breadcrumb. Preserves
the original error as `cause`.
#4 — assert canonical template exists in findFrameworkTemplatesDir.
The walk-up to find codegen-ts's package.json could land on a
CONSUMER's package.json under hoisted pnpm/bun installs and silently
return a templates dir that doesn't exist. Now asserts the canonical
docs/entity-page.md.mustache lives at the candidate templates dir
before returning; throws with SELF_DIR in the message if not.
#7 — collapse three field.validators() loops into one.
constraintsCell in docs-data-builder.ts walked field.validators()
three times to bucket regex / length / numeric. One pass into three
local arrays, then emit in the original order (regex → maxLength-attr
→ length → numeric) to keep byte-identity with docs-file-basic.
#8 — drop the defensive try/catch around fileURLToPath in
framework-provider.ts. Per CLAUDE.md the project is ESM-only;
import.meta.url is guaranteed to be a file: URL. Defensive code for
an impossible state was muddying the contract.
#9 — drop the magic `for (let i = 0; i < 12; i++)` loop cap in
findFrameworkTemplatesDir. The parent-equals-self guard is the right
termination; the 12-iteration cap was arbitrary and would silently
return the wrong dir in deeply-nested workspaces.
#10 — clean test imports in template-generator.test.ts. Drop the
`void TYPE_OBJECT; void OBJECT_SUBTYPE_ENTITY;` dead-code suppressors
that were masking unused imports; consolidate two separate import
statements from @metaobjectsdev/metadata into one.
Held for separate follow-up (not in this commit):
- Finding #5: EntityDocData over-exposing Markdown-flavored fields as
"public contract" — wants a deliberate split into structural +
Markdown layers. API-surface decision worth a moment of design
thought.
- Finding #6: the `as unknown as { referencesRaw?: string }` cast on
MetaIdentity — would benefit from properly exposing referencesRaw
on the typed interface.
- Finding #11: test gaps for missing-template error, provider override
precedence, and conformance-perf single-render-per-fixture.
Verification:
bun run --filter '@metaobjectsdev/codegen-ts' typecheck — clean
bun test packages/codegen-ts — 497/497 pass, 1809 expect() calls
(includes templateGenerator unit tests, conformance harness,
docs-file-basic byte-identity golden gate)1 parent 7d376c6 commit 7338058
7 files changed
Lines changed: 139 additions & 101 deletions
File tree
- server/typescript/packages/codegen-ts
- src
- generators
- render-engine
- test/generators
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
27 | 36 | | |
28 | 37 | | |
29 | 38 | | |
| |||
Lines changed: 20 additions & 19 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
188 | 188 | | |
189 | 189 | | |
190 | 190 | | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
191 | 199 | | |
192 | 200 | | |
193 | 201 | | |
194 | 202 | | |
195 | | - | |
| 203 | + | |
196 | 204 | | |
197 | | - | |
198 | | - | |
199 | | - | |
200 | | - | |
201 | | - | |
202 | | - | |
203 | | - | |
204 | | - | |
205 | | - | |
| 205 | + | |
206 | 206 | | |
207 | 207 | | |
208 | | - | |
209 | | - | |
210 | | - | |
211 | | - | |
212 | | - | |
213 | | - | |
214 | | - | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
215 | 211 | | |
216 | 212 | | |
217 | | - | |
218 | | - | |
| 213 | + | |
| 214 | + | |
219 | 215 | | |
220 | 216 | | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
221 | 222 | | |
222 | 223 | | |
223 | 224 | | |
| |||
Lines changed: 49 additions & 47 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
4 | | - | |
5 | | - | |
6 | | - | |
7 | | - | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
8 | 15 | | |
9 | 16 | | |
10 | | - | |
11 | | - | |
12 | | - | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
13 | 20 | | |
14 | 21 | | |
15 | | - | |
| 22 | + | |
| 23 | + | |
16 | 24 | | |
17 | | - | |
18 | | - | |
19 | | - | |
20 | | - | |
| 25 | + | |
21 | 26 | | |
22 | 27 | | |
23 | 28 | | |
| |||
35 | 40 | | |
36 | 41 | | |
37 | 42 | | |
38 | | - | |
39 | | - | |
40 | | - | |
41 | | - | |
42 | | - | |
43 | | - | |
44 | | - | |
45 | | - | |
46 | | - | |
47 | | - | |
48 | | - | |
49 | | - | |
| 43 | + | |
50 | 44 | | |
| 45 | + | |
51 | 46 | | |
52 | 47 | | |
53 | | - | |
| 48 | + | |
54 | 49 | | |
55 | 50 | | |
56 | 51 | | |
57 | 52 | | |
58 | | - | |
59 | | - | |
60 | | - | |
61 | | - | |
62 | | - | |
63 | | - | |
64 | | - | |
65 | | - | |
66 | | - | |
67 | | - | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
68 | 61 | | |
69 | | - | |
70 | | - | |
71 | | - | |
72 | | - | |
73 | | - | |
74 | | - | |
75 | | - | |
76 | | - | |
77 | | - | |
78 | | - | |
79 | | - | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
80 | 82 | | |
81 | 83 | | |
82 | 84 | | |
| |||
Lines changed: 32 additions & 10 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
47 | 47 | | |
48 | 48 | | |
49 | 49 | | |
50 | | - | |
| 50 | + | |
51 | 51 | | |
52 | | - | |
53 | | - | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
54 | 55 | | |
55 | 56 | | |
56 | 57 | | |
| |||
63 | 64 | | |
64 | 65 | | |
65 | 66 | | |
66 | | - | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
67 | 80 | | |
68 | 81 | | |
69 | 82 | | |
70 | | - | |
71 | | - | |
72 | | - | |
73 | | - | |
74 | | - | |
75 | | - | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
76 | 98 | | |
77 | 99 | | |
78 | 100 | | |
| |||
Lines changed: 26 additions & 17 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
17 | 17 | | |
18 | 18 | | |
19 | 19 | | |
20 | | - | |
21 | | - | |
22 | | - | |
23 | | - | |
24 | | - | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
25 | 31 | | |
26 | 32 | | |
27 | | - | |
| 33 | + | |
28 | 34 | | |
29 | 35 | | |
30 | | - | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
31 | 41 | | |
32 | 42 | | |
33 | 43 | | |
34 | 44 | | |
35 | 45 | | |
36 | | - | |
37 | | - | |
38 | | - | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
39 | 52 | | |
40 | 53 | | |
41 | | - | |
42 | | - | |
43 | | - | |
44 | | - | |
45 | | - | |
46 | | - | |
47 | | - | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
48 | 57 | | |
49 | 58 | | |
50 | 59 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
174 | 174 | | |
175 | 175 | | |
176 | 176 | | |
| 177 | + | |
177 | 178 | | |
178 | 179 | | |
179 | 180 | | |
| |||
Lines changed: 2 additions & 8 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
12 | | - | |
13 | | - | |
14 | | - | |
15 | | - | |
| 12 | + | |
16 | 13 | | |
17 | 14 | | |
18 | 15 | | |
19 | 16 | | |
20 | | - | |
| 17 | + | |
21 | 18 | | |
22 | 19 | | |
23 | | - | |
24 | | - | |
25 | | - | |
26 | 20 | | |
27 | 21 | | |
28 | 22 | | |
| |||
0 commit comments