settings

package

v0.6.20 Latest Latest Go to latest Published: Jul 27, 2026 License: MIT Imports: 10 Imported by: 0

Details

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

Repository

github.com/floegence/redevplugin

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func CanonicalSchemaJSON(spec *manifest.SettingsSpec) ([]byte, error)
func DecodeValues(values map[string]json.RawMessage) (map[string]any, error)
func DefaultValues(fields []Field) (map[string]json.RawMessage, error)
func NormalizeRawValues(fields []Field, values map[string]json.RawMessage) (map[string]json.RawMessage, error)
type Field
- func NonSecretFields(spec *manifest.SettingsSpec) ([]Field, error)
type Schema
- func CanonicalSchema(spec *manifest.SettingsSpec) (Schema, error)
- func CanonicalizeSchema(schema Schema) (Schema, error)
type Validation

Constants ¶

View Source

const (
	FieldString  = "string"
	FieldBoolean = "boolean"
	FieldNumber  = "number"
	FieldInteger = "integer"
	FieldEnum    = "enum"
	FieldSelect  = "select"
	FieldSecret  = "secret"
)

Variables ¶

View Source

var ErrInvalidSetting = errors.New("plugin setting is invalid")

Functions ¶

func CanonicalSchemaJSON ¶ added in v0.5.0

func CanonicalSchemaJSON(spec *manifest.SettingsSpec) ([]byte, error)

func DecodeValues ¶ added in v0.5.0

func DecodeValues(values map[string]json.RawMessage) (map[string]any, error)

func DefaultValues ¶ added in v0.5.0

func DefaultValues(fields []Field) (map[string]json.RawMessage, error)

func NormalizeRawValues ¶ added in v0.5.0

func NormalizeRawValues(fields []Field, values map[string]json.RawMessage) (map[string]json.RawMessage, error)

Types ¶

type Field ¶ added in v0.5.0

type Field struct {
	Key        string          `json:"key"`
	Type       string          `json:"type"`
	Scope      string          `json:"scope"`
	Options    []string        `json:"options,omitempty"`
	Default    json.RawMessage `json:"default,omitempty"`
	Validation *Validation     `json:"validation,omitempty"`
}

func NonSecretFields ¶ added in v0.5.0

func NonSecretFields(spec *manifest.SettingsSpec) ([]Field, error)

type Schema ¶ added in v0.5.0

type Schema struct {
	SchemaVersion int     `json:"schema_version"`
	Fields        []Field `json:"fields,omitempty"`
}

func CanonicalSchema ¶ added in v0.5.0

func CanonicalSchema(spec *manifest.SettingsSpec) (Schema, error)

func CanonicalizeSchema ¶ added in v0.5.0

func CanonicalizeSchema(schema Schema) (Schema, error)

type Validation ¶ added in v0.5.0

type Validation struct {
	Minimum   *float64 `json:"minimum,omitempty"`
	Maximum   *float64 `json:"maximum,omitempty"`
	MinLength *uint64  `json:"min_length,omitempty"`
	MaxLength *uint64  `json:"max_length,omitempty"`
}

Source Files ¶

View all Source files

settings.go

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