settingsdef

package

v0.1.0 Latest Latest Go to latest Published: Sep 13, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Details

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

Repository

github.com/aidarbn/platform-go

Links

Open Source Insights

Documentation ¶

Overview ¶

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

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
func Load(path string) (settingsx.Schema, error)
func Parse(raw []byte) (settingsx.Schema, error)

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.

Source Files ¶

View all Source files

parse.go

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