config

Documentation

Index

• type Bool
  • func (r Bool) String() string
• type Config
  • func (*Config) Options() []byte
• type Environment
• type Generator
  • func (g *Generator) Filename() string
  • func (g *Generator) Generate(ctx context.Context) []byte
  • func (g *Generator) OutputPath() string
• type MarkdownDocGenerator
  • func (g *MarkdownDocGenerator) Filename() string
  • func (g *MarkdownDocGenerator) Generate(ctx context.Context) []byte
  • func (g *MarkdownDocGenerator) OutputPath() string
• type Plugin
  • func (p *Plugin) Configure(cfg *swipe.Config, module *option.Module, options map[string]interface{}) []error
  • func (p *Plugin) Generators() (generators []swipe.Generator, errs []error)
  • func (p *Plugin) ID() string
  • func (p *Plugin) Options() []byte

Types

type Bool

type Bool bool

func (Bool) String

func (r Bool) String() string

type Config

type Config struct {
	Environment Environment
}

Config @swipe:"Config"

func (*Config) Options

func (*Config) Options() []byte

type Environment

type Environment struct {
	StructType *option.NamedType
	FuncName   *option.StringValue `swipe:"option"`
	EnableDoc  *struct{}           `swipe:"option"`
	OutputDoc  option.StringValue  `swipe:"option"`
}

type Generator

type Generator struct {
	Struct   *option.NamedType
	FuncName string
	// contains filtered or unexported fields
}

func (*Generator) Filename

func (g *Generator) Filename() string

func (*Generator) Generate

func (g *Generator) Generate(ctx context.Context) []byte

func (*Generator) OutputPath

func (g *Generator) OutputPath() string

type MarkdownDocGenerator

type MarkdownDocGenerator struct {
	Struct *option.NamedType
	Output string
	// contains filtered or unexported fields
}

func (*MarkdownDocGenerator) Filename

func (g *MarkdownDocGenerator) Filename() string

func (*MarkdownDocGenerator) Generate

func (g *MarkdownDocGenerator) Generate(ctx context.Context) []byte

func (*MarkdownDocGenerator) OutputPath

func (g *MarkdownDocGenerator) OutputPath() string

type Plugin

type Plugin struct {
	// contains filtered or unexported fields
}

func (*Plugin) Configure

func (p *Plugin) Configure(cfg *swipe.Config, module *option.Module, options map[string]interface{}) []error

func (*Plugin) Generators

func (p *Plugin) Generators() (generators []swipe.Generator, errs []error)

func (*Plugin) ID

func (p *Plugin) ID() string

func (*Plugin) Options

func (p *Plugin) Options() []byte