Documentation
¶
Index ¶
- Variables
- func AddToCommitMessageBody(ctx context.Context, sv string) context.Context
- func GetAlias(ctx context.Context) string
- func GetCommitMessage(ctx context.Context) string
- func GetCommitMessageBody(ctx context.Context) string
- func GetCommitMessageFull(ctx context.Context) string
- func GetCommitTimestamp(ctx context.Context) time.Time
- func GetEmail(ctx context.Context) string
- func GetImportFunc(ctx context.Context) store.ImportCallback
- func GetUsername(ctx context.Context) string
- func HasAlias(ctx context.Context) bool
- func HasAlwaysYes(ctx context.Context) bool
- func HasCommitMessage(ctx context.Context) bool
- func HasCommitMessageBody(ctx context.Context) bool
- func HasCommitTimestamp(ctx context.Context) bool
- func HasForce(ctx context.Context) bool
- func HasGitCommit(ctx context.Context) bool
- func HasGitInit(ctx context.Context) bool
- func HasImportFunc(ctx context.Context) bool
- func HasInteractive(ctx context.Context) bool
- func HasNoNetwork(ctx context.Context) bool
- func HasPasswordCallback(ctx context.Context) bool
- func HasPasswordPurgeCallback(ctx context.Context) bool
- func HasProgressCallback(ctx context.Context) bool
- func HasShowParsing(ctx context.Context) bool
- func HasStdin(ctx context.Context) bool
- func HasTerminal(ctx context.Context) bool
- func IsAlwaysYes(ctx context.Context) bool
- func IsForce(ctx context.Context) bool
- func IsGitCommit(ctx context.Context) bool
- func IsGitInit(ctx context.Context) bool
- func IsHidden(ctx context.Context) bool
- func IsInteractive(ctx context.Context) bool
- func IsNoNetwork(ctx context.Context) bool
- func IsShowParsing(ctx context.Context) bool
- func IsStdin(ctx context.Context) bool
- func IsTerminal(ctx context.Context) bool
- func WithAlias(ctx context.Context, alias string) context.Context
- func WithAlwaysYes(ctx context.Context, bv bool) context.Context
- func WithCommitMessage(ctx context.Context, sv string) context.Context
- func WithCommitTimestamp(ctx context.Context, ts time.Time) context.Context
- func WithEmail(ctx context.Context, sv string) context.Context
- func WithForce(ctx context.Context, bv bool) context.Context
- func WithGitCommit(ctx context.Context, bv bool) context.Context
- func WithGitInit(ctx context.Context, bv bool) context.Context
- func WithGlobalFlags(c *cli.Context) context.Context
- func WithHidden(ctx context.Context, hidden bool) context.Context
- func WithImportFunc(ctx context.Context, imf store.ImportCallback) context.Context
- func WithInteractive(ctx context.Context, isInteractive bool) context.Context
- func WithNoNetwork(ctx context.Context, bv bool) context.Context
- func WithPasswordCallback(ctx context.Context, cb PasswordCallback) context.Context
- func WithPasswordPurgeCallback(ctx context.Context, cb PasswordPurgeCallback) context.Context
- func WithProgressCallback(ctx context.Context, cb ProgressCallback) context.Context
- func WithShowParsing(ctx context.Context, bv bool) context.Context
- func WithStdin(ctx context.Context, isStdin bool) context.Context
- func WithTerminal(ctx context.Context, isTerm bool) context.Context
- func WithUsername(ctx context.Context, sv string) context.Context
- type HeadedText
- type PasswordCallback
- type PasswordPurgeCallback
- type ProgressCallback
Constants ¶
This section is empty.
Variables ¶
var ErrNoCallback = fmt.Errorf("no callback")
ErrNoCallback is returned when no callback is set in the context.
Functions ¶
func AddToCommitMessageBody ¶ added in v1.15.3
AddToCommitMessageBody returns a context with something added to the commit's body.
func GetCommitMessage ¶
GetCommitMessage returns the set commit message (head) or an empty string.
func GetCommitMessageBody ¶ added in v1.15.3
GetCommitMessageBody returns the set commit message body or an empty string.
func GetCommitMessageFull ¶ added in v1.15.3
GetCommitMessageFull returns the set commit message (head+body, of either are defined) or an empty string.
func GetCommitTimestamp ¶
GetCommitTimestamp returns the commit timestamp from the context if set or the default (now) otherwise.
func GetImportFunc ¶
func GetImportFunc(ctx context.Context) store.ImportCallback
GetImportFunc will return the import callback or a default one returning true Note: will never return nil.
func GetUsername ¶
GetUsername returns the username from the context.
func HasAlwaysYes ¶
HasAlwaysYes returns true if a value for AlwaysYes has been set in this context.
func HasCommitMessage ¶
HasCommitMessage returns true if the commit message (head) was set.
func HasCommitMessageBody ¶ added in v1.15.3
HasCommitMessageBody returns true if the commit message body is nonempty.
func HasCommitTimestamp ¶
HasCommitTimestamp returns true if the value for the commit timestamp was set in the context.
func HasGitCommit ¶
HasGitCommit returns true if a value for GitCommit has been set in this context.
func HasGitInit ¶
HasGitInit returns true if the git init flag was set.
func HasImportFunc ¶
HasImportFunc returns true if a value for import func has been set in this context.
func HasInteractive ¶
HasInteractive returns true if a value for Interactive has been set in this context.
func HasNoNetwork ¶
HasNoNetwork returns true if no network was set.
func HasPasswordCallback ¶
HasPasswordCallback returns true if a password callback was set in the context.
func HasPasswordPurgeCallback ¶ added in v1.14.5
HasPasswordPurgeCallback returns true if a password purge callback was set in the context.
func HasProgressCallback ¶
HasProgressCallback returns true if a ProgressCallback has been set.
func HasShowParsing ¶
HasShowParsing returns true if a value for ShowParsing has been set in this context.
func HasTerminal ¶
HasTerminal returns true if a value for Terminal has been set in this context.
func IsAlwaysYes ¶
IsAlwaysYes returns the value of always yes or the default (false).
func IsGitCommit ¶
IsGitCommit returns the value of git commit or the default (true).
func IsInteractive ¶
IsInteractive returns the value of interactive or the default (true).
func IsNoNetwork ¶
IsNoNetwork returns the value of no network or false.
func IsShowParsing ¶
IsShowParsing returns the value of ShowParsing or the default (true).
func IsStdin ¶
IsStdin returns the value of stdin, i.e. if it's true some data is being piped to stdin. If not set it returns the default value (false).
func IsTerminal ¶
IsTerminal returns the value of terminal or the default (true).
func WithAlwaysYes ¶
WithAlwaysYes returns a context with the value of always yes set.
func WithCommitMessage ¶
WithCommitMessage returns a context with a commit message (head) set. (full commit message is the commit message's body is not defined, commit message head otherwise).
func WithCommitTimestamp ¶
WithCommitTimestamp returns a context with the value for the commit timestamp set.
func WithGitCommit ¶
WithGitCommit returns a context with the value of git commit set.
func WithGitInit ¶
WithGitInit returns a context with the value for the git init flag set.
func WithGlobalFlags ¶
WithGlobalFlags parses any global flags from the cli context and returns a regular context.
func WithHidden ¶
WithHidden returns a context with the flag value for hidden set.
func WithImportFunc ¶
WithImportFunc will return a context with the import callback set.
func WithInteractive ¶
WithInteractive returns a context with an explicit value for interactive.
func WithNoNetwork ¶
WithNoNetwork returns a context with the value of no network set.
func WithPasswordCallback ¶
func WithPasswordCallback(ctx context.Context, cb PasswordCallback) context.Context
WithPasswordCallback returns a context with the password callback set.
func WithPasswordPurgeCallback ¶ added in v1.14.5
func WithPasswordPurgeCallback(ctx context.Context, cb PasswordPurgeCallback) context.Context
WithPasswordPurgeCallback returns a context with the password purge callback set.
func WithProgressCallback ¶
func WithProgressCallback(ctx context.Context, cb ProgressCallback) context.Context
WithProgressCallback returns a context with the value of ProgressCallback set.
func WithShowParsing ¶
WithShowParsing returns a context with the value for ShowParsing set.
func WithStdin ¶
WithStdin returns a context with the value for Stdin set. If true some input is available on Stdin (e.g. something is being piped into it).
func WithTerminal ¶
WithTerminal returns a context with an explicit value for terminal.
Types ¶
type HeadedText ¶ added in v1.15.3
type HeadedText struct {
// contains filtered or unexported fields
}
func (*HeadedText) AddToBody ¶ added in v1.15.3
func (h *HeadedText) AddToBody(s string)
func (*HeadedText) ClearBody ¶ added in v1.15.3
func (h *HeadedText) ClearBody()
func (*HeadedText) GetBody ¶ added in v1.15.3
func (h *HeadedText) GetBody() string
func (*HeadedText) GetHead ¶ added in v1.15.3
func (h *HeadedText) GetHead() string
func (*HeadedText) GetText ¶ added in v1.15.3
func (h *HeadedText) GetText() string
func (*HeadedText) HasBody ¶ added in v1.15.3
func (h *HeadedText) HasBody() bool
func (*HeadedText) SetHead ¶ added in v1.15.3
func (h *HeadedText) SetHead(s string)
type PasswordCallback ¶
PasswordCallback is a password prompt callback.
func GetPasswordCallback ¶
func GetPasswordCallback(ctx context.Context) PasswordCallback
GetPasswordCallback returns the password callback or a default (which always fails).
type PasswordPurgeCallback ¶ added in v1.14.5
type PasswordPurgeCallback func(string)
PasswordPurgeCallback is a callback to purge a password cached by PasswordCallback.
func GetPasswordPurgeCallback ¶ added in v1.14.5
func GetPasswordPurgeCallback(ctx context.Context) PasswordPurgeCallback
GetPasswordPurgeCallback returns the password purge callback or a default (which is a no-op).
type ProgressCallback ¶
type ProgressCallback func()
ProgressCallback is a callback for updateing progress.
func GetProgressCallback ¶
func GetProgressCallback(ctx context.Context) ProgressCallback
GetProgressCallback return the set progress callback or a default one. It never returns nil.
Source Files