@hydranium/cli 1.0.0-next.31 → 1.0.0-next.312

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 (252) hide show
  1. package/README.md +79 -205
  2. package/bin/hydranium-cli.js +13 -0
  3. package/heap-analysis/heap/core/load.mjs +2 -2
  4. package/lib/cli-version.js.map +1 -1
  5. package/lib/cli.js +7 -2
  6. package/lib/cli.js.map +1 -1
  7. package/lib/commands/analyze-heap-args.js.map +1 -1
  8. package/lib/commands/analyze-heap.d.ts +3 -0
  9. package/lib/commands/analyze-heap.d.ts.map +1 -1
  10. package/lib/commands/analyze-heap.js +2 -1
  11. package/lib/commands/analyze-heap.js.map +1 -1
  12. package/lib/commands/ast-ground-truth-args.d.ts +3 -2
  13. package/lib/commands/ast-ground-truth-args.d.ts.map +1 -1
  14. package/lib/commands/ast-ground-truth-args.js +11 -9
  15. package/lib/commands/ast-ground-truth-args.js.map +1 -1
  16. package/lib/commands/ast-ground-truth-driver.js +2 -1
  17. package/lib/commands/ast-ground-truth-driver.js.map +1 -1
  18. package/lib/commands/ast-ground-truth.js +1 -1
  19. package/lib/commands/ast-ground-truth.js.map +1 -1
  20. package/lib/commands/client-session.d.ts +17 -0
  21. package/lib/commands/client-session.d.ts.map +1 -0
  22. package/lib/commands/client-session.js +27 -0
  23. package/lib/commands/client-session.js.map +1 -0
  24. package/lib/commands/create-args.d.ts +17 -0
  25. package/lib/commands/create-args.d.ts.map +1 -0
  26. package/lib/commands/create-args.js +53 -0
  27. package/lib/commands/create-args.js.map +1 -0
  28. package/lib/commands/create.d.ts +38 -0
  29. package/lib/commands/create.d.ts.map +1 -0
  30. package/lib/commands/create.js +43 -0
  31. package/lib/commands/create.js.map +1 -0
  32. package/lib/commands/delete-args.d.ts +17 -0
  33. package/lib/commands/delete-args.d.ts.map +1 -0
  34. package/lib/commands/delete-args.js +49 -0
  35. package/lib/commands/delete-args.js.map +1 -0
  36. package/lib/commands/delete.d.ts +30 -0
  37. package/lib/commands/delete.d.ts.map +1 -0
  38. package/lib/commands/delete.js +32 -0
  39. package/lib/commands/delete.js.map +1 -0
  40. package/lib/commands/generate-languages.d.ts +35 -0
  41. package/lib/commands/generate-languages.d.ts.map +1 -0
  42. package/lib/commands/generate-languages.js +105 -0
  43. package/lib/commands/generate-languages.js.map +1 -0
  44. package/lib/commands/generate-transfer-model-args.d.ts.map +1 -1
  45. package/lib/commands/generate-transfer-model-args.js +7 -0
  46. package/lib/commands/generate-transfer-model-args.js.map +1 -1
  47. package/lib/commands/generate-transfer-model-config.d.ts.map +1 -1
  48. package/lib/commands/generate-transfer-model-config.js +6 -3
  49. package/lib/commands/generate-transfer-model-config.js.map +1 -1
  50. package/lib/commands/generate-transfer-model.d.ts +15 -1
  51. package/lib/commands/generate-transfer-model.d.ts.map +1 -1
  52. package/lib/commands/generate-transfer-model.js +46 -8
  53. package/lib/commands/generate-transfer-model.js.map +1 -1
  54. package/lib/commands/harness-args.d.ts +44 -42
  55. package/lib/commands/harness-args.d.ts.map +1 -1
  56. package/lib/commands/harness-args.js +109 -27
  57. package/lib/commands/harness-args.js.map +1 -1
  58. package/lib/commands/headless-harness.d.ts +37 -20
  59. package/lib/commands/headless-harness.d.ts.map +1 -1
  60. package/lib/commands/headless-harness.js +68 -17
  61. package/lib/commands/headless-harness.js.map +1 -1
  62. package/lib/commands/init-args.d.ts.map +1 -1
  63. package/lib/commands/init-args.js +32 -27
  64. package/lib/commands/init-args.js.map +1 -1
  65. package/lib/commands/init-prompt.d.ts +3 -3
  66. package/lib/commands/init-prompt.d.ts.map +1 -1
  67. package/lib/commands/init-prompt.js +4 -5
  68. package/lib/commands/init-prompt.js.map +1 -1
  69. package/lib/commands/init-templates.d.ts +18 -14
  70. package/lib/commands/init-templates.d.ts.map +1 -1
  71. package/lib/commands/init-templates.js +732 -677
  72. package/lib/commands/init-templates.js.map +1 -1
  73. package/lib/commands/init-wizard.d.ts.map +1 -1
  74. package/lib/commands/init-wizard.js +17 -27
  75. package/lib/commands/init-wizard.js.map +1 -1
  76. package/lib/commands/init-workspace.d.ts +13 -11
  77. package/lib/commands/init-workspace.d.ts.map +1 -1
  78. package/lib/commands/init-workspace.js +21 -7
  79. package/lib/commands/init-workspace.js.map +1 -1
  80. package/lib/commands/init.d.ts +45 -19
  81. package/lib/commands/init.d.ts.map +1 -1
  82. package/lib/commands/init.js +80 -43
  83. package/lib/commands/init.js.map +1 -1
  84. package/lib/commands/kebab.d.ts +15 -0
  85. package/lib/commands/kebab.d.ts.map +1 -0
  86. package/lib/commands/kebab.js +17 -0
  87. package/lib/commands/kebab.js.map +1 -0
  88. package/lib/commands/lint-grammar-args.d.ts +3 -2
  89. package/lib/commands/lint-grammar-args.d.ts.map +1 -1
  90. package/lib/commands/lint-grammar-args.js +13 -10
  91. package/lib/commands/lint-grammar-args.js.map +1 -1
  92. package/lib/commands/lint-grammar-driver.js +2 -1
  93. package/lib/commands/lint-grammar-driver.js.map +1 -1
  94. package/lib/commands/lint-grammar-report.js.map +1 -1
  95. package/lib/commands/lint-grammar.js +1 -1
  96. package/lib/commands/lint-grammar.js.map +1 -1
  97. package/lib/commands/measure-memory-args.d.ts +3 -2
  98. package/lib/commands/measure-memory-args.d.ts.map +1 -1
  99. package/lib/commands/measure-memory-args.js +22 -11
  100. package/lib/commands/measure-memory-args.js.map +1 -1
  101. package/lib/commands/measure-memory-driver.js +5 -3
  102. package/lib/commands/measure-memory-driver.js.map +1 -1
  103. package/lib/commands/measure-memory.js +1 -1
  104. package/lib/commands/measure-memory.js.map +1 -1
  105. package/lib/commands/model-docs-args.d.ts +4 -3
  106. package/lib/commands/model-docs-args.d.ts.map +1 -1
  107. package/lib/commands/model-docs-args.js +12 -10
  108. package/lib/commands/model-docs-args.js.map +1 -1
  109. package/lib/commands/model-docs-driver.js +2 -1
  110. package/lib/commands/model-docs-driver.js.map +1 -1
  111. package/lib/commands/model-docs.js +1 -1
  112. package/lib/commands/model-docs.js.map +1 -1
  113. package/lib/commands/projects-args.d.ts.map +1 -1
  114. package/lib/commands/projects-args.js +5 -5
  115. package/lib/commands/projects-args.js.map +1 -1
  116. package/lib/commands/projects.d.ts +3 -4
  117. package/lib/commands/projects.d.ts.map +1 -1
  118. package/lib/commands/projects.js +2 -2
  119. package/lib/commands/projects.js.map +1 -1
  120. package/lib/commands/query-args.d.ts.map +1 -1
  121. package/lib/commands/query-args.js +5 -5
  122. package/lib/commands/query-args.js.map +1 -1
  123. package/lib/commands/query.d.ts +3 -4
  124. package/lib/commands/query.d.ts.map +1 -1
  125. package/lib/commands/query.js +2 -2
  126. package/lib/commands/query.js.map +1 -1
  127. package/lib/commands/reflect-args.d.ts +3 -2
  128. package/lib/commands/reflect-args.d.ts.map +1 -1
  129. package/lib/commands/reflect-args.js +13 -10
  130. package/lib/commands/reflect-args.js.map +1 -1
  131. package/lib/commands/reflect-driver.js +2 -1
  132. package/lib/commands/reflect-driver.js.map +1 -1
  133. package/lib/commands/reflect-report.js.map +1 -1
  134. package/lib/commands/reflect.js +1 -1
  135. package/lib/commands/reflect.js.map +1 -1
  136. package/lib/commands/save-args.d.ts.map +1 -1
  137. package/lib/commands/save-args.js +7 -4
  138. package/lib/commands/save-args.js.map +1 -1
  139. package/lib/commands/save.d.ts +8 -4
  140. package/lib/commands/save.d.ts.map +1 -1
  141. package/lib/commands/save.js +12 -23
  142. package/lib/commands/save.js.map +1 -1
  143. package/lib/commands/validate-args.d.ts +3 -2
  144. package/lib/commands/validate-args.d.ts.map +1 -1
  145. package/lib/commands/validate-args.js +13 -10
  146. package/lib/commands/validate-args.js.map +1 -1
  147. package/lib/commands/validate-driver.js +2 -1
  148. package/lib/commands/validate-driver.js.map +1 -1
  149. package/lib/commands/validate-report.js.map +1 -1
  150. package/lib/commands/validate.js +1 -1
  151. package/lib/commands/validate.js.map +1 -1
  152. package/lib/commands/watch-args.d.ts.map +1 -1
  153. package/lib/commands/watch-args.js +6 -4
  154. package/lib/commands/watch-args.js.map +1 -1
  155. package/lib/commands/watch.d.ts +3 -4
  156. package/lib/commands/watch.d.ts.map +1 -1
  157. package/lib/commands/watch.js +20 -2
  158. package/lib/commands/watch.js.map +1 -1
  159. package/lib/driver-heap.d.ts +52 -0
  160. package/lib/driver-heap.d.ts.map +1 -0
  161. package/lib/driver-heap.js +51 -0
  162. package/lib/driver-heap.js.map +1 -0
  163. package/lib/index.d.ts +2 -0
  164. package/lib/index.d.ts.map +1 -1
  165. package/lib/index.js +2 -0
  166. package/lib/index.js.map +1 -1
  167. package/lib/log-level.d.ts +21 -11
  168. package/lib/log-level.d.ts.map +1 -1
  169. package/lib/log-level.js +25 -14
  170. package/lib/log-level.js.map +1 -1
  171. package/lib/spawn-data-server.d.ts +9 -4
  172. package/lib/spawn-data-server.d.ts.map +1 -1
  173. package/lib/spawn-data-server.js +5 -4
  174. package/lib/spawn-data-server.js.map +1 -1
  175. package/lib/stderr-connection-logger.d.ts +12 -0
  176. package/lib/stderr-connection-logger.d.ts.map +1 -0
  177. package/lib/stderr-connection-logger.js +16 -0
  178. package/lib/stderr-connection-logger.js.map +1 -0
  179. package/lib/testing/echo-server.js +9 -1
  180. package/lib/testing/echo-server.js.map +1 -1
  181. package/package.json +52 -39
  182. package/src/cli.ts +7 -2
  183. package/src/commands/analyze-heap.ts +4 -1
  184. package/src/commands/ast-ground-truth-args.ts +15 -12
  185. package/src/commands/ast-ground-truth-driver.ts +2 -1
  186. package/src/commands/ast-ground-truth.ts +1 -1
  187. package/src/commands/client-session.ts +33 -0
  188. package/src/commands/create-args.ts +68 -0
  189. package/src/commands/create.ts +83 -0
  190. package/src/commands/delete-args.ts +64 -0
  191. package/src/commands/delete.ts +61 -0
  192. package/src/commands/generate-languages.ts +132 -0
  193. package/src/commands/generate-transfer-model-args.ts +7 -0
  194. package/src/commands/generate-transfer-model-config.ts +6 -3
  195. package/src/commands/generate-transfer-model.ts +56 -8
  196. package/src/commands/harness-args.ts +99 -31
  197. package/src/commands/headless-harness.ts +86 -26
  198. package/src/commands/init-args.ts +32 -27
  199. package/src/commands/init-prompt.ts +5 -6
  200. package/src/commands/init-templates.ts +790 -696
  201. package/src/commands/init-wizard.ts +17 -27
  202. package/src/commands/init-workspace.ts +31 -16
  203. package/src/commands/init.ts +126 -58
  204. package/src/commands/kebab.ts +17 -0
  205. package/src/commands/lint-grammar-args.ts +17 -13
  206. package/src/commands/lint-grammar-driver.ts +2 -1
  207. package/src/commands/lint-grammar.ts +1 -1
  208. package/src/commands/measure-memory-args.ts +27 -14
  209. package/src/commands/measure-memory-driver.ts +5 -3
  210. package/src/commands/measure-memory.ts +1 -1
  211. package/src/commands/model-docs-args.ts +16 -13
  212. package/src/commands/model-docs-driver.ts +2 -1
  213. package/src/commands/model-docs.ts +1 -1
  214. package/src/commands/projects-args.ts +5 -4
  215. package/src/commands/projects.ts +4 -6
  216. package/src/commands/query-args.ts +5 -4
  217. package/src/commands/query.ts +4 -6
  218. package/src/commands/reflect-args.ts +17 -13
  219. package/src/commands/reflect-driver.ts +2 -1
  220. package/src/commands/reflect.ts +1 -1
  221. package/src/commands/save-args.ts +7 -3
  222. package/src/commands/save.ts +24 -27
  223. package/src/commands/validate-args.ts +17 -13
  224. package/src/commands/validate-driver.ts +2 -1
  225. package/src/commands/validate.ts +1 -1
  226. package/src/commands/watch-args.ts +6 -3
  227. package/src/commands/watch.ts +28 -7
  228. package/src/driver-heap.ts +65 -0
  229. package/src/index.ts +2 -0
  230. package/src/log-level.ts +42 -14
  231. package/src/spawn-data-server.ts +17 -5
  232. package/src/stderr-connection-logger.ts +18 -0
  233. package/src/testing/echo-server.ts +11 -2
  234. package/templates/gitignore +1 -0
  235. package/templates/protocol/gitignore +3 -0
  236. package/templates/protocol/src/__GRAMMAR_ID__-diagram-types.ts +41 -0
  237. package/templates/server/gitignore +6 -0
  238. package/templates/server/src/glsp/__GRAMMAR_ID__/create-node-operation-handler.ts +62 -0
  239. package/templates/server/src/glsp/__GRAMMAR_ID__/gmodel-factory.ts +60 -0
  240. package/templates/server/src/glsp/__GRAMMAR_ID__/state.ts +18 -0
  241. package/templates/server/src/glsp/__GRAMMAR_ID__/storage.ts +16 -0
  242. package/templates/server/src/glsp/__GRAMMAR_ID__/submission-handler.ts +24 -0
  243. package/templates/server/src/grammar/common.langium +12 -0
  244. package/templates/server/src/language-server/__GRAMMAR_ID__-serializer.ts +53 -0
  245. package/templates/server/src/language-server/ast.ts +23 -0
  246. package/templates/server/src/node/services.ts +16 -0
  247. package/templates/server/test/__GRAMMAR_ID__-diagram.test.ts +112 -0
  248. package/templates/server/test/tsconfig.json +4 -0
  249. package/templates/server/tsconfig.test.json +10 -0
  250. package/templates/server/vitest.config.ts +14 -0
  251. package/templates/workspace/nodes.__EXTENSION__ +5 -0
  252. package/templates/workspace/references.__EXTENSION__ +2 -0
