Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DocGenerator ¶
type DocGenerator struct{}
DocGenerator produces markdown documentation from plugin manifests and contracts.
func NewDocGenerator ¶
func NewDocGenerator() *DocGenerator
NewDocGenerator creates a new DocGenerator.
func (*DocGenerator) GenerateContractDoc ¶
func (g *DocGenerator) GenerateContractDoc(contract *dynamic.FieldContract) string
GenerateContractDoc produces a markdown section documenting a field contract.
func (*DocGenerator) GeneratePluginDoc ¶
func (g *DocGenerator) GeneratePluginDoc(manifest *plugin.PluginManifest) string
GeneratePluginDoc produces a complete markdown document for a plugin.
type GenerateOptions ¶
type GenerateOptions struct {
Name string
Version string
Author string
Description string
License string
OutputDir string
WithContract bool
}
GenerateOptions configures what gets generated.
type TemplateGenerator ¶
type TemplateGenerator struct{}
TemplateGenerator scaffolds new plugin projects with a manifest and component skeleton.
func NewTemplateGenerator ¶
func NewTemplateGenerator() *TemplateGenerator
NewTemplateGenerator creates a new TemplateGenerator.
func (*TemplateGenerator) Generate ¶
func (g *TemplateGenerator) Generate(opts GenerateOptions) error
Generate creates a new plugin directory with manifest and component skeleton.
Source Files
Click to show internal directories.
Click to hide internal directories.