settingsdef

package
v0.5.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 17, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package settingsdef reads settings.yaml, the business settings schema of a project.

The format is taply's configuration schema: a root of settings (or configs, as taply names it), groups that may nest, a _description per group, and per setting a type, a default, a description and requires_restart. On top of it come min, max, options and title. A taply schema is read as is.

The file is read by platformgo only: at runtime the project uses the generated Go code, so a typo in the schema is a generation error rather than a production one.

Index

Constants

View Source
const FileName = "settings.yaml"

FileName is the default schema file in the project root.

Variables

This section is empty.

Functions

func Load

func Load(path string) (settingsx.Schema, error)

Load reads the schema from a file.

func Parse

func Parse(raw []byte) (settingsx.Schema, error)

Parse reads the schema from bytes.

Types

This section is empty.

Jump to

Keyboard shortcuts

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