@@ -10,6 +10,7 @@
10
10
  import * as fs from 'fs';
11
11
  import * as path from 'path';
12
12
  import { emitAstBuilder } from './generate-ast-builder.js';
13
+ import { emitLanguages } from './generate-languages.js';
13
14
  import {
14
15
  type Node,
15
16
  type ObjectLiteralExpression,
@@ -19,6 +20,7 @@ import {
19
20
  type InterfaceDeclaration,
20
21
  type SourceFile
21
22
  } from 'ts-morph';
23
+ import { describeError } from '@hydranium/protocol';
22
24
 
23
25
  /**
24
26
  * Options for the transfer-model generator.
@@ -45,6 +47,13 @@ export interface GenerateTransferModelOptions {
45
47
  * and not the other has the two disagreeing about the same grammar.
46
48
  */
47
49
  astBuilderFile?: string;
50
+ /**
51
+ * Destination for a generated module stating each grammar's language id and
52
+ * file extensions, read from the `module.ts` beside {@link astFile}. Lets a
53
+ * package without Langium, such as one shared with clients, name the ids
54
+ * without copying them by hand.
55
+ */
56
+ languagesFile?: string;
48
57
  /** Name used for the base element type in the output. Defaults to `TransferElement`. */
49
58
  elementTypeName?: string;
50
59
  /** Name used for the terminal-patterns const in the output. Defaults to `ModelTerminals`. */
@@ -98,38 +107,67 @@ const DEFAULT_REGEN_COMMAND = 'Run the hydranium-cli generate-transfer-model com
98
107
  */
99
108
  const NAMESPACED_TERMINALS_NAME = 'Terminals';
100
109
 
110
+ /** How often `--watch` polls its input files. */
111
+ const WATCH_POLL_INTERVAL_MS = 250;
112
+
101
113
  /**
102
- * Generate once, then re-generate whenever the AST or augmentation file changes,
114
+ * Generate once, then re-generate whenever an input file changes (the AST, the
115
+ * augmentation file, and `module.ts` when a languages file is written),
103
116
  * until `signal` aborts (the CLI wires this to SIGINT). Regeneration is debounced
104
117
  * so an editor's multi-event save fires a single run, and a generation error is
105
118
  * logged without tearing down the watch. Resolves when the signal aborts.
119
+ *
120
+ * Polled by path rather than watched through OS events: langium-cli removes
121
+ * its output directory and writes the files back, which an event watch, Node's
122
+ * and chokidar's alike, stops hearing after the first run. A run that finds an
123
+ * input missing is skipped, since the file's return is a change of its own, so
124
+ * nothing generates from a half-written output.
106
125
  */
107
126
  export function watchTransferModel(options: GenerateTransferModelOptions, context: { signal: AbortSignal }): Promise<void> {
108
127
  const runSafely = (): void => {
109
128
  try {
110
129
  generateTransferModel(options);
111
130
  } catch (error: unknown) {
112
- console.error(`Transfer-model generation failed: ${error instanceof Error ? error.message : String(error)}`);
131
+ console.error(`Transfer-model generation failed: ${describeError(error)}`);
113
132
  }
114
133
  };
115
134
  runSafely();
116
- console.log(`Watching ${options.astFile} and ${options.augmentationFile} for changes. Press Ctrl-C to stop.`);
135
+ // A grammar's language id and extensions reach only `module.ts`, so the
136
+ // languages module would go stale without it.
137
+ const watched = [
138
+ options.astFile,
139
+ options.augmentationFile,
140
+ ...(options.languagesFile !== undefined ? [languagesModuleFile(options)] : [])
141
+ ];
117
142
 
118
143
  let timer: NodeJS.Timeout | undefined;
119
- const scheduleRerun = (): void => {
144
+ const rerun = (): void => {
145
+ if (watched.every(file => fs.existsSync(file))) {
146
+ runSafely();
147
+ }
148
+ };
149
+ // The poll reports every stat it takes; a replaced file has a new inode, a
150
+ // rewritten one a new mtime, a removed or returning one zeroed stats.
151
+ const onPoll = (current: fs.Stats, previous: fs.Stats): void => {
152
+ if (current.ino === previous.ino && current.mtimeMs === previous.mtimeMs && current.size === previous.size) {
153
+ return;
154
+ }
120
155
  if (timer) {
121
156
  clearTimeout(timer);
122
157
  }
123
- timer = setTimeout(runSafely, 150);
158
+ timer = setTimeout(rerun, 150);
124
159
  };
125
- const watchers = [options.astFile, options.augmentationFile].map(file => fs.watch(file, scheduleRerun));
160
+ for (const file of watched) {
161
+ fs.watchFile(file, { interval: WATCH_POLL_INTERVAL_MS }, onPoll);
162
+ }
163
+ console.log(`Watching ${watched.join(', ')} for changes. Press Ctrl-C to stop.`);
126
164
 
127
165
  return new Promise<void>(resolve => {
128
166
  context.signal.addEventListener(
129
167
  'abort',
130
168
  () => {
131
- for (const watcher of watchers) {
132
- watcher.close();
169
+ for (const file of watched) {
170
+ fs.unwatchFile(file, onPoll);
133
171
  }
134
172
  if (timer) {
135
173
  clearTimeout(timer);
@@ -141,6 +179,11 @@ export function watchTransferModel(options: GenerateTransferModelOptions, contex
141
179
  });
142
180
  }
143
181
 
182
+ /** The langium-cli `module.ts` beside the AST file, which the languages module is read from. */
183
+ function languagesModuleFile(options: GenerateTransferModelOptions): string {
184
+ return path.join(path.dirname(options.astFile), 'module.ts');
185
+ }
186
+
144
187
  /** Run the transfer-model generator. */
145
188
  export function generateTransferModel(options: GenerateTransferModelOptions): void {
146
189
  const elementTypeName = options.elementTypeName ?? DEFAULT_ELEMENT_TYPE_NAME;
@@ -422,6 +465,11 @@ export function generateTransferModel(options: GenerateTransferModelOptions): vo
422
465
  console.warn(`Warning: no '${languageId}AstType' alias in ${options.astFile}; skipping the AST builder.`);
423
466
  }
424
467
  }
468
+
469
+ if (options.languagesFile !== undefined) {
470
+ const moduleSource = project.addSourceFileAtPath(languagesModuleFile(options));
471
+ emitLanguages(moduleSource, { outFile: options.languagesFile, regenCommand });
472
+ }
425
473
  }
426
474
 
427
475
  // ---------------------------------------------------------------------------
@@ -31,11 +31,12 @@
31
31
  * parser rejects is an invocation that fails for no visible reason.
32
32
  */
33
33
 
34
- import type { LogThreshold } from '@hydranium/protocol';
34
+ import { describeError, type LogThreshold } from '@hydranium/protocol';
35
35
  import { statSync } from 'node:fs';
36
+ import * as fs from 'node:fs/promises';
36
37
  import * as path from 'node:path';
37
38
  import { fileURLToPath } from 'node:url';
38
- import { parseLogLevelOption } from '../log-level.js';
39
+ import { type LogOptions, parseLogLevelOption } from '../log-level.js';
39
40
 
40
41
  /**
41
42
  * How a parser reports a usage problem. It never returns, so a parser can treat
@@ -56,9 +57,18 @@ export function exitWithUsage(message: string): never {
56
57
  process.exit(2);
57
58
  }
58
59
 
59
- /** The value flag {@link parseHarnessArgs} consumes itself, before any the subcommand declares. */
60
+ /** Names the head's services module; every harness subcommand requires it. */
60
61
  export const SERVICES_FLAG = '--services';
61
62
 
63
+ /**
64
+ * Registers a loader in the driver child that imports the head. The child is a
65
+ * fresh `node`, so a loader registered on the CLI's own process never reaches it.
66
+ */
67
+ export const IMPORT_FLAG = '--import';
68
+
69
+ /** The value flags {@link parseHarnessArgs} consumes itself, before any the subcommand declares. */
70
+ export const HARNESS_VALUE_FLAGS = [SERVICES_FLAG, IMPORT_FLAG] as const;
71
+
62
72
  /**
63
73
  * The one spelling of the log threshold, shared by both subcommand families.
64
74
  *
@@ -68,33 +78,68 @@ export const SERVICES_FLAG = '--services';
68
78
  * on which command a caller happened to reach for.
69
79
  */
70
80
  export const LOG_LEVEL_FLAG = '--log-level';
81
+ export const LOG_FILE_FLAG = '--log-file';
82
+ export const LOG_FILE_LEVEL_FLAG = '--log-file-level';
83
+
84
+ /** The log flags every subcommand takes, read by {@link logOptions}. */
85
+ export const LOG_VALUE_FLAGS = [LOG_LEVEL_FLAG, LOG_FILE_FLAG, LOG_FILE_LEVEL_FLAG] as const;
71
86
 
72
87
  /** The value flags {@link parseServerSpawnOptions} consumes itself. */
73
- export const SERVER_SPAWN_VALUE_FLAGS: readonly string[] = ['--server', '--cwd', LOG_LEVEL_FLAG];
88
+ export const SERVER_SPAWN_VALUE_FLAGS: readonly string[] = ['--server', '--cwd', ...LOG_VALUE_FLAGS];
74
89
 
75
90
  /**
76
- * The `--help` line every subcommand describes {@link LOG_LEVEL_FLAG} with.
91
+ * The `--help` lines every subcommand describes {@link LOG_VALUE_FLAGS} with.
77
92
  *
78
93
  * Shared text, per-command padding: `command-args.test.ts` compares the flags a
79
94
  * 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
95
+ * description by the two-space indent — so each line has to be a real option entry
81
96
  * in each block, and the column each block aligns its descriptions at is the
82
- * block's own.
97
+ * block's own. A flag too wide for that column takes its description on the
98
+ * next line, at the column.
83
99
  */
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).`;
100
+ export function logHelpLines(padTo: number, head = 'the head this boots'): string[] {
101
+ return [
102
+ helpLine(`${LOG_LEVEL_FLAG} <lvl>`, `Log threshold for ${head} (off|error|warn|info|debug|trace).`, padTo),
103
+ helpLine(
104
+ `${LOG_FILE_FLAG} <file>`,
105
+ `Also write ${head}'s log to <file>; {workspace} expands to the workspace, {pid} to the process id.`,
106
+ padTo
107
+ ),
108
+ helpLine(`${LOG_FILE_LEVEL_FLAG} <lvl>`, `Threshold for that file, which the log-level setting does not change.`, padTo)
109
+ ].flat();
110
+ }
111
+
112
+ /** The `--help` lines every `--services` subcommand describes {@link IMPORT_FLAG} with, aligned as {@link logHelpLines}. */
113
+ export function importHelpLines(padTo: number): string[] {
114
+ return helpLine(`${IMPORT_FLAG} <specifier>`, 'Loader to register before importing <module>, e.g. tsx (repeatable).', padTo);
115
+ }
116
+
117
+ function helpLine(flag: string, text: string, padTo: number): string[] {
118
+ return flag.length < padTo - 1 ? [` ${flag.padEnd(padTo)}${text}`] : [` ${flag}`, `${' '.repeat(padTo + 2)}${text}`];
86
119
  }
87
120
 
88
121
  /**
89
- * Narrow a raw {@link LOG_LEVEL_FLAG} value that {@link parseHarnessArgs}
90
- * collected, leaving an absent flag absent.
122
+ * Narrow the raw {@link LOG_VALUE_FLAGS} values a parser collected, leaving
123
+ * absent flags absent.
124
+ *
125
+ * `--log-file` resolves against the caller's directory: the child may run
126
+ * elsewhere (`--cwd`), and a relative path would land the log there.
91
127
  *
92
128
  * Throws rather than reaching `onError`, matching {@link parseServerSpawnOptions}:
93
129
  * the level vocabulary belongs to the protocol package, which reports it, and the
94
130
  * entry point's catch turns that into the same message-and-exit.
95
131
  */
96
- export function logLevelOption(value: string | undefined): LogThreshold | undefined {
97
- return value === undefined ? undefined : parseLogLevelOption(value);
132
+ export function logOptions(options: Readonly<Record<string, string | undefined>>): LogOptions {
133
+ const level = (flag: string): LogThreshold | undefined => {
134
+ const value = options[flag];
135
+ return value === undefined ? undefined : parseLogLevelOption(value, flag);
136
+ };
137
+ const logFile = options[LOG_FILE_FLAG];
138
+ return {
139
+ logLevel: level(LOG_LEVEL_FLAG),
140
+ logFile: logFile === undefined ? undefined : path.resolve(logFile),
141
+ logFileLevel: level(LOG_FILE_LEVEL_FLAG)
142
+ };
98
143
  }
99
144
 
100
145
  /**
@@ -134,6 +179,8 @@ export function printHelp(lines: readonly string[]): void {
134
179
  /** What {@link parseHarnessArgs} recovered from an argv. */
135
180
  export interface ParsedHarnessArgs {
136
181
  servicesModule: string;
182
+ /** The {@link IMPORT_FLAG} values in the order given, absent when there were none. */
183
+ imports?: string[];
137
184
  /**
138
185
  * An absolute directory path, resolved by {@link resolveWorkspaceArgument} and
139
186
  * checked to exist. `''` when the subcommand declared `requireWorkspace: false`.
@@ -163,12 +210,12 @@ export interface HarnessArgsConfig {
163
210
 
164
211
  /**
165
212
  * 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.
213
+ * `--services <module>` value flag, the repeatable `--import <specifier>` and a
214
+ * single positional `<workspace>`, plus the `valueFlags` (each takes a value)
215
+ * and `boolFlags` (presence-only, recorded as `'true'`) the subcommand
216
+ * recognises. Unknown flags or a missing `--services`/`<workspace>` are usage
217
+ * errors, and so is a `<workspace>` that reaches no directory — see
218
+ * {@link resolveWorkspaceArgument} for why that cannot be left to the run.
172
219
  */
173
220
  export function parseHarnessArgs(
174
221
  args: string[],
@@ -185,6 +232,7 @@ export function parseHarnessArgs(
185
232
  const options: Record<string, string | undefined> = {};
186
233
  const values: Record<string, string[]> = {};
187
234
  let servicesModule: string | undefined;
235
+ let imports: string[] | undefined;
188
236
  let workspace: string | undefined;
189
237
  for (let index = 0; index < args.length; index += 1) {
190
238
  const flag = args[index];
@@ -196,8 +244,10 @@ export function parseHarnessArgs(
196
244
  index += 1;
197
245
  return value;
198
246
  };
199
- if (flag === '--services') {
247
+ if (flag === SERVICES_FLAG) {
200
248
  servicesModule = next();
249
+ } else if (flag === IMPORT_FLAG) {
250
+ (imports ??= []).push(next());
201
251
  } else if (boolSet.has(flag)) {
202
252
  options[flag] = 'true';
203
253
  } else if (repeatableSet.has(flag)) {
@@ -213,7 +263,8 @@ export function parseHarnessArgs(
213
263
  }
214
264
  }
215
265
  return {
216
- servicesModule: assertRequired(servicesModule, '--services', commandName, onError),
266
+ servicesModule: assertRequired(servicesModule, SERVICES_FLAG, commandName, onError),
267
+ imports,
217
268
  workspace: requireWorkspace
218
269
  ? resolveWorkspaceArgument(assertRequired(workspace, '<workspace>', commandName, onError), commandName, onError)
219
270
  : (workspace ?? ''),
@@ -257,7 +308,7 @@ export function resolveWorkspaceArgument(workspace: string, commandName: string,
257
308
  try {
258
309
  stats = statSync(resolved, { throwIfNoEntry: false });
259
310
  } catch (err: unknown) {
260
- const detail = err instanceof Error ? err.message : String(err);
311
+ const detail = describeError(err);
261
312
  onError(`<workspace> is not reachable: '${workspace}' resolved to ${resolved} (${detail}) ${help}`);
262
313
  }
263
314
  if (stats === undefined) {
@@ -276,7 +327,7 @@ function toWorkspacePath(workspace: string, commandName: string, onError: UsageE
276
327
  try {
277
328
  return fileURLToPath(workspace);
278
329
  } catch (err: unknown) {
279
- const detail = err instanceof Error ? err.message : String(err);
330
+ const detail = describeError(err);
280
331
  onError(`<workspace> is not a usable file URI: '${workspace}' (${detail}) (hydranium-cli ${commandName} --help)`);
281
332
  }
282
333
  }
@@ -336,11 +387,10 @@ function kebabToCamel(name: string): string {
336
387
  }
337
388
 
338
389
  /** What {@link parseServerSpawnOptions} recovered from an argv. */
339
- export interface SpawnOptions {
390
+ export interface SpawnOptions extends LogOptions {
340
391
  serverCommand: string;
341
392
  serverArgs: string[];
342
393
  cwd?: string;
343
- logLevel?: LogThreshold;
344
394
  /** The tokens this parser did not claim, for the subcommand's own options. */
345
395
  extra: string[];
346
396
  }
@@ -363,10 +413,10 @@ function isRelativePathToken(token: string, isCommand: boolean): boolean {
363
413
 
364
414
  /**
365
415
  * Shared option parser for subcommands that spawn a data-server child. Consumes
366
- * `--server` / `--cwd` / `--log-level` and returns the surviving tokens as
416
+ * `--server` / `--cwd` / the {@link LOG_VALUE_FLAGS} and returns the surviving tokens as
367
417
  * `extra` for {@link parseFlagOptions} to finish.
368
418
  *
369
- * An unrecognised `--log-level` value throws rather than reaching `onError`: the
419
+ * An unrecognised log level value throws rather than reaching `onError`: the
370
420
  * level vocabulary belongs to the protocol package, which reports it, and the
371
421
  * entry point's catch turns that into the same message-and-exit.
372
422
  *
@@ -383,7 +433,7 @@ function isRelativePathToken(token: string, isCommand: boolean): boolean {
383
433
  export function parseServerSpawnOptions(args: string[], commandName: string, onError: UsageError = exitWithUsage): SpawnOptions {
384
434
  let serverSpec: string | undefined;
385
435
  let cwd: string | undefined;
386
- let logLevel: LogThreshold | undefined;
436
+ const logFlags: Record<string, string> = {};
387
437
  const extra: string[] = [];
388
438
  for (let index = 0; index < args.length; index += 1) {
389
439
  const flag = args[index];
@@ -399,8 +449,8 @@ export function parseServerSpawnOptions(args: string[], commandName: string, onE
399
449
  serverSpec = claim();
400
450
  } else if (flag === '--cwd') {
401
451
  cwd = claim();
402
- } else if (flag === LOG_LEVEL_FLAG) {
403
- logLevel = parseLogLevelOption(claim());
452
+ } else if ((LOG_VALUE_FLAGS as readonly string[]).includes(flag)) {
453
+ logFlags[flag] = claim();
404
454
  } else {
405
455
  extra.push(flag);
406
456
  }
@@ -425,5 +475,23 @@ export function parseServerSpawnOptions(args: string[], commandName: string, onE
425
475
  );
426
476
  }
427
477
  }
428
- return { serverCommand, serverArgs, cwd, logLevel, extra };
478
+ return { serverCommand, serverArgs, cwd, ...logOptions(logFlags), extra };
479
+ }
480
+
481
+ /**
482
+ * Resolve the `--content` argument to its textual form. The `@<path>`
483
+ * prefix reads from a file (parses as UTF-8); anything else is taken
484
+ * literally. The leading `@` can be escaped as `\@` for content that
485
+ * legitimately starts with `@`.
486
+ */
487
+ export async function resolveContent(content: string, readFile?: (path: string) => Promise<string>): Promise<string> {
488
+ if (content.startsWith('@')) {
489
+ const file = content.slice(1);
490
+ const reader = readFile ?? ((target: string) => fs.readFile(target, 'utf8'));
491
+ return reader(file);
492
+ }
493
+ if (content.startsWith('\\@')) {
494
+ return content.slice(1);
495
+ }
496
+ return content;
429
497
  }
@@ -8,14 +8,14 @@
8
8
  ********************************************************************************/
9
9
 
10
10
  import type * as HydraniumCoreNode from '@hydranium/core/node';
11
- import type { LogThreshold } from '@hydranium/protocol';
12
11
  import { spawn } from 'node:child_process';
13
12
  import { statSync, writeFileSync } from 'node:fs';
14
13
  import { createRequire } from 'node:module';
15
14
  import * as path from 'node:path';
16
15
  import { pathToFileURL } from 'node:url';
17
- import { logLevelEnv } from '../log-level.js';
18
- import { SERVICES_FLAG } from './harness-args.js';
16
+ import { driverHeapArgs, type HeapReading } from '../driver-heap.js';
17
+ import { logEnv, type LogOptions } from '../log-level.js';
18
+ import { IMPORT_FLAG, SERVICES_FLAG } from './harness-args.js';
19
19
 
20
20
  /** The flag every report-producing subcommand names its destination file with. */
21
21
  export const OUT_FILE_FLAG = '--out-file';
@@ -43,13 +43,15 @@ export interface HeadlessContext {
43
43
  * its `createServices` thunk AND the `@hydranium/core/node` harness, both
44
44
  * resolved from the HEAD's location rather than the CLI's.
45
45
  *
46
- * The module is an ESM file (typically a compiled `lib/*.js`) exporting a
47
- * ZERO-ARG `createServices(): { shared }`. `hydranium-cli` is language-agnostic
46
+ * The module is an ESM file exporting a ZERO-ARG `createServices(): { shared }`:
47
+ * a compiled `lib/*.js`, or the TypeScript source when the child was started
48
+ * with a loader through {@link IMPORT_FLAG}. `hydranium-cli` is language-agnostic
48
49
  * and cannot statically import a head's `create<Lang>Services`, so the dynamic
49
50
  * import is the seam that keeps the binary head-neutral. Resolving the harness
50
- * from the head's graph (via `createRequire` rooted at the head module) means the
51
- * CLI itself needs no `@hydranium/core` dependency — the head always has it — and
52
- * guarantees the harness runs against the SAME core copy as `createServices`.
51
+ * from the head's graph (via `createRequire` rooted at the head module) rather
52
+ * than from the CLI's guarantees it runs against the SAME core copy as
53
+ * `createServices`, which a second copy of the module would break even where
54
+ * both resolve.
53
55
  *
54
56
  * Throws a clear error when the path names no file, and when the export is
55
57
  * missing or not a function.
@@ -64,12 +66,17 @@ export async function loadHeadlessContext(servicesModule: string): Promise<Headl
64
66
  if (stats === undefined || !stats.isFile()) {
65
67
  throw new Error(
66
68
  `${SERVICES_FLAG} must name an existing ESM file; '${servicesModule}' resolved to ${modulePath}, ` +
67
- `which is not one. Pass the head's COMPILED entry, e.g. \`${SERVICES_FLAG} ./lib/services.js\` — ` +
68
- 'not the TypeScript source and not a package name.'
69
+ "which is not one. Pass the path of the server package's built `lib/node/services.js` from where you run this — " +
70
+ 'not a package name.'
69
71
  );
70
72
  }
71
73
  const moduleUrl = pathToFileURL(modulePath).href;
72
- const imported = (await import(moduleUrl)) as Record<string, unknown>;
74
+ let imported: Record<string, unknown>;
75
+ try {
76
+ imported = (await import(moduleUrl)) as Record<string, unknown>;
77
+ } catch (err: unknown) {
78
+ throw withLoaderHint(err, modulePath);
79
+ }
73
80
  const createServices = imported.createServices;
74
81
  if (typeof createServices !== 'function') {
75
82
  throw new Error(
@@ -84,6 +91,32 @@ export async function loadHeadlessContext(servicesModule: string): Promise<Headl
84
91
  return { createServices: createServices as ServicesFactory, coreNode };
85
92
  }
86
93
 
94
+ /** The codes Node fails a TypeScript entry with when no loader handled it, depending on its version. */
95
+ const UNLOADED_TYPESCRIPT_CODES: ReadonlySet<string> = new Set([
96
+ 'ERR_UNKNOWN_FILE_EXTENSION',
97
+ 'ERR_MODULE_NOT_FOUND',
98
+ 'ERR_UNSUPPORTED_TYPESCRIPT_SYNTAX'
99
+ ]);
100
+
101
+ /**
102
+ * Append a loader hint to a TypeScript entry's import failure, unless the child
103
+ * was started with {@link IMPORT_FLAG}, where the hint would only repeat the
104
+ * caller's own command. Appended rather than substituted: a loader set through
105
+ * `NODE_OPTIONS` does not show in `execArgv`, and under it the failure can be a
106
+ * missing module that only Node's own message names.
107
+ */
108
+ function withLoaderHint(err: unknown, modulePath: string): unknown {
109
+ if (!(err instanceof Error) || !/\.[cm]?ts$/.test(modulePath) || !('code' in err) || typeof err.code !== 'string') {
110
+ return err;
111
+ }
112
+ if (!UNLOADED_TYPESCRIPT_CODES.has(err.code) || process.execArgv.some(arg => arg.startsWith(IMPORT_FLAG))) {
113
+ return err;
114
+ }
115
+ return new Error(`${err.message}\nA TypeScript head needs a loader registered with \`${IMPORT_FLAG}\`, e.g. \`${IMPORT_FLAG} tsx\`.`, {
116
+ cause: err
117
+ });
118
+ }
119
+
87
120
  /**
88
121
  * Child-side: deliver a finished report — to `outFile` when one was named, else
89
122
  * to stdout.
@@ -129,37 +162,64 @@ export function spawnNodeChild(execArgs: string[], env?: Record<string, string>)
129
162
  /** How a subcommand parent reaches its driver child; the seam `__spawnForTest` replaces. */
130
163
  export type SpawnDriverChild = (execArgs: string[], env?: Record<string, string>) => Promise<number>;
131
164
 
132
- /** What every `--services` subcommand carries for the child it spawns, on top of its own options. */
133
- export interface DriverSpawnOptions {
134
- /**
135
- * Log threshold for the head the driver boots. Absent leaves the child's
136
- * inherited environment alone, so an ambient `HYDRANIUM_LOG_LEVEL` still wins
137
- * where a caller set one.
138
- */
139
- readonly logLevel?: LogThreshold;
165
+ /**
166
+ * What every `--services` subcommand carries for the child it spawns, on top of
167
+ * its own options. The log options apply to the head the driver boots; an
168
+ * absent one leaves the child's inherited environment alone, so an ambient
169
+ * variable still wins where a caller set one.
170
+ */
171
+ export interface DriverSpawnOptions extends LogOptions {
172
+ /** Specifiers the driver child registers with Node's `--import`, in order, before it imports the head. */
173
+ readonly imports?: readonly string[];
140
174
  /** Test-only: capture the node argv and env instead of spawning the real child. */
141
175
  readonly __spawnForTest?: SpawnDriverChild;
176
+ /**
177
+ * Test-only: decide the heap ceiling from a stated cgroup reading rather
178
+ * than the machine's. Without it an argv assertion means one thing on a
179
+ * workstation and nothing at all under a memory limit, so a suite that
180
+ * asserts the ceiling is present passes vacuously in a container.
181
+ */
182
+ readonly __heapReadingForTest?: HeapReading;
142
183
  }
143
184
 
144
185
  /**
145
186
  * Parent-side: run a subcommand's driver child and propagate its exit code, so a
146
187
  * shell or CI step sees the gate.
147
188
  *
148
- * **The log threshold travels in the child's ENVIRONMENT, not its argv.** The
149
- * head's logger reads `HYDRANIUM_LOG_LEVEL` while `createServices` constructs it,
150
- * which is inside the driver's dynamic import — a flag the driver parsed would
151
- * arrive after the only moment it can be read. Setting it here rather than
152
- * exporting it also leaves the CLI's own output alone, unlike an ambient
153
- * `HYDRANIUM_LOG_LEVEL=…` the parent would carry too.
189
+ * **The log options travel in the child's ENVIRONMENT, not its argv.** The
190
+ * head's logger reads its `HYDRANIUM_LOG_*` variables while `createServices`
191
+ * constructs it, which is inside the driver's dynamic import — a flag the driver
192
+ * parsed would arrive after the only moment it can be read. Setting them here
193
+ * rather than exporting them also leaves the CLI's own output alone, unlike
194
+ * ambient variables the parent would carry too.
154
195
  *
155
196
  * A head that binds a logger of its own decides for itself whether the flag means
156
197
  * anything, which is the intended seam: the CLI is language-agnostic and cannot
157
198
  * reach past `createServices`.
199
+ *
200
+ * **The heap ceiling is prepended HERE rather than passed by each subcommand.**
201
+ * Every caller wants the same answer to the same question, and the answer is not
202
+ * a constant — see {@link driverHeapArgs}. A literal at the call site is a place
203
+ * the container case can be missed, and the caller that misses it takes the whole
204
+ * cgroup down with it rather than failing on its own.
158
205
  */
159
206
  export async function runDriverChild(execArgs: string[], options: DriverSpawnOptions): Promise<void> {
160
207
  const spawnChild = options.__spawnForTest ?? spawnNodeChild;
161
- const code = await spawnChild(execArgs, options.logLevel === undefined ? undefined : logLevelEnv(options.logLevel));
208
+ const importArgs = (options.imports ?? []).map(specifier => `${IMPORT_FLAG}=${loaderSpecifier(specifier)}`);
209
+ const code = await spawnChild([...driverHeapArgs(options.__heapReadingForTest), ...importArgs, ...execArgs], logEnv(options));
162
210
  if (code) {
163
211
  process.exitCode = code;
164
212
  }
165
213
  }
214
+
215
+ /**
216
+ * A path, absolute or `./`/`../` relative with either separator, becomes a file
217
+ * URL resolved against the caller's directory. Node reads `--import` as a URL or
218
+ * package specifier, so it would take a Windows `C:\…` for the URL scheme `c:`
219
+ * and a `.\…` for a package name. Any other specifier passes through as Node
220
+ * reads it.
221
+ */
222
+ function loaderSpecifier(specifier: string): string {
223
+ const isPath = path.isAbsolute(specifier) || /^\.\.?[\\/]/.test(specifier);
224
+ return isPath ? pathToFileURL(path.resolve(specifier)).href : specifier;
225
+ }