forms

package

v0.0.2 Latest Latest Go to latest Published: Aug 15, 2024 License: Apache-2.0 Imports: 11 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/choria-io/scaffold

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func ProcessBytes(f []byte, env map[string]any) (map[string]any, error)
func ProcessFile(f string, env map[string]any) (map[string]any, error)
func ProcessForm(f Form, env map[string]any) (map[string]any, error)
func ProcessReader(r io.Reader, env map[string]any) (map[string]any, error)
type Form
type Property
- func (p *Property) RenderedDescription(env map[string]any) (string, error)

Constants ¶

View Source

const (
	ArrayIfEmpty  = "array"
	ObjectIfEmpty = "object"
	AbsentIfEmpty = "absent"
	StringType    = "string"
	BoolType      = "bool"
	IntType       = "integer"
	FloatType     = "float"
	PasswordType  = "password"
	ObjectType    = "object"
	ArrayType     = "array"
)

Variables ¶

This section is empty.

Functions ¶

func ProcessBytes ¶

func ProcessBytes(f []byte, env map[string]any) (map[string]any, error)

ProcessBytes treats f as a YAML document and ProcessForm() it

func ProcessFile ¶

func ProcessFile(f string, env map[string]any) (map[string]any, error)

ProcessFile reads f and ProcessForm() it as YAML

func ProcessForm ¶

func ProcessForm(f Form, env map[string]any) (map[string]any, error)

ProcessForm processes the form and return a data structure with the answers

func ProcessReader ¶

func ProcessReader(r io.Reader, env map[string]any) (map[string]any, error)

ProcessReader reads all data from r and ProcessForm() it as YAML

Types ¶

type Form ¶

type Form struct {
	Name        string     `json:"name" yaml:"name"`
	Description string     `json:"description" yaml:"description"`
	Properties  []Property `json:"properties" yaml:"properties"`
}

type Property ¶

type Property struct {
	Name                  string     `json:"name" yaml:"name"`
	Description           string     `json:"description" yaml:"description"`
	Help                  string     `json:"help" yaml:"help"`
	IfEmpty               string     `json:"empty" yaml:"empty"`
	Type                  string     `json:"type" yaml:"type"`
	ConditionalExpression string     `json:"conditional" yaml:"conditional"`
	ValidationExpression  string     `json:"validation" yaml:"validation"`
	Required              bool       `json:"required" yaml:"required"`
	Default               string     `json:"default" yaml:"default"`
	Enum                  []string   `json:"enum" yaml:"enum"`
	Properties            []Property `json:"properties" yaml:"properties"`
}

func (*Property) RenderedDescription ¶

func (p *Property) RenderedDescription(env map[string]any) (string, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL