plumber

Nov 18, 2023

Changes in this version

+ func InlineTemplate[Ctx any](tmpl string, ctx Ctx) (string, error)

Nov 18, 2023

Changes in this version

type Plumber

+ func (p *Plumber) SetFormatter(formatter *logger.Formatter) *Plumber

Nov 18, 2023

Changes in this version

type Command

+ func (c *Command[Pipe]) SetJobWrapper(fn JobWrapperFn) *Command[Pipe]

Nov 5, 2023

Changes in this version

type Command

+ func (c *Command[Pipe]) ShouldRunBefore(fn CommandFn[Pipe]) *Command[Pipe]

Mar 6, 2023

Changes in this version

+ type CommandStatus struct

+ type StatusStopCases struct

+ type TaskStatus struct

Dec 12, 2022

Changes in this version

+ func ParseEnvironmentVariablesToMap() map[string]string

Dec 2, 2022

Changes in this version

type Plumber

+ func (p *Plumber) SetTerminatorTimeout(timeout time.Duration) *Plumber

Nov 23, 2022

Changes in this version

+ const COMMAND_RETRY_DELAY

type Command

+ func (c *Command[Pipe]) HasExited() bool

+ func (c *Command[Pipe]) HasFailed() bool

+ func (c *Command[Pipe]) SetRetries(retries int, always bool, delay time.Duration) *Command[Pipe]

Nov 22, 2022

Changes in this version

type DocumentationOptions

+ MarkdownBehead int

Nov 22, 2022

Changes in this version

+ func EditCliFlag(flags []cli.Flag, fn func(f Flag) bool, apply func(f Flag) Flag) []cli.Flag

Nov 22, 2022

Changes in this version

+ func OverwriteCliFlag(flags []cli.Flag, fn func(f Flag) bool, apply func(f Flag) Flag) []cli.Flag

Nov 22, 2022

Changes in this version

type DocumentationOptions

+ EmbeddedMarkdownOutputFile string

Nov 22, 2022

Changes in this version

+ type DocumentationOptions struct

+ ExcludeEnvironmentVariables bool

+ ExcludeFlags bool

+ ExcludeHelpCommand bool

+ MarkdownOutputFile string

type Plumber

+ func (p *Plumber) Set(fn PlumberFn) *Plumber

+ func (p *Plumber) SetDelimiter(delimiter string) *Plumber

+ func (p *Plumber) SetDeprecationNotices(notices []DeprecationNotice) *Plumber

+ func (p *Plumber) SetDocumentationOptions(options DocumentationOptions) *Plumber

+ type PlumberFn func(p *Plumber) error

Nov 21, 2022

Changes in this version

+ func TemplateFuncMap() template.FuncMap

Nov 20, 2022

Changes in this version

type Plumber

+ func NewPlumber(fn PlumberNewFn) *Plumber

+ type PlumberNewFn func(a *Plumber) *cli.App

type TaskList

+ func NewTaskList(p *Plumber) *TaskList[Pipe]

Nov 20, 2022

Changes in this version

+ type PlumberOptions struct

type TaskList

+ func (t *TaskList[Pipe]) SetRuntimeDepth(depth int) *TaskList[Pipe]

Nov 17, 2022

Changes in this version

type TaskList

+ Name string

+ func (t *TaskList[Pipe]) IsDisabled() bool

+ func (t *TaskList[Pipe]) IsSkipped() bool

+ func (t *TaskList[Pipe]) SetName(names ...string) *TaskList[Pipe]

+ func (t *TaskList[Pipe]) ShouldDisable(fn TaskListPredicateFn[Pipe]) *TaskList[Pipe]

+ func (t *TaskList[Pipe]) ShouldSkip(fn TaskListPredicateFn[Pipe]) *TaskList[Pipe]

+ type TaskListOptions struct

+ Disable TaskListPredicateFn[Pipe]

+ Skip TaskListPredicateFn[Pipe]

Oct 30, 2022

Changes in this version

+ const CLI_FLAGS_CATEGORY

+ const LOG_FIELD_CONTEXT

+ const LOG_FIELD_STATUS

+ const LOG_LEVEL_DEBUG

+ const LOG_LEVEL_DEFAULT

+ const LOG_LEVEL_ERROR

+ const LOG_LEVEL_FATAL

+ const LOG_LEVEL_INFO

+ const LOG_LEVEL_PANIC

+ const LOG_LEVEL_TRACE

+ const LOG_LEVEL_WARN

+ const MARK_ROUTINE

+ var CliDefaultFlags = []cli.Flag

+ type AppChannel struct

+ CustomErr chan ErrorWithLogger

+ CustomFatal chan ErrorWithLogger

