Skip to content

rune-langium / codegen/src/export / GeneratorOutput

Interface: GeneratorOutput ​

Defined in: packages/codegen/src/types.ts:213

One emitted output file from the generator. FR-001 (output structure).

Properties ​

PropertyTypeDescriptionDefined in
artifactRole?"support"Shared companion files follow model files in previews and downloads.packages/codegen/src/types.ts:217
binary?Uint8Array<ArrayBufferLike>Optional binary payload (018 Task 0.1). When present, content may be empty and consumers should prefer binary for I/O — e.g. the Excel target emits a single .xlsx workbook as raw bytes, not text.packages/codegen/src/types.ts:240
contentstringFull text content of the emitted file.packages/codegen/src/types.ts:223
diagnosticsGeneratorDiagnostic[]Diagnostics produced during generation of this file.packages/codegen/src/types.ts:227
funcsGeneratedFunc[]Emitted function declarations for this namespace. Non-empty only when target === 'typescript' (FR-028, FR-031). Empty array for 'zod' and 'json-schema' targets — funcs are silently skipped (FR-031).packages/codegen/src/types.ts:234
mimeType?stringOptional MIME type hint for the output (018 Task 0.1). Used by download UIs and file writers to set Content-Type correctly. The three text targets ('zod', 'typescript', 'json-schema') omit this and rely on file-extension inference upstream.packages/codegen/src/types.ts:247
namespaces?string[]Rune namespaces owned by this model file, retained through bundled layouts.packages/codegen/src/types.ts:215
projections?EmittedProjection[]Source-bound implementation fragments recorded by the target emitter.packages/codegen/src/types.ts:219
relativePathstringRelative path of the emitted file (e.g. 'cdm/base/math.zod.ts').packages/codegen/src/types.ts:221
sourceMapSourceMapEntry[]Source-map entries for this file.packages/codegen/src/types.ts:225

Core packages released under MIT. Studio app released under FSL-1.1-ALv2.