common

Documentation

Index

• Variables
• func ConvertSimpleVarsToBraces(input string) string
• func CustomExpandVariables(input string, fn func(key string) (value string, ok bool)) string
• func FailWith(message string)
• func FixHomeExpansion(path string) string
• func ForEachKnownPath(fn func(string, string))
• func ForEachPathsDPath(fn func(source string, path string))
• func ForEachScriptsDPath(fn func(originalSource, expandedSource string))
• func ForEachSourcedScript(input string, fn func(string))
• func ForEachVariableAssignment(key, input string, fn func(string))
• type CandidateSource
  • func NewNixCandidateSource(fs Filesystem, key string) CandidateSource
• type EnvSource
  • func NewEnvSource(varName string) *EnvSource
  • func (s *EnvSource) Orig() string
  • func (s *EnvSource) Source() string
  • func (s *EnvSource) Values() []string
• type Filesystem
• type Location
• type NixCandidateSource
  • func (s *NixCandidateSource) WhereSet(somePath string) *PathSetIn
• type OsFilesystem
  • func (*OsFilesystem) GetAbsolutePath(path string) string
  • func (f *OsFilesystem) PathStatus(path string) (bool, bool)
• type Output
  • func (e *Output) Set(v string) error
  • func (e *Output) String() string
  • func (e *Output) Type() string
• type PathSetIn
• type ResultRow
• type ResultsCalculator
  • func NewCustomResultsCalculator(fs Filesystem, source ValueSource, candidateSource CandidateSource) *ResultsCalculator
  • func NewResultsCalculator(fs Filesystem, source ValueSource) *ResultsCalculator
  • func (r *ResultsCalculator) CalculateResults() ([]ResultRow, error)
• type ValueSource

Variables

var AllOutputs []string = []string{
	string(OutputInteractive),
	string(OutputTable),
	string(OutputJSON),
	string(OutputCSV),
}

var Version string = "unknown"

Functions

func ConvertSimpleVarsToBraces

func ConvertSimpleVarsToBraces(input string) string

func CustomExpandVariables

func CustomExpandVariables(input string, fn func(key string) (value string, ok bool)) string

func FailWith

func FailWith(message string)

FailWith exits with an error message controllably

func FixHomeExpansion

func FixHomeExpansion(path string) string

func ForEachKnownPath

func ForEachKnownPath(fn func(string, string))

ForEachKnownPath iterates over expanded known paths if they're legitimate

func ForEachPathsDPath

func ForEachPathsDPath(fn func(source string, path string))

func ForEachScriptsDPath

func ForEachScriptsDPath(fn func(originalSource, expandedSource string))

func ForEachSourcedScript

func ForEachSourcedScript(input string, fn func(string))

func ForEachVariableAssignment

func ForEachVariableAssignment(key, input string, fn func(string))

Types

type CandidateSource

type CandidateSource interface {
	WhereSet(somePath string) *PathSetIn
}

func NewNixCandidateSource

func NewNixCandidateSource(fs Filesystem, key string) CandidateSource

type EnvSource

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

func NewEnvSource

func NewEnvSource(varName string) *EnvSource

func (*EnvSource) Orig

func (s *EnvSource) Orig() string

func (*EnvSource) Source

func (s *EnvSource) Source() string

func (*EnvSource) Values

func (s *EnvSource) Values() []string

type Filesystem

type Filesystem interface {
	GetAbsolutePath(path string) string
	PathStatus(path string) (bool, bool)
}

type Location

type Location struct {
	Original string
	Expanded string
}

type NixCandidateSource

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

func (*NixCandidateSource) WhereSet

func (s *NixCandidateSource) WhereSet(somePath string) *PathSetIn

type OsFilesystem

type OsFilesystem struct{}

func (*OsFilesystem) GetAbsolutePath

func (*OsFilesystem) GetAbsolutePath(path string) string

func (*OsFilesystem) PathStatus

func (f *OsFilesystem) PathStatus(path string) (bool, bool)

returns (exists, isDir)

type Output

type Output string

const (
	OutputInteractive Output = "interactive" // default
	OutputTable       Output = "table"
	OutputJSON        Output = "json"
	OutputCSV         Output = "csv"
)

func (*Output) Set

func (e *Output) Set(v string) error

func (*Output) String

func (e *Output) String() string

func (*Output) Type

func (e *Output) Type() string

type PathSetIn

type PathSetIn struct {
	What     Location
	WhereSet []Location // file it's potentially set in
}

type ResultRow

type ResultRow struct {
	Id               int      `json:"id"`
	Path             string   `json:"path"`
	ExpandedPath     string   `json:"expanded_path"`
	Exists           bool     `json:"exists"`
	IsDir            bool     `json:"is_dir"`
	Duplicates       []int    `json:"duplicates"`
	CandidateSources []string `json:"candidate_sources,omitempty"`
}

type ResultsCalculator

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

func NewCustomResultsCalculator

func NewCustomResultsCalculator(fs Filesystem, source ValueSource, candidateSource CandidateSource) *ResultsCalculator

func NewResultsCalculator

func NewResultsCalculator(fs Filesystem, source ValueSource) *ResultsCalculator

func (*ResultsCalculator) CalculateResults

func (r *ResultsCalculator) CalculateResults() ([]ResultRow, error)

type ValueSource

type ValueSource interface {
	// Source is the name/key of the value
	Source() string
	// Orig is the original string value
	Orig() string
	// Values is the split list from original value
	Values() []string
}