Skip to content

rune-langium / codegen/src/export / generatePreviewSchemas

Function: generatePreviewSchemas() ​

ts
function generatePreviewSchemas(documents, options?): FormPreviewSchema[];

Defined in: packages/codegen/src/export.ts:183

Generate structured form-preview schemas from one or more parsed Langium documents.

The returned schemas preserve field metadata and source-map information so Studio can render an inspector/form preview and navigate back to source.

Parameters ​

ParameterTypeDescription
documentsLangiumDocument<AstNode> | LangiumDocument<AstNode>[]One or more parsed Langium documents with resolved ASTs.
options?GeneratePreviewSchemaOptionsOptional preview generation options such as targetId and maxDepth.

Returns ​

FormPreviewSchema[]

Array of FormPreviewSchema objects sorted by target id.

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