Documentation
¶
Overview ¶
Package clean provides a spell incantation to remove directories in a filesystem. It implements spell.GoCode and can be used without a cast.Caster.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Option ¶
type Option func(*Options)
Option is a clean.Spell option.
func WithLimitToAppOutputDir ¶
WithLimitToAppOutputDir indicates whether only paths within the configured application output directory should be allowed.
type Options ¶
type Options struct {
// contains filtered or unexported fields
}
Options are clean.Spell options.
func NewOptions ¶
NewOptions creates new clean.Spell options.
type Spell ¶
type Spell struct {
// contains filtered or unexported fields
}
Spell is a spell incantation to remove directories in a filesystem. It is of kind spell.KindGoCode and can be used without a cast.Caster.
func New ¶
New creates a new spell incantation to remove the configured filesystem paths, e.g. output data like artifacts and reports from previous development, test, production and distribution builds.
func (*Spell) Clean ¶
Clean removes the configured paths. It returns an error of type *spell.ErrGoCode for any error that occurs during the execution of the Go code.
Source Files