+ Err chan error

+ Exit *broadcaster.Broadcaster[int]

+ Fatal chan error

+ Interrupt chan os.Signal

+ type AppEnvironment struct

+ CI bool

+ Debug bool

+ type Command struct

+ Command *exec.Cmd

+ Log *logrus.Entry

+ Plumber *Plumber

+ func NewCommand(task *Task[Pipe], command string, args ...string) *Command[Pipe]

+ func (c *Command[Pipe]) AddSelfToTheParentTask(pt *Task[Pipe]) *Command[Pipe]

+ func (c *Command[Pipe]) AddSelfToTheTask() *Command[Pipe]

+ func (c *Command[Pipe]) AppendArgs(args ...string) *Command[Pipe]

+ func (c *Command[Pipe]) AppendDirectEnvironment(environment ...string) *Command[Pipe]

+ func (c *Command[Pipe]) AppendEnvironment(environment map[string]string) *Command[Pipe]

+ func (c *Command[Pipe]) EnableStreamRecording() *Command[Pipe]

+ func (c *Command[Pipe]) EnableTerminator() *Command[Pipe]

+ func (c *Command[Pipe]) EnsureIsAlive() *Command[Pipe]

+ func (c *Command[Pipe]) GetCombinedStream() []string

+ func (c *Command[Pipe]) GetFormattedCommand() string

+ func (c *Command[Pipe]) GetStderrStream() []string

+ func (c *Command[Pipe]) GetStdoutStream() []string

+ func (c *Command[Pipe]) IsDisabled() bool

+ func (c *Command[Pipe]) Job() Job

+ func (c *Command[Pipe]) Run() error

+ func (c *Command[Pipe]) RunSet() error

+ func (c *Command[Pipe]) Set(fn CommandFn[Pipe]) *Command[Pipe]

+ func (c *Command[Pipe]) SetDir(dir string) *Command[Pipe]

+ func (c *Command[Pipe]) SetIgnoreError() *Command[Pipe]

+ func (c *Command[Pipe]) SetLogLevel(stdout LogLevel, stderr LogLevel, lifetime LogLevel) *Command[Pipe]

+ func (c *Command[Pipe]) SetMaskOsEnvironment() *Command[Pipe]

+ func (c *Command[Pipe]) SetOnTerminator(fn CommandFn[Pipe]) *Command[Pipe]

+ func (c *Command[Pipe]) SetPath(dir string) *Command[Pipe]

+ func (c *Command[Pipe]) ShouldDisable(fn TaskPredicateFn[Pipe]) *Command[Pipe]

+ func (c *Command[Pipe]) ShouldRunAfter(fn CommandFn[Pipe]) *Command[Pipe]

+ type CommandFn func(*Command[Pipe]) error

+ type CommandOptions struct

+ Disable TaskPredicateFn[Pipe]

+ type DeprecationNotice struct

+ Environment []string

+ Flag []string

+ Level LogLevel

+ Message string

+ type ErrorWithLogger struct

+ Err error

+ Log *logrus.Entry

+ type GuardHandlerFn func(*TaskList[Pipe])

+ type Job = floc.Job

+ type JobPredicate = floc.Predicate

+ type JobWrapperFn func(job Job) Job

+ type LogLevel = logrus.Level

+ type Plumber struct

+ Channel AppChannel

+ Cli *cli.App

+ DeprecationNotices []DeprecationNotice

+ DocsExcludeEnvironmentVariables bool

+ DocsExcludeFlags bool

+ DocsExcludeHelpCommand bool

+ DocsFile string

+ Environment AppEnvironment

+ Log *logrus.Logger

+ func (p *Plumber) AppendFlags(flags ...[]cli.Flag) []cli.Flag

+ func (p *Plumber) AppendSecrets(secrets ...string) *Plumber

+ func (p *Plumber) EnableTerminator() *Plumber

+ func (p *Plumber) New(fn func(a *Plumber) *cli.App) *Plumber

+ func (p *Plumber) RegisterTerminated() *Plumber

+ func (p *Plumber) RegisterTerminator() *Plumber

+ func (p *Plumber) Run()

+ func (p *Plumber) SendCustomError(log *logrus.Entry, err error) *Plumber

+ func (p *Plumber) SendCustomFatal(log *logrus.Entry, err error) *Plumber

+ func (p *Plumber) SendError(err error) *Plumber

+ func (p *Plumber) SendExit(code int) *Plumber

+ func (p *Plumber) SendFatal(err error) *Plumber

+ func (p *Plumber) SendTerminate(sig os.Signal, code int)

+ func (p *Plumber) SetOnTerminate(fn PlumberOnTerminateFn) *Plumber

