generator

Documentation

Index

• func GetOptionFlags() []string
• func IsValid(val string) bool
• type Generator
  • func NewGenerator(dir string, force bool) Generator
  • func (g Generator) Generate(options []string) error
• type Option
  • func GetOptions() []Option

Functions

func GetOptionFlags

func GetOptionFlags() []string

func IsValid

func IsValid(val string) bool

Types

type Generator

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

func NewGenerator

func NewGenerator(dir string, force bool) Generator

func (Generator) Generate

func (g Generator) Generate(options []string) error

type Option

type Option interface {
	// E.g. "Markdown Linter"
	Name() string
	// E.g. lint-markdown
	FlagName() string
	IsApplicable(repoDir string) bool
	IsImplemented(yamlData []string) bool
	GetYamlConfig(repoDir string) (*string, error)
	GetOutputFileName(repoDir string) string
}

func GetOptions

func GetOptions() []Option