clean

Documentation

Overview

Package clean provides a task to remove filesystem paths, e.g. output data like artifacts and reports from previous development, test, production and distribution builds.

Index

• type Option
  • func WithLimitToAppOutputDir(limitToAppOutputDir bool) Option
  • func WithPaths(paths ...string) Option
• type Options
  • func NewOptions(opts ...Option) *Options
• type Task
  • func New(proj project.Metadata, ac app.Config, opts ...Option) *Task
  • func (t *Task) Clean() ([]string, error)
  • func (t *Task) Name() string
  • func (t *Task) Options() task.Options

Types

type Option

type Option func(*Options)

Option is a task option.

func WithLimitToAppOutputDir

func WithLimitToAppOutputDir(limitToAppOutputDir bool) Option

WithLimitToAppOutputDir indicates whether only paths within the configured application output directory should be allowed.

func WithPaths

func WithPaths(paths ...string) Option

WithPaths sets the paths to remove. Note that only paths within the configured application output directory are allowed when WithLimitToAppOutputDir is enabled.

type Options

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

Options are task options.

func NewOptions

func NewOptions(opts ...Option) *Options

NewOptions creates new task options.

type Task

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

Task is a task to remove filesystem paths, e.g. output data like artifacts and reports from previous development, test, production and distribution builds.

func New

func New(proj project.Metadata, ac app.Config, opts ...Option) *Task

New creates a new task.

func (*Task) Clean

func (t *Task) Clean() ([]string, error)

Clean removes the configured paths. It returns an error of type *param.ErrGoCode for any error that occurs during the execution of the Go code.

func (*Task) Name

func (t *Task) Name() string

Name returns the task name.

func (*Task) Options

func (t *Task) Options() task.Options

Options returns the task options.