+ func (p *Plumber) Terminate(code int)

+ type PlumberOnTerminateFn func() error

+ type Result = floc.Result

+ const TASK_ANY

+ const TASK_CANCELLED

+ const TASK_COMPLETED

+ const TASK_FAILED

+ type ResultMask = floc.ResultMask

+ type Task struct

+ Channel *AppChannel

+ Control floc.Control

+ Lock *sync.RWMutex

+ Log *logrus.Entry

+ Name string

+ Pipe *Pipe

+ Plumber *Plumber

+ func NewTask(tl *TaskList[Pipe], name ...string) *Task[Pipe]

+ func (t *Task[Pipe]) AddCommands(commands ...*Command[Pipe]) *Task[Pipe]

+ func (t *Task[Pipe]) AddSelfToTheParent(fn func(pt *Task[Pipe], st *Task[Pipe])) *Task[Pipe]

+ func (t *Task[Pipe]) AddSelfToTheParentAsParallel() *Task[Pipe]

+ func (t *Task[Pipe]) AddSelfToTheParentAsSequence() *Task[Pipe]

+ func (t *Task[Pipe]) CreateCommand(command string, args ...string) *Command[Pipe]

+ func (t *Task[Pipe]) CreateSubtask(name ...string) *Task[Pipe]

+ func (t *Task[Pipe]) EnableTerminator() *Task[Pipe]

+ func (t *Task[Pipe]) ExtendSubtask(fn JobWrapperFn) *Task[Pipe]

+ func (t *Task[Pipe]) GetCommandJobAsJobParallel() Job

+ func (t *Task[Pipe]) GetCommandJobAsJobSequence() Job

+ func (t *Task[Pipe]) GetCommandJobs() []Job

+ func (t *Task[Pipe]) GetCommands() []*Command[Pipe]

+ func (t *Task[Pipe]) GetSubtasks() Job

+ func (t *Task[Pipe]) HasParent() bool

+ func (t *Task[Pipe]) IsDisabled() bool

+ func (t *Task[Pipe]) IsMarkedAsRoutine() bool

+ func (t *Task[Pipe]) IsSkipped() bool

+ func (t *Task[Pipe]) Job() Job

+ func (t *Task[Pipe]) Run() error

+ func (t *Task[Pipe]) RunCommandJobAsJobParallel() error

+ func (t *Task[Pipe]) RunCommandJobAsJobParallelWithExtension(fn JobWrapperFn) error

+ func (t *Task[Pipe]) RunCommandJobAsJobSequence() error

+ func (t *Task[Pipe]) RunCommandJobAsJobSequenceWithExtension(fn JobWrapperFn) error

+ func (t *Task[Pipe]) RunSubtasks() error

+ func (t *Task[Pipe]) RunSubtasksWithExtension(fn func(job Job) Job) error

+ func (t *Task[Pipe]) SendError(err error) *Task[Pipe]

+ func (t *Task[Pipe]) SendExit(code int) *Task[Pipe]

+ func (t *Task[Pipe]) SendFatal(err error) *Task[Pipe]

+ func (t *Task[Pipe]) Set(fn TaskFn[Pipe]) *Task[Pipe]

+ func (t *Task[Pipe]) SetJobWrapper(fn JobWrapperFn) *Task[Pipe]

+ func (t *Task[Pipe]) SetMarks(marks ...string) *Task[Pipe]

+ func (t *Task[Pipe]) SetOnTerminator(fn TaskFn[Pipe]) *Task[Pipe]

+ func (t *Task[Pipe]) SetSubtask(job Job) *Task[Pipe]

+ func (t *Task[Pipe]) ShouldDisable(fn TaskPredicateFn[Pipe]) *Task[Pipe]

+ func (t *Task[Pipe]) ShouldRunAfter(fn TaskFn[Pipe]) *Task[Pipe]

+ func (t *Task[Pipe]) ShouldRunBefore(fn TaskFn[Pipe]) *Task[Pipe]

+ func (t *Task[Pipe]) ShouldSkip(fn TaskPredicateFn[Pipe]) *Task[Pipe]

+ func (t *Task[Pipe]) ToParent(parent *Task[Pipe], fn func(pt *Task[Pipe], st *Task[Pipe])) *Task[Pipe]

+ type TaskFn func(t *Task[Pipe]) error

+ type TaskList struct

+ Channel *AppChannel

+ CliContext *cli.Context

+ Control floc.Control

+ Lock *sync.RWMutex

+ Log *logrus.Logger

+ Pipe Pipe

+ Plumber *Plumber

+ Tasks Job

+ func (t *TaskList[Pipe]) CreateBasicJob(fn func() error) Job

