Interface IFileGenerator

Namespace

ToSic.Sxc.Code.Generate

Assembly

ToSic.Sxc.Code.Generate.dll

Describes a file generator which can generate (code) files.

[WorkInProgressApi("still being standardized")]
public interface IFileGenerator : IHasIdentityNameId

Inherited Members

IHasIdentityNameId.NameId

Properties

Description

Generator description for selecting the generator.

string Description { get; }

Property Value

string

DescriptionHtml

string DescriptionHtml { get; }

Property Value

string

Name

Generator name, to select it in a list of generators

string Name { get; }

Property Value

string

OutputLanguage

Language this generator creates, e.g. "CSharp", "TypeScript", "JavaScript"

string OutputLanguage { get; }

Property Value

string

OutputType

WIP, string name for what kind of output we'll generate. Not final yet, should be used in dialogs to only provide generators with the correct output type.

string OutputType { get; }

Property Value

string

Version

Generator version for additional info when selecting the generator.

string Version { get; }

Property Value

string

Methods

Generate(IFileGeneratorSpecs)

Call to run the generator and get the files

IGeneratedFileSet[] Generate(IFileGeneratorSpecs specs)

Parameters

specs IFileGeneratorSpecs

Returns

IGeneratedFileSet[]