initspec

package
v0.36.1 Latest Latest
Warning

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

Go to latest
Published: Aug 13, 2026 License: AGPL-3.0 Imports: 10 Imported by: 0

Documentation

Overview

Package initspec resolves awf init answers against the catalog's value descriptors and emits the descriptor schema (ADR-0029). It bridges the catalog's VarDescriptor set to a resolved (vars, catalog-trim) pair plus the commit-scope list via explicit answers, an optional line-based prompter, or the silent default.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Describe

func Describe(descs []catalog.VarDescriptor) ([]byte, error)

Describe marshals the descriptor set as JSON ({"descriptors": [...]}) for `awf init --describe`. An empty Target is normalized to "var".

func MergeSetFlags

func MergeSetFlags(base map[string]string, sets []string) error

MergeSetFlags overlays "key=value" strings onto base (later wins).

func ParseAnswersFile

func ParseAnswersFile(b []byte) (map[string]string, error)

ParseAnswersFile parses a flat key→value answer map from JSON or YAML bytes.

func Resolve

func Resolve(descs []catalog.VarDescriptor, answers map[string]string, in io.Reader, out io.Writer, interactive bool, needed func() (map[string]bool, error)) (map[string]string, []string, error)

Resolve maps descriptors and answers to a vars map and the resolved commit-scope list. For a string or enum descriptor the value is the explicit answer if present; otherwise an interactive prompt when applicable; otherwise empty. A nil needed filter prompts for every descriptor.

Types

type Outcome added in v0.30.0

type Outcome struct {
	ConfigPath     string
	ExistingConfig bool
	IgnoredAnswers bool
	Sync           presentation.Mutation
	Advisories     []string
	NextActions    []string
}

Outcome is the complete ordinary result of one successful initialization. It combines config adoption, sync mutation, advisories, and ordered next actions without owning any mutation behavior.

func (Outcome) Document added in v0.30.0

func (o Outcome) Document() (presentation.Document, error)

Document maps a successful init outcome into one complete Mutation.

Jump to

Keyboard shortcuts

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