config

type AuditConfig ¶

type AuditConfig struct {
	AllowedTypes        []string    `yaml:"allowedTypes"`
	AllowedScopes       []ScopeSpec `yaml:"allowedScopes"`
	SubjectMaxLength    *int        `yaml:"subjectMaxLength"`
	DependencyManifests []string    `yaml:"dependencyManifests"`
	DiffThreshold       *int        `yaml:"diffThreshold"`
	DomainDocStaleness  *bool       `yaml:"domainDocStaleness"`
	DomainCodeStaleness *bool       `yaml:"domainCodeStaleness"`
	UndocumentedDomain  *bool       `yaml:"undocumentedDomain"`
	PlainPunctuation    *bool       `yaml:"plainPunctuation"`
	UncommittedChanges  *bool       `yaml:"uncommittedChanges"`
}

AuditConfig tunes `awf audit` (ADR-0017). A nil *AuditConfig means all defaults; within it, a nil slice means "use the default", an explicit empty slice means "accept any / disabled" per field. Resolution and defaults live in internal/audit (audit.Resolve), which owns the audit domain semantics.

type BootstrapConfig ¶ added in v0.5.0

type BootstrapConfig struct {
	Enabled bool `yaml:"enabled"`
}

BootstrapConfig configures the rendered .awf/bootstrap.sh singleton (ADR-0040, relocated by ADR-0047). A nil *BootstrapConfig (key absent) and Enabled false both mean "do not render"; only Enabled true renders the artifact - a nested enable entry rather than a top-level scalar bool (the Alternatives table rejected the bare bool).

type CatalogTrim ¶

type CatalogTrim struct {
	Skills *[]string
	Docs   *[]string
}

CatalogTrim optionally overrides which catalog skills/docs a scaffolded config enables (ADR-0029 catalog trim). A nil *CatalogTrim - or a nil dimension within it - means "no selection: keep the curated-core default"; a non-nil dimension is the verbatim, fully-deselectable enable set (an empty slice deselects all).

type Config ¶

type Config struct {
	Prefix        string              `yaml:"prefix"`
	DocsDir       string              `yaml:"docsDir"`
	Vars          map[string]any      `yaml:"vars"`
	Skills        []string            `yaml:"skills"`
	Agents        []string            `yaml:"agents"`
	Docs          []string            `yaml:"docs"`
	Domains       []string            `yaml:"domains"`
	Tags          map[string]string   `yaml:"tags"`
	ContextIgnore []string            `yaml:"contextIgnore"`
	Targets       []string            `yaml:"targets"`
	Invariants    *InvariantConfig    `yaml:"invariants"`
	CurrentState  *CurrentStateConfig `yaml:"currentState"`
	Audit         *AuditConfig        `yaml:"audit"`
	Bootstrap     *BootstrapConfig    `yaml:"bootstrap"`
	Hooks         *HooksConfig        `yaml:"hooks"`
	Runner        *RunnerConfig       `yaml:"runner"`
	ProseGate     *ProseGateConfig    `yaml:"proseGate"`
	// contains filtered or unexported fields
}

Config is the skeleton config.yaml: global fields plus flat enable arrays. Presence of a name in Skills/Agents/Docs enables that artifact; per-artifact data/sections/local live in sidecars, not here. Targets is the adapter-runtime enable array (default ["claude"]); adapter artifacts render once per entry.

func Load(awfDir string) (*Config, error)

func Parse(awfDir string, b []byte) (*Config, error)

func (c *Config) HasSidecar(kind, name string) (bool, error)

func (c *Config) PartPath(kind, artifact, section string) string

func (c *Config) Sidecar(kind, name string) (Sidecar, error)

func (c *Config) Source() []byte

func (c *Config) Validate() error

type CurrentStateConfig ¶ added in v0.18.0

