@hydranium/cli 1.0.0-next.23 → 1.0.0-next.230

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (179) hide show
  1. package/README.md +33 -15
  2. package/bin/hydranium-cli.js +13 -0
  3. package/lib/cli-version.js.map +1 -1
  4. package/lib/cli.js +0 -0
  5. package/lib/commands/analyze-heap-args.js.map +1 -1
  6. package/lib/commands/analyze-heap.d.ts +3 -0
  7. package/lib/commands/analyze-heap.d.ts.map +1 -1
  8. package/lib/commands/analyze-heap.js +2 -1
  9. package/lib/commands/analyze-heap.js.map +1 -1
  10. package/lib/commands/ast-ground-truth-args.d.ts +3 -2
  11. package/lib/commands/ast-ground-truth-args.d.ts.map +1 -1
  12. package/lib/commands/ast-ground-truth-args.js +11 -9
  13. package/lib/commands/ast-ground-truth-args.js.map +1 -1
  14. package/lib/commands/ast-ground-truth.js +1 -1
  15. package/lib/commands/ast-ground-truth.js.map +1 -1
  16. package/lib/commands/generate-ast-builder.d.ts +49 -0
  17. package/lib/commands/generate-ast-builder.d.ts.map +1 -0
  18. package/lib/commands/generate-ast-builder.js +200 -0
  19. package/lib/commands/generate-ast-builder.js.map +1 -0
  20. package/lib/commands/generate-transfer-model-args.d.ts.map +1 -1
  21. package/lib/commands/generate-transfer-model-args.js +11 -1
  22. package/lib/commands/generate-transfer-model-args.js.map +1 -1
  23. package/lib/commands/generate-transfer-model-config.d.ts.map +1 -1
  24. package/lib/commands/generate-transfer-model-config.js +3 -1
  25. package/lib/commands/generate-transfer-model-config.js.map +1 -1
  26. package/lib/commands/generate-transfer-model.d.ts +9 -0
  27. package/lib/commands/generate-transfer-model.d.ts.map +1 -1
  28. package/lib/commands/generate-transfer-model.js +16 -3
  29. package/lib/commands/generate-transfer-model.js.map +1 -1
  30. package/lib/commands/harness-args.d.ts +37 -42
  31. package/lib/commands/harness-args.d.ts.map +1 -1
  32. package/lib/commands/harness-args.js +65 -25
  33. package/lib/commands/harness-args.js.map +1 -1
  34. package/lib/commands/headless-harness.d.ts +37 -20
  35. package/lib/commands/headless-harness.d.ts.map +1 -1
  36. package/lib/commands/headless-harness.js +68 -17
  37. package/lib/commands/headless-harness.js.map +1 -1
  38. package/lib/commands/init-args.js +6 -6
  39. package/lib/commands/init-args.js.map +1 -1
  40. package/lib/commands/init-prompt.d.ts.map +1 -1
  41. package/lib/commands/init-templates.d.ts +8 -10
  42. package/lib/commands/init-templates.d.ts.map +1 -1
  43. package/lib/commands/init-templates.js +245 -140
  44. package/lib/commands/init-templates.js.map +1 -1
  45. package/lib/commands/init-wizard.js +4 -4
  46. package/lib/commands/init-wizard.js.map +1 -1
  47. package/lib/commands/init-workspace.d.ts +13 -3
  48. package/lib/commands/init-workspace.d.ts.map +1 -1
  49. package/lib/commands/init-workspace.js +21 -6
  50. package/lib/commands/init-workspace.js.map +1 -1
  51. package/lib/commands/init.d.ts +16 -10
  52. package/lib/commands/init.d.ts.map +1 -1
  53. package/lib/commands/init.js +17 -15
  54. package/lib/commands/init.js.map +1 -1
  55. package/lib/commands/lint-grammar-args.d.ts +3 -2
  56. package/lib/commands/lint-grammar-args.d.ts.map +1 -1
  57. package/lib/commands/lint-grammar-args.js +13 -10
  58. package/lib/commands/lint-grammar-args.js.map +1 -1
  59. package/lib/commands/lint-grammar-report.js.map +1 -1
  60. package/lib/commands/lint-grammar.js +1 -1
  61. package/lib/commands/lint-grammar.js.map +1 -1
  62. package/lib/commands/measure-memory-args.d.ts +3 -2
  63. package/lib/commands/measure-memory-args.d.ts.map +1 -1
  64. package/lib/commands/measure-memory-args.js +20 -10
  65. package/lib/commands/measure-memory-args.js.map +1 -1
  66. package/lib/commands/measure-memory-driver.js +3 -2
  67. package/lib/commands/measure-memory-driver.js.map +1 -1
  68. package/lib/commands/measure-memory.js +1 -1
  69. package/lib/commands/measure-memory.js.map +1 -1
  70. package/lib/commands/model-docs-args.d.ts +4 -3
  71. package/lib/commands/model-docs-args.d.ts.map +1 -1
  72. package/lib/commands/model-docs-args.js +12 -10
  73. package/lib/commands/model-docs-args.js.map +1 -1
  74. package/lib/commands/model-docs.js +1 -1
  75. package/lib/commands/model-docs.js.map +1 -1
  76. package/lib/commands/projects-args.d.ts.map +1 -1
  77. package/lib/commands/projects-args.js +5 -5
  78. package/lib/commands/projects-args.js.map +1 -1
  79. package/lib/commands/projects.d.ts +3 -4
  80. package/lib/commands/projects.d.ts.map +1 -1
  81. package/lib/commands/projects.js +2 -2
  82. package/lib/commands/projects.js.map +1 -1
  83. package/lib/commands/query-args.d.ts.map +1 -1
  84. package/lib/commands/query-args.js +5 -5
  85. package/lib/commands/query-args.js.map +1 -1
  86. package/lib/commands/query.d.ts +3 -4
  87. package/lib/commands/query.d.ts.map +1 -1
  88. package/lib/commands/query.js +2 -2
  89. package/lib/commands/query.js.map +1 -1
  90. package/lib/commands/reflect-args.d.ts +3 -2
  91. package/lib/commands/reflect-args.d.ts.map +1 -1
  92. package/lib/commands/reflect-args.js +13 -10
  93. package/lib/commands/reflect-args.js.map +1 -1
  94. package/lib/commands/reflect-report.js.map +1 -1
  95. package/lib/commands/reflect.js +1 -1
  96. package/lib/commands/reflect.js.map +1 -1
  97. package/lib/commands/save-args.d.ts.map +1 -1
  98. package/lib/commands/save-args.js +6 -4
  99. package/lib/commands/save-args.js.map +1 -1
  100. package/lib/commands/save.d.ts +8 -4
  101. package/lib/commands/save.d.ts.map +1 -1
  102. package/lib/commands/save.js +31 -6
  103. package/lib/commands/save.js.map +1 -1
  104. package/lib/commands/validate-args.d.ts +3 -2
  105. package/lib/commands/validate-args.d.ts.map +1 -1
  106. package/lib/commands/validate-args.js +13 -10
  107. package/lib/commands/validate-args.js.map +1 -1
  108. package/lib/commands/validate-report.js.map +1 -1
  109. package/lib/commands/validate.js +1 -1
  110. package/lib/commands/validate.js.map +1 -1
  111. package/lib/commands/watch-args.d.ts.map +1 -1
  112. package/lib/commands/watch-args.js +6 -4
  113. package/lib/commands/watch-args.js.map +1 -1
  114. package/lib/commands/watch.d.ts +3 -4
  115. package/lib/commands/watch.d.ts.map +1 -1
  116. package/lib/commands/watch.js +20 -2
  117. package/lib/commands/watch.js.map +1 -1
  118. package/lib/driver-heap.d.ts +52 -0
  119. package/lib/driver-heap.d.ts.map +1 -0
  120. package/lib/driver-heap.js +51 -0
  121. package/lib/driver-heap.js.map +1 -0
  122. package/lib/index.d.ts +1 -0
  123. package/lib/index.d.ts.map +1 -1
  124. package/lib/index.js +1 -0
  125. package/lib/index.js.map +1 -1
  126. package/lib/log-level.d.ts +21 -11
  127. package/lib/log-level.d.ts.map +1 -1
  128. package/lib/log-level.js +25 -14
  129. package/lib/log-level.js.map +1 -1
  130. package/lib/spawn-data-server.d.ts +6 -1
  131. package/lib/spawn-data-server.d.ts.map +1 -1
  132. package/lib/spawn-data-server.js +2 -1
  133. package/lib/spawn-data-server.js.map +1 -1
  134. package/lib/stderr-connection-logger.d.ts +12 -0
  135. package/lib/stderr-connection-logger.d.ts.map +1 -0
  136. package/lib/stderr-connection-logger.js +16 -0
  137. package/lib/stderr-connection-logger.js.map +1 -0
  138. package/lib/testing/echo-server.js +8 -1
  139. package/lib/testing/echo-server.js.map +1 -1
  140. package/package.json +39 -39
  141. package/src/commands/analyze-heap.ts +4 -1
  142. package/src/commands/ast-ground-truth-args.ts +15 -12
  143. package/src/commands/ast-ground-truth.ts +1 -1
  144. package/src/commands/generate-ast-builder.ts +246 -0
  145. package/src/commands/generate-transfer-model-args.ts +11 -1
  146. package/src/commands/generate-transfer-model-config.ts +3 -1
  147. package/src/commands/generate-transfer-model.ts +25 -3
  148. package/src/commands/harness-args.ts +73 -28
  149. package/src/commands/headless-harness.ts +86 -26
  150. package/src/commands/init-args.ts +6 -6
  151. package/src/commands/init-templates.ts +255 -142
  152. package/src/commands/init-wizard.ts +4 -4
  153. package/src/commands/init-workspace.ts +31 -7
  154. package/src/commands/init.ts +36 -26
  155. package/src/commands/lint-grammar-args.ts +17 -13
  156. package/src/commands/lint-grammar.ts +1 -1
  157. package/src/commands/measure-memory-args.ts +25 -13
  158. package/src/commands/measure-memory-driver.ts +3 -2
  159. package/src/commands/measure-memory.ts +1 -1
  160. package/src/commands/model-docs-args.ts +16 -13
  161. package/src/commands/model-docs.ts +1 -1
  162. package/src/commands/projects-args.ts +5 -4
  163. package/src/commands/projects.ts +4 -6
  164. package/src/commands/query-args.ts +5 -4
  165. package/src/commands/query.ts +4 -6
  166. package/src/commands/reflect-args.ts +17 -13
  167. package/src/commands/reflect.ts +1 -1
  168. package/src/commands/save-args.ts +6 -3
  169. package/src/commands/save.ts +49 -10
  170. package/src/commands/validate-args.ts +17 -13
  171. package/src/commands/validate.ts +1 -1
  172. package/src/commands/watch-args.ts +6 -3
  173. package/src/commands/watch.ts +28 -7
  174. package/src/driver-heap.ts +65 -0
  175. package/src/index.ts +1 -0
  176. package/src/log-level.ts +42 -14
  177. package/src/spawn-data-server.ts +14 -2
  178. package/src/stderr-connection-logger.ts +18 -0
  179. package/src/testing/echo-server.ts +10 -2
