engine

Documentation

Index

• Constants
• type Action
• type ApplyOptions
• type CLIError
  • func (e *CLIError) Error() string
  • func (e *CLIError) Unwrap() error
• type Engine
  • func NewEngine() *Engine
  • func (e *Engine) Apply(ctx context.Context, cwd string, opts ApplyOptions) (Result, int, error)
• type Result
• type Summary

Constants

const (
	IncludeOriginSource   = "source"
	IncludeOriginExplicit = "explicit"

	IncludeMissingHintSourceMissing             = "source_missing"
	IncludeMissingHintSourceMissingTargetExists = "source_missing_target_exists"
)

Types

type Action

type Action struct {
	Op     string `json:"op"`
	Path   string `json:"path"`
	Status string `json:"status"`
}

type ApplyOptions

type ApplyOptions struct {
	From      string
	Include   string
	DryRun    bool
	Force     bool
	ForceLink bool
}

type CLIError

type CLIError struct {
	Code int
	Msg  string
	Err  error
}

func (*CLIError) Error

func (e *CLIError) Error() string

func (*CLIError) Unwrap

func (e *CLIError) Unwrap() error

type Engine

type Engine struct {
	// contains filtered or unexported fields
}

func NewEngine

func NewEngine() *Engine

func (*Engine) Apply

func (e *Engine) Apply(ctx context.Context, cwd string, opts ApplyOptions) (Result, int, error)

type Result

type Result struct {
	DryRun      bool     `json:"dry_run"`
	From        string   `json:"from"`
	To          string   `json:"to"`
	IncludeFile string   `json:"include_file"`
	Summary     Summary  `json:"summary"`
	Actions     []Action `json:"actions"`

	// Non-JSON metadata for human-readable CLI output.
	ResolvedIncludePath string `json:"-"`
	IncludeFound        bool   `json:"-"`
	IncludeOrigin       string `json:"-"`
	IncludeMissingHint  string `json:"-"`
	TargetIncludePath   string `json:"-"`
	PatternCount        int    `json:"-"`
}

type Summary

type Summary struct {
	Matched           int `json:"matched"`
	Copied            int `json:"copied,omitempty"`
	CopyPlanned       int `json:"copy_planned,omitempty"`
	Linked            int `json:"linked,omitempty"`
	LinkPlanned       int `json:"link_planned,omitempty"`
	SkippedSame       int `json:"skipped_same"`
	SkippedMissingSrc int `json:"skipped_missing_src"`
	Conflicts         int `json:"conflicts"`
	Errors            int `json:"errors"`
}