type CurrentStateConfig struct {
	Sources          []CurrentStateSource `yaml:"sources"`
	TestGlobs        []string             `yaml:"testGlobs"`
	TopicCoverage    string               `yaml:"topicCoverage"`
	TopicFanout      string               `yaml:"topicFanout"`
	MaxTopicsPerPath *int                 `yaml:"maxTopicsPerPath"`
	// contains filtered or unexported fields
}

CurrentStateConfig configures bridge-preparation validation for canonical current-state topics. It is deliberately separate from the legacy invariant authority, which remains active throughout the bridge tranche.

func (c *CurrentStateConfig) EffectiveMaxTopicsPerPath() int

func (c *CurrentStateConfig) UnmarshalYAML(node *yaml.Node) error

type CurrentStateSource ¶ added in v0.18.0

type CurrentStateSource struct {
	Globs  []string `yaml:"globs"`
	Marker string   `yaml:"marker"`
	Close  string   `yaml:"close"`
	// contains filtered or unexported fields
}

CurrentStateSource describes one marker-bearing source family. closeSet distinguishes an omitted close token from an explicitly empty one.

func (s *CurrentStateSource) UnmarshalYAML(node *yaml.Node) error

type GlobRewrite ¶ added in v0.12.0

type GlobRewrite struct {
	Key  string
	From string
}

A GlobRewrite records one no-slash glob scalar AnchorNoSlashGlobs anchored: Key is the config location, From the original pattern (rewritten to `**/<From>`).

func AnchorNoSlashGlobs(src []byte) ([]byte, []GlobRewrite, error)

type HooksConfig ¶ added in v0.6.0

type HooksConfig struct {
	Enabled bool `yaml:"enabled"`
}

HooksConfig configures the rendered .awf/hooks/ payload singleton (ADR-0048): three inert git-hook payload scripts adopters wire into hook setups they own. BootstrapConfig semantics: a nil *HooksConfig (key absent) and Enabled false both mean "do not render"; only Enabled true renders the payloads. The key reuses the name the schema-4 drop-hooks migration stripped (ADR-0032); the legacy array shape never reaches this struct - gated commands migrate first, ungated ones fail loudly on the strict parser's type error.

type InvariantConfig ¶

type InvariantConfig struct {
	Disabled  bool              `yaml:"disabled"`
	Sources   []InvariantSource `yaml:"sources"`
	TestGlobs []string          `yaml:"testGlobs"`
}

InvariantConfig configures language-agnostic invariant backing. A nil *InvariantConfig (key absent) means "unchecked"; Disabled is the explicit opt-out; a non-empty Sources enables enforcement.

TestGlobs scopes the proof `invariant:` marker to test files (ADR-0105): when non-empty, a proof marker backs a slug only in a file matching one of these anchored globs; when empty or absent, backing falls back to source-glob scope (the pre-ADR-0105 semantics). TestGlobs is an inert optional field within the current schema - an absent value degrades to the fallback, so it needs no schema-generation bump.

type InvariantSource ¶

type InvariantSource struct {
	Globs  []string `yaml:"globs"`
	Marker string   `yaml:"marker"`
	Close  string   `yaml:"close"`
}