@@ -10,32 +10,34 @@
10
10
  import { runAstGroundTruth, type AstGroundTruthCommandOptions } from './ast-ground-truth.js';
11
11
  import {
12
12
  exitWithUsage,
13
+ HARNESS_VALUE_FLAGS,
13
14
  helpRequested,
14
- LOG_LEVEL_FLAG,
15
- logLevelHelpLine,
16
- logLevelOption,
15
+ importHelpLines,
16
+ LOG_VALUE_FLAGS,
17
+ logHelpLines,
18
+ logOptions,
17
19
  parseHarnessArgs,
18
20
  printHelp,
19
- SERVICES_FLAG,
20
21
  type UsageError
21
22
  } from './harness-args.js';
22
23
  import { OUT_FILE_FLAG } from './headless-harness.js';
23
24
 
24
- const VALUE_FLAGS = [OUT_FILE_FLAG, LOG_LEVEL_FLAG] as const;
25
+ const VALUE_FLAGS = [OUT_FILE_FLAG, ...LOG_VALUE_FLAGS] as const;
25
26
 
26
27
  /**
27
28
  * Every flag `ast-ground-truth` accepts, derived from the sets the parser is
28
- * handed so the list cannot claim a flag the parser would reject. `--services`
29
- * is consumed by the shared harness parser itself, so it is in neither set.
29
+ * handed so the list cannot claim a flag the parser would reject.
30
+ * {@link HARNESS_VALUE_FLAGS} are consumed by the shared harness parser itself,
31
+ * so they are in neither set.
30
32
  */
