internal

Documentation

Index

• Constants
• func DefaultPath(f *file.File) util.Transformer[*file.File]
• func WithWasher(ctx context.Context, w *Washer) context.Context
• type GitIndex
  • func (gi *GitIndex) AfterTask(context.Context, *task.Result) error
  • func (gi *GitIndex) BeforeTask(context.Context, *spec.Tool, *file.File) error
  • func (gi *GitIndex) Close() (err error)
  • func (gi *GitIndex) Open(ctx context.Context) error
• type GitOption
  • func (g *GitOption) Set(str string) error
  • func (g GitOption) String() string
• type Harness
  • func NewHarness(ctx context.Context, config *HarnessConfig) (h *Harness, err error)
  • func (h *Harness) Close() (err error)
  • func (h *Harness) Run(ctx context.Context) (results []*task.Result, err error)
• type HarnessConfig
• type Observer
• type Pair
• type Washer
  • func GetWasher(ctx context.Context) *Washer
  • func (w *Washer) ChDir(context.Context) (err error)
  • func (w *Washer) FindFiles(ctx context.Context, in <-chan *file.File, out chan<- *file.File) error
  • func (w *Washer) GetFiles(ctx context.Context, gitOption GitOption) (transformers []util.Transformer[*file.File], err error)
  • func (*Washer) Logf(format string, args ...interface{})
  • func (w *Washer) Spec(ctx context.Context) (s *spec.Spec, err error)
  • func (w *Washer) SpecPath(ctx context.Context) (path string, err error)

Constants

const (
	EnvWasherDebug         = "WASHER_DEBUG"
	EnvWasherNoTool        = "WASHER_NO_TOOL"
	EnvWasherProgress      = "WASHER_PROGRESS"
	EnvWasherSpecification = "WASHER_SPECIFICATION"
)

Functions

func DefaultPath

func DefaultPath(f *file.File) util.Transformer[*file.File]

func WithWasher

func WithWasher(ctx context.Context, w *Washer) context.Context

Types

type GitIndex

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

func (*GitIndex) AfterTask

func (gi *GitIndex) AfterTask(context.Context, *task.Result) error

func (*GitIndex) BeforeTask

func (gi *GitIndex) BeforeTask(
	context.Context,
	*spec.Tool,
	*file.File,
) error

func (*GitIndex) Close

func (gi *GitIndex) Close() (err error)

func (*GitIndex) Open

func (gi *GitIndex) Open(ctx context.Context) error

type GitOption

type GitOption string

const (
	GitOptionAll     GitOption = "all"
	GitOptionChanged GitOption = "changed"
	GitOptionStaged  GitOption = "staged"
	GitOptionTracked GitOption = "tracked"
)

func (*GitOption) Set

func (g *GitOption) Set(str string) error

func (GitOption) String

func (g GitOption) String() string

type Harness

type Harness struct {
	HarnessConfig
	// contains filtered or unexported fields
}

func NewHarness

func NewHarness(
	ctx context.Context,
	config *HarnessConfig,
) (h *Harness, err error)

func (*Harness) Close

func (h *Harness) Close() (err error)

func (*Harness) Run

func (h *Harness) Run(ctx context.Context) (results []*task.Result, err error)

type HarnessConfig

type HarnessConfig struct {
	Backup        bool
	Dry           bool
	Exclude       []string
	ExplicitFiles []string
	GitOption     GitOption
	GitStash      bool
	Jobs          uint64
	Lock          bool
	Observers     []Observer
	Operation     task.Operation
	Tools         *spec.ToolSet
}

type Observer

type Observer interface {
	io.Closer

	Open(context.Context) error
	BeforeTask(context.Context, *spec.Tool, *file.File) error
	AfterTask(context.Context, *task.Result) error
}

type Pair

type Pair struct {
	Tool *spec.Tool
	File *file.File
}

type Washer

type Washer struct {
	Directory, OriginalDirectory string
	Specification                string
	Verbosity                    int
	// contains filtered or unexported fields
}

func GetWasher

func GetWasher(ctx context.Context) *Washer

func (*Washer) ChDir

func (w *Washer) ChDir(context.Context) (err error)

func (*Washer) FindFiles

func (w *Washer) FindFiles(
	ctx context.Context,
	in <-chan *file.File,
	out chan<- *file.File,
) error

func (*Washer) GetFiles

func (w *Washer) GetFiles(
	ctx context.Context,
	gitOption GitOption,
) (transformers []util.Transformer[*file.File], err error)

func (*Washer) Logf

func (*Washer) Logf(format string, args ...interface{})

func (*Washer) Spec

func (w *Washer) Spec(ctx context.Context) (s *spec.Spec, err error)

func (*Washer) SpecPath

func (w *Washer) SpecPath(ctx context.Context) (path string, err error)