InvariantSource pairs anchored path globs (ADR-0077; matched against a file's slash-separated repo-relative path) with the literal comment marker that prefixes a backing `invariant: <slug>` tag. Close is the optional literal close token for block-comment markers (`-->`, `*/`): when non-empty, one trailing token (plus surrounding whitespace) is stripped from a matched marker line before tag parsing (ADR-0121). Additive and optional - empty means no stripping - so no schema-generation bump.

type ProseExemption ¶ added in v0.18.0

type ProseExemption struct {
	Path      string `yaml:"path"`
	Codepoint string `yaml:"codepoint"`
	Count     *int   `yaml:"count"`
}

ProseExemption exempts one codepoint in one path. Codepoint is spelled "U+2014", never the character itself: config.yaml is a tracked file the scan reads, so a typed glyph here would be a finding against the file that configures the exemptions. A nil Count permits any number of occurrences; a non-nil Count pins the expected number, so an added occurrence in an exempt file still fails.

type ProseGateConfig ¶ added in v0.18.0

type ProseGateConfig struct {
	Enabled    bool             `yaml:"enabled"`
	Exemptions []ProseExemption `yaml:"exemptions"`
}

ProseGateConfig configures `awf prose-gate` (ADR-0119): a presence-level scan of every tracked text file for the seven banned typographic punctuation substitutes. BootstrapConfig semantics: a nil *ProseGateConfig (key absent) and Enabled false both mean "the command exits zero without scanning". The default is off because the scan blocks a commit, and a tree that has never been swept would fail it on the day it lands.

type RunnerConfig ¶ added in v0.18.0

type RunnerConfig struct {
	Enabled bool `yaml:"enabled"`
}

RunnerConfig configures the rendered command-runner singleton `x` (ADR-0101): a co-owned file (ADR-0100) whose awf-verb dispatch awf owns and whose project verbs live in in-place-editable sections the adopter fills. Like the bootstrap/hooks toggles, a nil *RunnerConfig (key absent) and Enabled false both mean "do not render"; only Enabled true renders the runner. Additive and default-off - no schema-generation migration, and adopters opt in explicitly.

type ScopeSpec ¶ added in v0.8.0

type ScopeSpec struct {
	Name    string `yaml:"name"`
	Meaning string `yaml:"meaning"`
}

ScopeSpec is one allowed commit scope: a name and an optional human meaning. In config a scope is written either as a bare string (name only) or a {name, meaning} mapping (ADR-0056).

func (s *ScopeSpec) UnmarshalYAML(n *yaml.Node) error

type SectionOverride ¶

type SectionOverride struct {
	Drop bool `yaml:"drop"`
}

SectionOverride is a sidecar's per-section override. Body replacement is by convention part only; the field set is deliberately just Drop. touches-invariant: no-replacewith - SectionOverride field set omits replaceWith; proof in config_test.go

type Sidecar ¶

type Sidecar struct {
	Data     map[string]any             `yaml:"data"`
	Sections map[string]SectionOverride `yaml:"sections"`
	Local    bool                       `yaml:"local"`
	// Paths declares a domain's file territory as anchored path globs
	// (ADR-0077); read only from domain sidecars, inert on other kinds.
	Paths []string `yaml:"paths"`
}

Sidecar holds a single target's non-prose configuration: structured render data, per-section overrides, and the local flag. It lives at <awfDir>/<kind>/<name>.yaml (agents-doc: <awfDir>/agents-doc.yaml). An absent sidecar is the zero Sidecar (publication-safe: empty data/sections).

type Skeleton ¶

type Skeleton struct {
	Prefix     string            `yaml:"prefix"`
	Vars       map[string]string `yaml:"vars"`
	Skills     []string          `yaml:"skills"`
	Agents     []string          `yaml:"agents"`
	Docs       []string          `yaml:"docs"`
	Audit      *SkeletonAudit    `yaml:"audit,omitempty"`
	Invariants *InvariantConfig  `yaml:"invariants,omitempty"`
	Bootstrap  *BootstrapConfig  `yaml:"bootstrap,omitempty"`
	Hooks      *HooksConfig      `yaml:"hooks,omitempty"`
}

Skeleton is the input to MarshalSkeleton: the fields a freshly-scaffolded .awf/config.yaml carries. Vars is typed map[string]string (not map[string]any) so a nil/null var value is unrepresentable - the scaffold seeds each var with an empty string, which marshals as `x: ""`. A nil interface would marshal as `x: null` and decode back to a nil value that renders as "<no value>", tripping the publication-safe check (ADR-0026 Decision 3).

type SkeletonAudit ¶ added in v0.6.0

type SkeletonAudit struct {
	AllowedScopes []string `yaml:"allowedScopes"`
}

SkeletonAudit is the audit block a scaffold can seed (ADR-0051): only allowedScopes - the one audit field init collects. Deliberately not *AuditConfig, whose zero-value fields would serialize as explicit settings.