31
- export const AST_GROUND_TRUTH_FLAGS: readonly string[] = [SERVICES_FLAG, ...VALUE_FLAGS];
33
+ export const AST_GROUND_TRUTH_FLAGS: readonly string[] = [...HARNESS_VALUE_FLAGS, ...VALUE_FLAGS];
32
34
 
33
35
  /** The subset that takes a value, so `--help` in a value position reads as data. */
34
36
  export const AST_GROUND_TRUTH_VALUE_FLAGS: readonly string[] = AST_GROUND_TRUTH_FLAGS;
35
37
 
36
38
  /** The `--help` text, as data, held to {@link AST_GROUND_TRUTH_FLAGS} by a test. */
37
39
  export const AST_GROUND_TRUTH_HELP: readonly string[] = [
38
- 'Usage: hydranium-cli ast-ground-truth --services <module> <workspace> [--out-file <file>] [--log-level <lvl>]',
40
+ 'Usage: hydranium-cli ast-ground-truth --services <module> [--import <specifier>]... <workspace> [--out-file <file>] [--log-level <lvl>] [--log-file <file>] [--log-file-level <lvl>]',
39
41
  '',
40
42
  "Tally a workspace's live-model AST nodes by `$type` — the ground truth that",
41
43
  '`analyze-heap --validate <gt.json>` checks a heap snapshot against. `<module>`',
@@ -44,14 +46,15 @@ export const AST_GROUND_TRUTH_HELP: readonly string[] = [
44
46
  '',
45
47
  'Options:',
46
48
  ' --services <module> ESM module exporting `createServices(): { shared }` (required).',
49
+ ...importHelpLines(22),
47
50
  ' <workspace> Workspace root (path or file URI) to build (required).',
48
51
  ' --out-file <file> Write the JSON to this file instead of stdout.',
49
- logLevelHelpLine(22)
52
+ ...logHelpLines(22)
50
53
  ];
51
54
 
52
55
  export function parseAstGroundTruthArgs(args: string[], onError: UsageError = exitWithUsage): AstGroundTruthCommandOptions {
53
- const { servicesModule, workspace, options } = parseHarnessArgs(args, 'ast-ground-truth', VALUE_FLAGS, [], { onError });
54
- return { servicesModule, workspace, outFile: options[OUT_FILE_FLAG], logLevel: logLevelOption(options[LOG_LEVEL_FLAG]) };
56
+ const { servicesModule, imports, workspace, options } = parseHarnessArgs(args, 'ast-ground-truth', VALUE_FLAGS, [], { onError });
57
+ return { servicesModule, imports, workspace, outFile: options[OUT_FILE_FLAG], ...logOptions(options) };
55
58
  }
56
59
 
57
60
  export function runAstGroundTruthCommand(args: string[]): Promise<void> {
@@ -45,5 +45,5 @@ export function buildGroundTruthDriverArgs(options: AstGroundTruthCommandOptions
45
45
  * `--out-file`). No `--expose-gc` needed — this walks the AST, it does not weigh it.
46
46
  */
47
47
  export function runAstGroundTruth(options: AstGroundTruthCommandOptions): Promise<void> {
48
- return runDriverChild(['--max-old-space-size=8192', DRIVER, ...buildGroundTruthDriverArgs(options)], options);
48
+ return runDriverChild([DRIVER, ...buildGroundTruthDriverArgs(options)], options);
49
49
  }
@@ -0,0 +1,246 @@
1
+ /********************************************************************************
2
+ * Copyright (c) 2026 CrossBreeze, EclipseSource and others.
3
+ *
4
+ * This program and the accompanying materials are made available under the
5
+ * terms of the MIT License which is available in the project root.
6
+ *
7
+ * SPDX-License-Identifier: MIT
8
+ ********************************************************************************/
9
+
10
+ import * as fs from 'fs';
11
+ import * as path from 'path';
12
+ import type { SourceFile } from 'ts-morph';
13
+
14
+ /** Inputs for {@link emitAstBuilder}, resolved by the transfer-model command. */
15
+ export interface EmitAstBuilderOptions {
16
+ /** Destination path for the generated builder module. */
17
+ outFile: string;
18
+ /** Path to the Langium-generated AST file the builder imports from. */
19
+ astFile: string;
20
+ /** Language id derived from the `<LanguageId>AstReflection` class name. */
21
+ languageId: string;
22
+ /** Header line naming the command that regenerates the file. */
23
+ regenCommand: string;
24
+ }
25
+
26
+ /**
27
+ * A single `makeAstNodeBuilder` binding the generator emits.
28
+ *
29
+ * `typeMap` is the type expression handed to the generic — the whole-project
30
+ * alias for the merged binding, `<Namespace>.AstType` for a narrowed one.
31
+ */
32
+ interface BuilderBinding {
33
+ exportName: string;
34
+ typeMap: string;
35
+ /** Grammar this binding is narrowed to; absent on the merged binding. */
36
+ namespace?: string;
37
+ }
38
+
39
+ /**
40
+ * Langium declares this type alias inside each language's namespace in a
41
+ * multi-language project. Its presence is what marks a namespace as a grammar's
42
+ * type registry rather than an incidental one.
43
+ */
44
+ const NAMESPACED_AST_TYPE_NAME = 'AstType';
45
+
46
+ /** Export name of the merged, whole-project binding. */
47
+ const MERGED_EXPORT_NAME = 'astNode';
48
+
49
+ /**
50
+ * Emit a module binding {@link makeAstNodeBuilder} to a project's reflection,
51
+ * once per grammar plus once across all of them.
52
+ *
53
+ * **The binding is boilerplate with exactly one degree of freedom** — the type
54
+ * map — so hand-writing it buys nothing and goes stale the moment a grammar is
55
+ * added. Generating it is also the only way a narrowed binding can exist at all:
56
+ * the per-grammar type maps live in namespaces Langium emits only on its
57
+ * multi-language path, so a single-grammar project gets the merged binding alone
58
+ * and there is nothing to narrow.
59
+ *
60
+ * **A narrowed binding is only as narrow as its grammar's import closure.**
61
+ * Langium's per-grammar `AstType` lists everything REACHABLE from that grammar,
62
+ * so where one grammar imports all the others its map equals the project's and
63
+ * its binding checks nothing the merged one does not. The emitted doc says so at
64
+ * each declaration rather than promising a guarantee the type map cannot give.
65
+ *
66
+ * Answers `false` when the AST source declares no whole-project type alias,
67
+ * which means the file did not come from `langium generate` and the caller
68
+ * should report rather than write a module that cannot compile.
69
+ */
70
+ export function emitAstBuilder(astSource: SourceFile, options: EmitAstBuilderOptions): boolean {
71
+ const content = buildAstBuilderSource(astSource, options);
72
+ if (content === undefined) {
73
+ return false;
74
+ }
75
+
76
+ fs.mkdirSync(path.dirname(options.outFile), { recursive: true });
77
+ if (fs.existsSync(options.outFile) && fs.readFileSync(options.outFile, 'utf-8') === content) {
78
+ console.log('AST builder is up to date.');
79
+ return true;
80
+ }
81
+ fs.writeFileSync(options.outFile, content, 'utf-8');
82
+ console.log(`Generated: ${options.outFile}`);
83
+ return true;
84
+ }
85
+
86
+ /**
87
+ * The module text {@link emitAstBuilder} would write, or `undefined` when the
88
+ * AST source declares no whole-project type alias. Pure over its inputs, so the
89
+ * emitted shape is testable without touching a filesystem.
90
+ */
91
+ export function buildAstBuilderSource(astSource: SourceFile, options: EmitAstBuilderOptions): string | undefined {
92
+ const mergedTypeMap = `${options.languageId}AstType`;
93
+ if (!astSource.getTypeAlias(mergedTypeMap)) {
94
+ return undefined;
95
+ }
96
+
97
+ const bindings: BuilderBinding[] = [{ exportName: MERGED_EXPORT_NAME, typeMap: mergedTypeMap }];
98
+ for (const namespace of findGrammarNamespaces(astSource)) {
99
+ bindings.push({
100
+ exportName: builderExportName(namespace),
101
+ typeMap: `${namespace}.${NAMESPACED_AST_TYPE_NAME}`,
102
+ namespace
103
+ });
104
+ }
105
+ assertDistinctExportNames(bindings);
106
+
107
+ return renderAstBuilder(bindings, {
108
+ reflectionName: findReflectionConstName(astSource, options.languageId),
109
+ importPath: relativeImportPath(options.outFile, options.astFile),
110
+ regenCommand: options.regenCommand
111
+ });
112
+ }
113
+
114
+ /**
115
+ * Namespaces that carry a grammar's type registry, in declaration order.
116
+ *
117
+ * Keyed on the nested `AstType` alias rather than on the namespace being
118
+ * exported, because an adopter's augmentation can add namespaces to the same
119
+ * file for unrelated reasons and only the ones Langium emits per grammar have
120
+ * a type map to bind.
121
+ */
122
+ function findGrammarNamespaces(astSource: SourceFile): string[] {
123
+ const names: string[] = [];
124
+ for (const module of astSource.getModules()) {
125
+ const name = module.getName();
126
+ if (name && module.getTypeAlias(NAMESPACED_AST_TYPE_NAME)) {
127
+ names.push(name);
128
+ }
129
+ }
130
+ return names;
131
+ }
132
+
133
+ /**
134
+ * `Domain` → `domainNode`. Lower-cases the leading character only, so a grammar
135
+ * named `OrderFlow` reads as `orderFlowNode` rather than losing its word break.
136
+ */
137
+ function builderExportName(namespace: string): string {
138
+ return `${namespace.charAt(0).toLowerCase()}${namespace.slice(1)}Node`;
139
+ }
140
+
141
+ /**
142
+ * Two grammars whose names differ only in their leading character collapse to
143
+ * one export. Emitting anyway would silently drop a binding, so fail with both
144
+ * names rather than leave the caller to discover it at compile time.
145
+ */
146
+ function assertDistinctExportNames(bindings: readonly BuilderBinding[]): void {
147
+ const seen = new Map<string, string>();
148
+ for (const binding of bindings) {
149
+ const previous = seen.get(binding.exportName);
150
+ if (previous !== undefined) {
151
+ throw new Error(
152
+ `Cannot emit the AST builder: grammars '${previous}' and '${binding.namespace}' both map to the export ` +
153
+ `'${binding.exportName}'. Rename one grammar so the generated bindings stay distinct.`
154
+ );
155
+ }
156
+ seen.set(binding.exportName, binding.namespace ?? MERGED_EXPORT_NAME);
157
+ }
158
+ }
159
+
160
+ /**
161
+ * Name of the const holding the project's reflection instance.
162
+ *
163
+ * Langium emits `export const reflection = new <LanguageId>AstReflection()`, but
164
+ * the const is located by its initializer rather than by that name so a renamed
165
+ * export still resolves. Falls back to the emitted default when no declaration
166
+ * matches, which keeps the output compiling against a stock Langium file.
167
+ */
168
+ function findReflectionConstName(astSource: SourceFile, languageId: string): string {
169
+ const reflectionClass = `${languageId}AstReflection`;
170
+ for (const declaration of astSource.getVariableDeclarations()) {
171
+ if (declaration.getInitializer()?.getText().replace(/\s/g, '') === `new${reflectionClass}()`) {
172
+ return declaration.getName();
173
+ }
174
+ }
175
+ return 'reflection';
176
+ }
177
+
178
+ /**
179
+ * Module specifier for the AST file as seen from the generated module's own
180
+ * directory. Emitted with a `.js` extension and posix separators because the
181
+ * output is ESM TypeScript, where the specifier names the compiled sibling.
182
+ */
183
+ function relativeImportPath(outFile: string, astFile: string): string {
184
+ const relative = path.relative(path.dirname(path.resolve(outFile)), path.resolve(astFile));
185
+ const posix = relative.split(path.sep).join('/').replace(/\.ts$/, '.js');
186
+ return posix.startsWith('.') ? posix : `./${posix}`;
187
+ }
188
+
189
+ function renderAstBuilder(
190
+ bindings: readonly BuilderBinding[],
191
+ context: { reflectionName: string; importPath: string; regenCommand: string }
192
+ ): string {
193
+ const imported = [context.reflectionName, ...bindings.map(binding => `type ${binding.namespace ?? binding.typeMap}`)];
194
+ const out: string[] = [];
195
+
196
+ out.push('/******************************************************************************');
197
+ out.push(' * Generated from the Langium AST — DO NOT EDIT MANUALLY!');
198
+ out.push(` * ${context.regenCommand}`);
199
+ out.push(' ******************************************************************************/');
200
+ out.push('');
201
+ out.push('/* eslint-disable */');
202
+ out.push('');
203
+ out.push("import { makeAstNodeBuilder } from '@hydranium/core';");
204
+ out.push(`import { ${imported.join(', ')} } from '${context.importPath}';`);
205
+ out.push('');
206
+
207
+ // A single-grammar project has nothing to narrow to, so the merged binding is
208
+ // simply THE binding there and must not point at a sibling that was not emitted.
209
+ const narrowed = bindings.some(binding => binding.namespace !== undefined);
210
+ const guarantee = [
211
+ ' * Mandatory fields are a type error at the call site, and grammar-declared',
212
+ ' * containment arrays are materialised from reflection metadata, so a built',
213
+ ' * node carries `[]` where a cast literal would leave `undefined`.'
214
+ ];
215
+
216
+ for (const binding of bindings) {
217
+ out.push('/**');
218
+ if (binding.namespace !== undefined) {
219
+ out.push(` * AST-node factory narrowed to the '${binding.namespace}' grammar.`);
220
+ out.push(' *');
221
+ out.push(' * Narrowed by grammar REACHABILITY, not by ownership: a grammar that');
222
+ out.push(" * imports another sees that one's types too, so this binding is only as");
223
+ out.push(` * narrow as '${binding.namespace}'s import closure. Where that closure is the`);
224
+ out.push(' * whole project, it accepts exactly what the merged binding does and the');
225
+ out.push(' * choice is documentation rather than a check.');
226
+ out.push(' *');
227
+ out.push(...guarantee);
228
+ } else if (narrowed) {
229
+ out.push(' * AST-node factory spanning every grammar in this project.');
230
+ out.push(' *');
231
+ out.push(' * Prefer the narrowed binding matching the grammar the call site works in:');
232
+ out.push(" * it rejects a type outside that grammar's import closure, which this one");
233
+ out.push(' * accepts from anywhere. Reach for this one where a call site genuinely');
234
+ out.push(' * spans grammars.');
235
+ } else {
236
+ out.push(" * AST-node factory for this project's grammar.");
237
+ out.push(' *');
238
+ out.push(...guarantee);
239
+ }
240
+ out.push(' */');
241
+ out.push(`export const ${binding.exportName} = makeAstNodeBuilder<${binding.typeMap}>(${context.reflectionName});`);
242
+ out.push('');
243
+ }
244
+
245
+ return out.join('\n');
246
+ }
@@ -29,6 +29,7 @@ export const GENERATE_TRANSFER_MODEL_FLAGS: readonly string[] = [
29
29
  '--ast-file',
30
30
  '--augmentation-file',
31
31
  '--out-file',
32
+ '--ast-builder-file',
32
33
  '--element-type-name',
33
34
  '--terminals-name',
34
35
  '--terminals-source-name',
@@ -48,7 +49,8 @@ export const GENERATE_TRANSFER_MODEL_VALUE_FLAGS: readonly string[] = GENERATE_T
48
49
  export const GENERATE_TRANSFER_MODEL_HELP: readonly string[] = [
49
50
  'Usage: hydranium-cli generate-transfer-model [options]',
50
51
  '',
51
- 'Generate a serializable transfer-model TypeScript file from a Langium AST. The',
52
+ 'Generate a serializable transfer-model TypeScript file from a Langium AST, and',
53
+ 'optionally an AST-node builder module bound to the same reflection. The',
52
54
  'required inputs (--ast-file / --augmentation-file / --out-file) may instead come',
53
55
  'from a --config JSON file, and --ast-file can be auto-discovered from a Langium',
54
56
  "config's `out` directory. Precedence, highest first: explicit flags, then the",
@@ -67,6 +69,11 @@ export const GENERATE_TRANSFER_MODEL_HELP: readonly string[] = [
67
69
  ' directory: it treats that directory as exclusively',
68
70
  ' its own, so every `langium generate` reports this',
69
71
  ' file as unexpected and offers to delete it.',
72
+ ' --ast-builder-file <path> Also emit an AST-node builder module here: one',
73
+ ' makeAstNodeBuilder binding per grammar, plus one',
74
+ ' spanning all of them. Omit if nothing constructs',
75
+ ' AST nodes. Same restriction as --out-file: keep it',
76
+ " out of langium-cli's own `out` directory.",
70
77
  ' --element-type-name <name> Base element type name in output. Default: TransferElement.',
71
78
  ' --terminals-name <name> Terminals const name in output. Default: ModelTerminals.',
72
79
  ' --terminals-source-name <n> Source-side terminals variable name. Default: <LanguageId>Terminals.',
@@ -120,6 +127,9 @@ export function parseGenerateOptions(args: string[], onError: UsageError = exitW
120
127
  case '--out-file':
121
128
  flags.outFile = next();
122
129
  break;
130
+ case '--ast-builder-file':
131
+ flags.astBuilderFile = next();
132
+ break;
123
133
  case '--element-type-name':
124
134
  flags.elementTypeName = next();
125
135
  break;
@@ -12,7 +12,7 @@ import * as path from 'node:path';
12
12
  import type { GenerateTransferModelOptions } from './generate-transfer-model.js';
13
13
 
14
14
  /** Path-valued option keys — resolved relative to a config/langium-config file's directory. */
15
- const PATH_KEYS = ['astFile', 'augmentationFile', 'outFile'] as const;
15
+ const PATH_KEYS = ['astFile', 'augmentationFile', 'outFile', 'astBuilderFile'] as const;
16
16
 
17
17
  /** Resolve `value` against `baseDir` when it is relative; absolute paths pass through. */
18
18
  function resolveAgainst(baseDir: string, value: string): string {
@@ -43,6 +43,7 @@ export function loadTransferModelConfig(configPath: string): Partial<GenerateTra
43
43
  'astFile',
44
44
  'augmentationFile',
45
45
  'outFile',
46
+ 'astBuilderFile',
46
47
  'elementTypeName',
47
48
  'terminalsName',
48
49
  'terminalsSourceName',
@@ -118,6 +119,7 @@ export function mergeTransferModelOptions(...sources: Array<Partial<GenerateTran
118
119
  astFile: astFile!,
119
120
  augmentationFile: augmentationFile!,
120
121
  outFile: outFile!,
122
+ astBuilderFile: pick('astBuilderFile'),
121
123
  elementTypeName: pick('elementTypeName'),
122
124
  terminalsName: pick('terminalsName'),
123
125
  terminalsSourceName: pick('terminalsSourceName'),
@@ -9,6 +9,7 @@
9
9
 
10
10
  import * as fs from 'fs';
11
11
  import * as path from 'path';
12
+ import { emitAstBuilder } from './generate-ast-builder.js';
12
13
  import {
13
14
  type Node,
14
15
  type ObjectLiteralExpression,
@@ -35,6 +36,15 @@ export interface GenerateTransferModelOptions {
35
36
  augmentationFile: string;
36
37
  /** Destination path for the generated transfer model. */
37
38
  outFile: string;
39
+ /**
40
+ * Destination for a generated AST-node builder module. Omitted by consumers
41
+ * that construct no AST nodes; the transfer model is emitted either way.
42
+ *
43
+ * Emitted from this command rather than its own because the AST source is
44
+ * already parsed here, and because a consumer that regenerates one artefact
45
+ * and not the other has the two disagreeing about the same grammar.
46
+ */
47
+ astBuilderFile?: string;
38
48
  /** Name used for the base element type in the output. Defaults to `TransferElement`. */
39
49
  elementTypeName?: string;
40
50
  /** Name used for the terminal-patterns const in the output. Defaults to `ModelTerminals`. */
@@ -396,10 +406,22 @@ export function generateTransferModel(options: GenerateTransferModelOptions): vo
396
406
  fs.mkdirSync(path.dirname(options.outFile), { recursive: true });
397
407
  if (fs.existsSync(options.outFile) && fs.readFileSync(options.outFile, 'utf-8') === content) {
398
408
  console.log('Transfer model is up to date.');
399
- return;
409
+ } else {
410
+ fs.writeFileSync(options.outFile, content, 'utf-8');
411
+ console.log(`Generated: ${options.outFile}`);
412
+ }
413
+
414
+ if (options.astBuilderFile !== undefined) {
415
+ const emitted = emitAstBuilder(astSource, {
416
+ outFile: options.astBuilderFile,
417
+ astFile: options.astFile,
418
+ languageId,
419
+ regenCommand
420
+ });
421
+ if (!emitted) {
422
+ console.warn(`Warning: no '${languageId}AstType' alias in ${options.astFile}; skipping the AST builder.`);
423
+ }
400
424
  }
401
- fs.writeFileSync(options.outFile, content, 'utf-8');
402
- console.log(`Generated: ${options.outFile}`);
403
425
  }
404
426
 
405
427
  // ---------------------------------------------------------------------------
@@ -35,7 +35,7 @@ import type { LogThreshold } from '@hydranium/protocol';
35
35
  import { statSync } from 'node:fs';
36
36
  import * as path from 'node:path';
37
37
  import { fileURLToPath } from 'node:url';
38
- import { parseLogLevelOption } from '../log-level.js';
38
+ import { type LogOptions, parseLogLevelOption } from '../log-level.js';
39
39
 
40
40
  /**
41
41
  * How a parser reports a usage problem. It never returns, so a parser can treat
@@ -56,9 +56,18 @@ export function exitWithUsage(message: string): never {
56
56
  process.exit(2);
57
57
  }
58
58
 
59
- /** The value flag {@link parseHarnessArgs} consumes itself, before any the subcommand declares. */
59
+ /** Names the head's services module; every harness subcommand requires it. */
60
60
  export const SERVICES_FLAG = '--services';
61
61
 
62
+ /**
63
+ * Registers a loader in the driver child that imports the head. The child is a
64
+ * fresh `node`, so a loader registered on the CLI's own process never reaches it.
65
+ */
66
+ export const IMPORT_FLAG = '--import';
67
+
68
+ /** The value flags {@link parseHarnessArgs} consumes itself, before any the subcommand declares. */
69
+ export const HARNESS_VALUE_FLAGS = [SERVICES_FLAG, IMPORT_FLAG] as const;
70
+
62
71
  /**
63
72
  * The one spelling of the log threshold, shared by both subcommand families.
64
73
  *
@@ -68,33 +77,64 @@ export const SERVICES_FLAG = '--services';
68
77
  * on which command a caller happened to reach for.
69
78
  */
70
79
  export const LOG_LEVEL_FLAG = '--log-level';
80
+ export const LOG_FILE_FLAG = '--log-file';
81
+ export const LOG_FILE_LEVEL_FLAG = '--log-file-level';
82
+
83
+ /** The log flags every subcommand takes, read by {@link logOptions}. */
84
+ export const LOG_VALUE_FLAGS = [LOG_LEVEL_FLAG, LOG_FILE_FLAG, LOG_FILE_LEVEL_FLAG] as const;
71
85
 
72
86
  /** The value flags {@link parseServerSpawnOptions} consumes itself. */
73
- export const SERVER_SPAWN_VALUE_FLAGS: readonly string[] = ['--server', '--cwd', LOG_LEVEL_FLAG];
87
+ export const SERVER_SPAWN_VALUE_FLAGS: readonly string[] = ['--server', '--cwd', ...LOG_VALUE_FLAGS];
74
88
 
75
89
  /**
76
- * The `--help` line every subcommand describes {@link LOG_LEVEL_FLAG} with.
90
+ * The `--help` lines every subcommand describes {@link LOG_VALUE_FLAGS} with.
77
91
  *
78
92
  * Shared text, per-command padding: `command-args.test.ts` compares the flags a
79
93
  * help block DESCRIBES against the flags the parser accepts, and it recognises a
80
- * description by the two-space indent — so the line has to be a real option entry
94
+ * description by the two-space indent — so each line has to be a real option entry
81
95
  * in each block, and the column each block aligns its descriptions at is the
82
- * block's own.
96
+ * block's own. A flag too wide for that column takes its description on the
97
+ * next line, at the column.
83
98
  */
84
- export function logLevelHelpLine(padTo: number): string {
85
- return ` ${`${LOG_LEVEL_FLAG} <lvl>`.padEnd(padTo)}Log threshold for the head this boots (off|error|warn|info|debug|trace).`;
99
+ export function logHelpLines(padTo: number, head = 'the head this boots'): string[] {
100
+ return [
101
+ helpLine(`${LOG_LEVEL_FLAG} <lvl>`, `Log threshold for ${head} (off|error|warn|info|debug|trace).`, padTo),
102
+ helpLine(`${LOG_FILE_FLAG} <file>`, `Also write ${head}'s log to <file>; {workspace} expands to the workspace.`, padTo),
103
+ helpLine(`${LOG_FILE_LEVEL_FLAG} <lvl>`, `Threshold for that file, which the log-level setting does not change.`, padTo)
104
+ ].flat();
105
+ }
106
+
107
+ /** The `--help` lines every `--services` subcommand describes {@link IMPORT_FLAG} with, aligned as {@link logHelpLines}. */
108
+ export function importHelpLines(padTo: number): string[] {
109
+ return helpLine(`${IMPORT_FLAG} <specifier>`, 'Loader to register before importing <module>, e.g. tsx (repeatable).', padTo);
110
+ }
111
+
112
+ function helpLine(flag: string, text: string, padTo: number): string[] {
113
+ return flag.length < padTo - 1 ? [` ${flag.padEnd(padTo)}${text}`] : [` ${flag}`, `${' '.repeat(padTo + 2)}${text}`];
86
114
  }
87
115
 
88
116
  /**
89
- * Narrow a raw {@link LOG_LEVEL_FLAG} value that {@link parseHarnessArgs}
90
- * collected, leaving an absent flag absent.
117
+ * Narrow the raw {@link LOG_VALUE_FLAGS} values a parser collected, leaving
118
+ * absent flags absent.
119
+ *
120
+ * `--log-file` resolves against the caller's directory: the child may run
121
+ * elsewhere (`--cwd`), and a relative path would land the log there.
91
122
  *
92
123
  * Throws rather than reaching `onError`, matching {@link parseServerSpawnOptions}:
93
124
  * the level vocabulary belongs to the protocol package, which reports it, and the
94
125
  * entry point's catch turns that into the same message-and-exit.
95
126
  */
96
- export function logLevelOption(value: string | undefined): LogThreshold | undefined {
97
- return value === undefined ? undefined : parseLogLevelOption(value);
127
+ export function logOptions(options: Readonly<Record<string, string | undefined>>): LogOptions {
128
+ const level = (flag: string): LogThreshold | undefined => {
129
+ const value = options[flag];
130
+ return value === undefined ? undefined : parseLogLevelOption(value, flag);
131
+ };
132
+ const logFile = options[LOG_FILE_FLAG];
133
+ return {
134
+ logLevel: level(LOG_LEVEL_FLAG),
135
+ logFile: logFile === undefined ? undefined : path.resolve(logFile),
136
+ logFileLevel: level(LOG_FILE_LEVEL_FLAG)
137
+ };
98
138
  }
99
139
 
100
140
  /**
@@ -134,6 +174,8 @@ export function printHelp(lines: readonly string[]): void {
134
174
  /** What {@link parseHarnessArgs} recovered from an argv. */
135
175
  export interface ParsedHarnessArgs {
136
176
  servicesModule: string;
177
+ /** The {@link IMPORT_FLAG} values in the order given, absent when there were none. */
178
+ imports?: string[];
137
179
  /**
138
180
  * An absolute directory path, resolved by {@link resolveWorkspaceArgument} and
139
181
  * checked to exist. `''` when the subcommand declared `requireWorkspace: false`.
@@ -163,12 +205,12 @@ export interface HarnessArgsConfig {
163
205
 
164
206
  /**
165
207
  * Shared parser for the headless-harness subcommands. Consumes the required
166
- * `--services <module>` value flag and a single positional `<workspace>`, plus
167
- * the `valueFlags` (each takes a value) and `boolFlags` (presence-only, recorded
168
- * as `'true'`) the subcommand recognises. Unknown flags or a missing
169
- * `--services`/`<workspace>` are usage errors, and so is a `<workspace>` that
170
- * reaches no directory — see {@link resolveWorkspaceArgument} for why that cannot
171
- * be left to the run.
208
+ * `--services <module>` value flag, the repeatable `--import <specifier>` and a
209
+ * single positional `<workspace>`, plus the `valueFlags` (each takes a value)
210
+ * and `boolFlags` (presence-only, recorded as `'true'`) the subcommand
211
+ * recognises. Unknown flags or a missing `--services`/`<workspace>` are usage
212
+ * errors, and so is a `<workspace>` that reaches no directory — see
213
+ * {@link resolveWorkspaceArgument} for why that cannot be left to the run.
172
214
  */
173
215
  export function parseHarnessArgs(
174
216
  args: string[],
@@ -185,6 +227,7 @@ export function parseHarnessArgs(
185
227
  const options: Record<string, string | undefined> = {};
186
228
  const values: Record<string, string[]> = {};
187
229
  let servicesModule: string | undefined;
230
+ let imports: string[] | undefined;
188
231
  let workspace: string | undefined;
189
232
  for (let index = 0; index < args.length; index += 1) {
190
233
  const flag = args[index];
@@ -196,8 +239,10 @@ export function parseHarnessArgs(
196
239
  index += 1;
197
240
  return value;
198
241
  };
199
- if (flag === '--services') {
242
+ if (flag === SERVICES_FLAG) {
200
243
  servicesModule = next();
244
+ } else if (flag === IMPORT_FLAG) {
245
+ (imports ??= []).push(next());
201
246
  } else if (boolSet.has(flag)) {
202
247
  options[flag] = 'true';
203
248
  } else if (repeatableSet.has(flag)) {
@@ -213,7 +258,8 @@ export function parseHarnessArgs(
213
258
  }
214
259
  }
215
260
  return {
216
- servicesModule: assertRequired(servicesModule, '--services', commandName, onError),
261
+ servicesModule: assertRequired(servicesModule, SERVICES_FLAG, commandName, onError),
262
+ imports,
217
263
  workspace: requireWorkspace
218
264
  ? resolveWorkspaceArgument(assertRequired(workspace, '<workspace>', commandName, onError), commandName, onError)
219
265
  : (workspace ?? ''),
@@ -336,11 +382,10 @@ function kebabToCamel(name: string): string {
336
382
  }
337
383
 
338
384
  /** What {@link parseServerSpawnOptions} recovered from an argv. */
339
- export interface SpawnOptions {
385
+ export interface SpawnOptions extends LogOptions {
340
386
  serverCommand: string;
341
387
  serverArgs: string[];
342
388
  cwd?: string;
343
- logLevel?: LogThreshold;
344
389
  /** The tokens this parser did not claim, for the subcommand's own options. */
345
390
  extra: string[];
346
391
  }
@@ -363,10 +408,10 @@ function isRelativePathToken(token: string, isCommand: boolean): boolean {
363
408
 
364
409
  /**
365
410
  * Shared option parser for subcommands that spawn a data-server child. Consumes
366
- * `--server` / `--cwd` / `--log-level` and returns the surviving tokens as
411
+ * `--server` / `--cwd` / the {@link LOG_VALUE_FLAGS} and returns the surviving tokens as
367
412
  * `extra` for {@link parseFlagOptions} to finish.
368
413
  *
369
- * An unrecognised `--log-level` value throws rather than reaching `onError`: the
414
+ * An unrecognised log level value throws rather than reaching `onError`: the
370
415
  * level vocabulary belongs to the protocol package, which reports it, and the
371
416
  * entry point's catch turns that into the same message-and-exit.
372
417
  *
@@ -383,7 +428,7 @@ function isRelativePathToken(token: string, isCommand: boolean): boolean {
383
428
  export function parseServerSpawnOptions(args: string[], commandName: string, onError: UsageError = exitWithUsage): SpawnOptions {
384
429
  let serverSpec: string | undefined;
385
430
  let cwd: string | undefined;
386
- let logLevel: LogThreshold | undefined;
431
+ const logFlags: Record<string, string> = {};
387
432
  const extra: string[] = [];
388
433
  for (let index = 0; index < args.length; index += 1) {
389
434
  const flag = args[index];
@@ -399,8 +444,8 @@ export function parseServerSpawnOptions(args: string[], commandName: string, onE
399
444
  serverSpec = claim();
400
445
  } else if (flag === '--cwd') {
401
446
  cwd = claim();
402
- } else if (flag === LOG_LEVEL_FLAG) {
403
- logLevel = parseLogLevelOption(claim());
447
+ } else if ((LOG_VALUE_FLAGS as readonly string[]).includes(flag)) {
448
+ logFlags[flag] = claim();
404
449
  } else {
405
450
  extra.push(flag);
406
451
  }
@@ -425,5 +470,5 @@ export function parseServerSpawnOptions(args: string[], commandName: string, onE
425
470
  );
426
471
  }
427
472
  }
428
- return { serverCommand, serverArgs, cwd, logLevel, extra };
473
+ return { serverCommand, serverArgs, cwd, ...logOptions(logFlags), extra };
429
474
  }