config

Documentation

Overview

Package config loads and writes the committed skeeper project config.

Index

• Constants
• func CleanNamespace(namespace string) (string, error)
• func DefaultPatterns() []string
• func NormalizePatterns(patterns []string) ([]string, error)
• func Save(root string, cfg Config) error
• type Config
  • func Load(root string) (Config, error)
  • func (c Config) Normalize() (Config, error)
  • func (c Config) Validate() error
• type GuardrailSettings
• type HookSettings
• type HydratePolicy
  • func NormalizeHydratePolicy(policy HydratePolicy) (HydratePolicy, error)
• type HydrateRule
• type Namespace
  • func NormalizeNamespaces(namespaces []Namespace) ([]Namespace, error)
  • func (n Namespace) Includes(path string) bool
  • func (n Namespace) Owns(path string) bool
  • func (n Namespace) RespectsGitignore() bool
• type Settings
  • func NormalizeSettings(settings Settings) (Settings, error)

Constants

const (
	// Filename is the committed project config file.
	Filename = ".skeeper.yml"
	// NamespaceBranchSegment separates a sidecar namespace from branch-specific
	// sidecar refs.
	NamespaceBranchSegment = "__branches__"
	// DefaultGuardrailMaxFiles is the default broad-plan file threshold.
	DefaultGuardrailMaxFiles = 100
	// DefaultGuardrailMaxBytes is the default broad-plan byte threshold.
	DefaultGuardrailMaxBytes int64 = 10_485_760
	// DefaultPrePushTimeout is the default timeout for the read-only pre-push gate.
	DefaultPrePushTimeout = 30 * time.Second
	// DefaultAllowSkipEnv is the audited strict pre-commit bypass variable.
	DefaultAllowSkipEnv = "SKEEPER_SKIP"
)

Functions

func CleanNamespace

func CleanNamespace(namespace string) (string, error)

CleanNamespace validates a sidecar namespace and returns its canonical slash-separated form.

func DefaultPatterns

func DefaultPatterns() []string

DefaultPatterns returns the interactive init defaults.

func NormalizePatterns

func NormalizePatterns(patterns []string) ([]string, error)

NormalizePatterns validates and canonicalizes doublestar path globs while preserving their order.

func Save

func Save(root string, cfg Config) error

Save writes cfg to .skeeper.yml under root.

Types

type Config

type Config struct {
	Sidecar    string      `yaml:"sidecar"`
	Bootstrap  string      `yaml:"bootstrap,omitempty"`
	Settings   Settings    `yaml:"settings,omitempty"`
	Namespaces []Namespace `yaml:"namespaces"`
}

Config describes how a project mirrors spec files into its sidecar repo.

func Load

func Load(root string) (Config, error)

Load reads and validates .skeeper.yml from root.

func (Config) Normalize

func (c Config) Normalize() (Config, error)

Normalize validates cfg and returns the canonical config values that should drive runtime behavior.

func (Config) Validate

func (c Config) Validate() error

Validate checks that the config can drive deterministic v1 behavior.

type GuardrailSettings

type GuardrailSettings struct {
	MaxFiles int   `yaml:"max_files,omitempty"`
	MaxBytes int64 `yaml:"max_bytes,omitempty"`
}

GuardrailSettings bounds broad mutating plans.

type HookSettings

type HookSettings struct {
	PrePushTimeout string `yaml:"pre_push_timeout,omitempty"`
	AllowSkipEnv   string `yaml:"allow_skip_env,omitempty"`
}

HookSettings configures managed Git hooks.

type HydratePolicy

type HydratePolicy struct {
	OnLocalOnly string        `yaml:"on_local_only,omitempty"`
	OnModified  string        `yaml:"on_modified,omitempty"`
	Rules       []HydrateRule `yaml:"rules,omitempty"`
}

HydratePolicy configures namespace defaults for safe materialization.

func NormalizeHydratePolicy

func NormalizeHydratePolicy(policy HydratePolicy) (HydratePolicy, error)

NormalizeHydratePolicy validates and canonicalizes hydrate defaults.

type HydrateRule

type HydrateRule struct {
	Pattern     string `yaml:"pattern"`
	OnLocalOnly string `yaml:"on_local_only,omitempty"`
	OnModified  string `yaml:"on_modified,omitempty"`
}

HydrateRule configures hydrate defaults for a subset of paths.

type Namespace

type Namespace struct {
	Name             string        `yaml:"name"`
	Patterns         []string      `yaml:"patterns"`
	Exclude          []string      `yaml:"exclude,omitempty"`
	RespectGitignore *bool         `yaml:"respect_gitignore,omitempty"`
	Hydrate          HydratePolicy `yaml:"hydrate,omitempty"`
}

Namespace routes a set of project files into one sidecar namespace.

func NormalizeNamespaces

func NormalizeNamespaces(namespaces []Namespace) ([]Namespace, error)

NormalizeNamespaces validates and canonicalizes namespace routing rules.

func (Namespace) Includes

func (n Namespace) Includes(path string) bool

Includes reports whether path matches namespace's include patterns.

func (Namespace) Owns

func (n Namespace) Owns(path string) bool

Owns reports whether path belongs to namespace after applying excludes.

func (Namespace) RespectsGitignore

func (n Namespace) RespectsGitignore() bool

RespectsGitignore reports whether Git ignore sources should prune matches.

type Settings

type Settings struct {
	Guardrails GuardrailSettings `yaml:"guardrails,omitempty"`
	Hooks      HookSettings      `yaml:"hooks,omitempty"`
}

Settings describes operational defaults outside namespace ownership rules.

func NormalizeSettings

func NormalizeSettings(settings Settings) (Settings, error)

NormalizeSettings validates and fills operational defaults.