forms

package

v0.9.0 Latest Latest Go to latest Published: Oct 27, 2023 License: Apache-2.0 Imports: 8 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/choria-io/appbuilder

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

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"`
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
tester

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