helper

Documentation

Index

• func MetadataFiles(sourceDirectory string) ([]string, error)
• func ProcessMetaFiles(metadataFiles []string, stepHelperData StepHelperData, ...) error
• type ContextDefaultData
• type ContextDefaultMetadata
• type ContextDefaultParameters
• type DocuHelperData
• type StepHelperData

Functions

func MetadataFiles

func MetadataFiles(sourceDirectory string) ([]string, error)

MetadataFiles provides a list of all step metadata files

func ProcessMetaFiles

func ProcessMetaFiles(metadataFiles []string, stepHelperData StepHelperData, docuHelperData DocuHelperData) error

ProcessMetaFiles generates step coding based on step configuration provided in yaml files

Types

type ContextDefaultData

type ContextDefaultData struct {
	Metadata   ContextDefaultMetadata     `json:"metadata"`
	Parameters []ContextDefaultParameters `json:"params"`
}

ContextDefaultData holds the meta data and the default data for the context default parameter descriptions

type ContextDefaultMetadata

type ContextDefaultMetadata struct {
	Name            string `json:"name"`
	Description     string `json:"description"`
	LongDescription string `json:"longDescription,omitempty"`
}

ContextDefaultMetadata holds meta data for the context default parameter descripten (name, description, long description)

type ContextDefaultParameters

type ContextDefaultParameters struct {
	Name        string   `json:"name"`
	Description string   `json:"description"`
	Scope       []string `json:"scope"`
}

ContextDefaultParameters holds the description for the context default parameters

type DocuHelperData

type DocuHelperData struct {
	IsGenerateDocu      bool
	DocTemplatePath     string
	OpenDocTemplateFile func(d string) (io.ReadCloser, error)
	DocFileWriter       func(f string, d []byte, p os.FileMode) error
}

DocuHelperData is used to transport the needed parameters and functions from the step generator to the docu generation.

type StepHelperData

type StepHelperData struct {
	OpenFile     func(s string) (io.ReadCloser, error)
	WriteFile    func(filename string, data []byte, perm os.FileMode) error
	ExportPrefix string
}

StepHelperData is used to transport the needed parameters and functions from the step generator to the step generation.