+ func (t *TaskList[Pipe]) CreateJob(fn func(tl *TaskList[Pipe]) error) Job

+ func (t *TaskList[Pipe]) CreateTask(name ...string) *Task[Pipe]

+ func (t *TaskList[Pipe]) GetTasks() Job

+ func (t *TaskList[Pipe]) GuardAlways(job Job) Job

+ func (t *TaskList[Pipe]) GuardIgnorePanic(job Job) Job

+ func (t *TaskList[Pipe]) GuardOnPanic(job Job, fn GuardHandlerFn[Pipe]) Job

+ func (t *TaskList[Pipe]) GuardOnTimeout(job Job, fn GuardHandlerFn[Pipe], timeout time.Duration) Job

+ func (t *TaskList[Pipe]) GuardPanic(job Job) Job

+ func (t *TaskList[Pipe]) GuardResume(job Job, mask Result) Job

+ func (t *TaskList[Pipe]) GuardTimeout(job Job, timeout time.Duration) Job

+ func (t *TaskList[Pipe]) Job() Job

+ func (t *TaskList[Pipe]) JobBackground(job Job) Job

+ func (t *TaskList[Pipe]) JobDelay(job Job, delay time.Duration) Job

+ func (t *TaskList[Pipe]) JobElse(job Job) Job

+ func (t *TaskList[Pipe]) JobIf(predicate JobPredicate, jobs ...Job) Job

+ func (t *TaskList[Pipe]) JobIfNot(predicate JobPredicate, jobs ...Job) Job

+ func (t *TaskList[Pipe]) JobLoop(job Job) Job

+ func (t *TaskList[Pipe]) JobLoopWithWaitAfter(job Job, delay time.Duration) Job

+ func (t *TaskList[Pipe]) JobParallel(jobs ...Job) Job

+ func (t *TaskList[Pipe]) JobRepeat(job Job, times int) Job

+ func (t *TaskList[Pipe]) JobSequence(jobs ...Job) Job

+ func (t *TaskList[Pipe]) JobThen(job Job) Job

+ func (t *TaskList[Pipe]) JobWait(predicate JobPredicate, sleep time.Duration) Job

+ func (t *TaskList[Pipe]) JobWaitForTerminator() Job

+ func (t *TaskList[Pipe]) JobWhile(predicate JobPredicate, job Job) Job

+ func (t *TaskList[Pipe]) New(p *Plumber) *TaskList[Pipe]

+ func (t *TaskList[Pipe]) NewResultMask(mask Result) ResultMask

+ func (t *TaskList[Pipe]) Predicate(fn TaskListPredicateFn[Pipe]) JobPredicate

+ func (t *TaskList[Pipe]) PredicateAnd(predicates ...JobPredicate) JobPredicate

+ func (t *TaskList[Pipe]) PredicateNot(predicate JobPredicate) JobPredicate

+ func (t *TaskList[Pipe]) PredicateOr(predicates ...JobPredicate) JobPredicate

+ func (t *TaskList[Pipe]) PredicateXor(predicates ...JobPredicate) JobPredicate

+ func (t *TaskList[Pipe]) Run() error

+ func (t *TaskList[Pipe]) RunJobs(job Job) error

+ func (t *TaskList[Pipe]) Set(fn TaskListJobFn[Pipe]) *TaskList[Pipe]

+ func (t *TaskList[Pipe]) SetCliContext(ctx *cli.Context) *TaskList[Pipe]

+ func (t *TaskList[Pipe]) SetDelimiter(delimiter string) *TaskList[Pipe]

+ func (t *TaskList[Pipe]) SetTasks(tasks Job) *TaskList[Pipe]

+ func (t *TaskList[Pipe]) ShouldRunAfter(fn TaskListFn[Pipe]) *TaskList[Pipe]

+ func (t *TaskList[Pipe]) ShouldRunBefore(fn TaskListFn[Pipe]) *TaskList[Pipe]

+ func (t *TaskList[Pipe]) Validate(data TaskListData) error

+ type TaskListData interface

+ type TaskListFn func(*TaskList[Pipe]) error

+ type TaskListJobFn func(*TaskList[Pipe]) Job

+ type TaskListPredicateFn func(*TaskList[Pipe]) bool

+ type TaskOptions struct

+ Disable TaskPredicateFn[Pipe]

+ Skip TaskPredicateFn[Pipe]

+ type TaskPredicateFn func(t *Task[Pipe]) bool

+ type Terminator struct

+ Enabled bool

+ Lock *sync.RWMutex

+ ShouldTerminate *broadcaster.Broadcaster[os.Signal]

+ Terminated *broadcaster.Broadcaster[bool]