config

package

v0.56.2 Latest Latest Go to latest Published: Oct 30, 2026 License: Apache-2.0 Imports: 14 Imported by: 0

Details

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

Repository

github.com/nexssp/flow

Links

Open Source Insights

Documentation ¶

Overview ¶

Package config provides the @config and @config.load directives that populate meta["config"], which OnPreprocess forwards to the compiler as a compile-time key-value map.

Typical use:

@config:strict=true
@config {
  retries: 3       :cli="r,retries"
  timeout: "10s"   :cli="t"
}
@config.load:path="nexss.yml"

Index ¶

Constants
Variables
func Bundle(_ map[string]string) compiler.Bundle
func RegisterYAMLLoader(fn func([]byte) (map[string]any, error))

Constants ¶

View Source

const ID = "config"

Variables ¶

View Source

var ConfigDirective = compiler.Directive{
	Name:        "config",
	Example:     "@config:strict=true\n@config {\n  retries: 3 :cli=\"r\"\n}",
	Handler:     handleConfig,
	OpaqueBlock: true,
}

ConfigDirective parses both the single-line form `@config:key=value` and the block form `@config { key: value, ... }`. Each pair is written to meta["config"] under its key.

View Source

var ConfigLoadDirective = compiler.Directive{
	Name:    "config.load",
	Example: `@config.load:path="nexss.yml"`,
	Handler: handleConfigLoad,
}

ConfigLoadDirective parses `@config.load:path="file.yml" [prefix="x"]` and flattens the loaded document into meta["config"], joining nested keys with dots.

Functions ¶

func Bundle ¶

func Bundle(_ map[string]string) compiler.Bundle

func RegisterYAMLLoader ¶ added in v0.14.0

func RegisterYAMLLoader(fn func([]byte) (map[string]any, error))

RegisterYAMLLoader installs a YAML decoder. Called from the config_yaml bundle's init. Idempotent; later registrations win.

Types ¶

This section is empty.

Source Files ¶

View all Source files

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