runmode

package
v0.0.0-...-5ce2981 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 2, 2022 License: MIT Imports: 0 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func InteractiveModes

func InteractiveModes() []string

InteractiveModes returns the list of names of available interactive run modes

func Map

func Map() map[string]RunMode

Map returns the list of available run modes as a map of strings

Types

type Check

type Check struct {
}

Check is a type of run mode allowing to verify configuration and parameters and exit

func (Check) AutoPushDefault

func (Check) AutoPushDefault() bool

AutoPushDefault returns the default value of git auto-push option with this run mode

func (Check) IsActive

func (Check) IsActive() bool

IsActive indicates if this run mode is actively running TCR

func (Check) IsInteractive

func (Check) IsInteractive() bool

IsInteractive indicates if this run mode allows user interaction

func (Check) Name

func (Check) Name() string

Name returns the name of this run mode

func (Check) NeedsCountdownTimer

func (Check) NeedsCountdownTimer() bool

NeedsCountdownTimer indicates if a countdown timer is needed with this run mode

type Log

type Log struct {
}

Log is a type of run mode allowing to print commit history

func (Log) AutoPushDefault

func (Log) AutoPushDefault() bool

AutoPushDefault returns the default value of git auto-push option with this run mode

func (Log) IsActive

func (Log) IsActive() bool

IsActive indicates if this run mode is actively running TCR

func (Log) IsInteractive

func (Log) IsInteractive() bool

IsInteractive indicates if this run mode allows user interaction

func (Log) Name

func (Log) Name() string

Name returns the name of this run mode

func (Log) NeedsCountdownTimer

func (Log) NeedsCountdownTimer() bool

NeedsCountdownTimer indicates if a countdown timer is needed with this run mode

type Mob

type Mob struct {
}

Mob is a type of run mode useful when the application is used by a mob of users

func (Mob) AutoPushDefault

func (Mob) AutoPushDefault() bool

AutoPushDefault returns the default value of git auto-push option with this run mode

func (Mob) IsActive

func (Mob) IsActive() bool

IsActive indicates if this run mode is actively running TCR

func (Mob) IsInteractive

func (Mob) IsInteractive() bool

IsInteractive indicates if this run mode allows user interaction

func (Mob) Name

func (Mob) Name() string

Name returns the name of this run mode

func (Mob) NeedsCountdownTimer

func (Mob) NeedsCountdownTimer() bool

NeedsCountdownTimer indicates if a countdown timer is needed with this run mode

type OneShot

type OneShot struct {
}

OneShot is a type of run mode allowing to run a single TCR cycle and exit

func (OneShot) AutoPushDefault

func (OneShot) AutoPushDefault() bool

AutoPushDefault returns the default value of git auto-push option with this run mode

func (OneShot) IsActive

func (OneShot) IsActive() bool

IsActive indicates if this run mode is actively running TCR

func (OneShot) IsInteractive

func (OneShot) IsInteractive() bool

IsInteractive indicates if this run mode allows user interaction

func (OneShot) Name

func (OneShot) Name() string

Name returns the name of this run mode

func (OneShot) NeedsCountdownTimer

func (OneShot) NeedsCountdownTimer() bool

NeedsCountdownTimer indicates if a countdown timer is needed with this run mode

type RunMode

type RunMode interface {
	Name() string
	AutoPushDefault() bool
	NeedsCountdownTimer() bool
	IsInteractive() bool
	IsActive() bool
}

RunMode is the interface that any run mode needs to satisfy to bee used by the TCR engine

type Solo

type Solo struct {
}

Solo is a type of run mode useful when the application is used by a single user

func (Solo) AutoPushDefault

func (Solo) AutoPushDefault() bool

AutoPushDefault returns the default value of git auto-push option with this run mode

func (Solo) IsActive

func (Solo) IsActive() bool

IsActive indicates if this run mode is actively running TCR

func (Solo) IsInteractive

func (Solo) IsInteractive() bool

IsInteractive indicates if this run mode allows user interaction

func (Solo) Name

func (Solo) Name() string

Name returns the name of this run mode

func (Solo) NeedsCountdownTimer

func (Solo) NeedsCountdownTimer() bool

NeedsCountdownTimer indicates if a countdown timer is needed with this run mode

type Stats

type Stats struct {
}

Stats is a type of run mode allowing to print TCR execution stats

func (Stats) AutoPushDefault

func (Stats) AutoPushDefault() bool

AutoPushDefault returns the default value of git auto-push option with this run mode

func (Stats) IsActive

func (Stats) IsActive() bool

IsActive indicates if this run mode is actively running TCR

func (Stats) IsInteractive

func (Stats) IsInteractive() bool

IsInteractive indicates if this run mode allows user interaction

func (Stats) Name

func (Stats) Name() string

Name returns the name of this run mode

func (Stats) NeedsCountdownTimer

func (Stats) NeedsCountdownTimer() bool

NeedsCountdownTimer indicates if a countdown timer is needed with this run mode

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL