common

Documentation

Index

• Constants
• func ArrayCompletion(array ...string) ...
• func ExistsRegularFile(flagName string) cobra.PositionalArgs
• func GetAliasesDel() []string
• func GetEditorHelpText() string
• func GetJCLIPluginPath(userHome, name string, binary bool) string
• func GetSystemStdio() terminal.Stdio
• func NoFileCompletion(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)
• type BatchOption
  • func (b *BatchOption) Confirm(message string) bool
  • func (b *BatchOption) SetFlag(cmd *cobra.Command)
• type EditContent
• type HookOption
• type InteractiveOption
  • func (b *InteractiveOption) SetFlag(cmd *cobra.Command)
• type JenkinsClient
• type JenkinsConfigMgr
• type MsgConfirm
• type Option
  • func (o *Option) Editor(defaultContent, message string) (content string, err error)
  • func (o *Option) Select(options []string, message, defaultOpt string) (target string, err error)
• type Selector
• type WatchOption
  • func (o *WatchOption) SetFlag(cmd *cobra.Command)

Constants

const (
	// VersionSince0028 represents v0.0.28
	VersionSince0028 = "v0.0.28"
	// VersionSince0024 represents v0.0.24
	VersionSince0024 = "v0.0.24"
	// VersionSince0031 represents v0.0.31
	VersionSince0031 = "v0.0.31"
)

const (
	// Since indicate when the feature war added
	Since = "since"
)

Functions

func ArrayCompletion

func ArrayCompletion(array ...string) func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

ArrayCompletion return a completion which base on an array

func ExistsRegularFile

func ExistsRegularFile(flagName string) cobra.PositionalArgs

ExistsRegularFile returns a function to check if target file is a regular file

func GetAliasesDel

func GetAliasesDel() []string

GetAliasesDel returns the aliases for delete command

func GetEditorHelpText

func GetEditorHelpText() string

GetEditorHelpText returns the help text related a text editor

func GetJCLIPluginPath

func GetJCLIPluginPath(userHome, name string, binary bool) string

GetJCLIPluginPath returns the path of a jcli plugin

func GetSystemStdio

func GetSystemStdio() terminal.Stdio

GetSystemStdio returns the stdio from system

func NoFileCompletion

func NoFileCompletion(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

NoFileCompletion avoid completion with files

Types

type BatchOption

type BatchOption struct {
	Batch bool

	Stdio terminal.Stdio
}

BatchOption represent the options for a batch operation

func (*BatchOption) Confirm

func (b *BatchOption) Confirm(message string) bool

Confirm promote user if they really want to do this

func (*BatchOption) SetFlag

func (b *BatchOption) SetFlag(cmd *cobra.Command)

SetFlag the flag for batch option

type EditContent

type EditContent interface {
	Editor(defaultContent, message string) (content string, err error)
}

EditContent is the interface for editing content from a file

type HookOption

type HookOption struct {
	SkipPreHook  bool
	SkipPostHook bool
}

HookOption is the option whether skip command hook

type InteractiveOption

type InteractiveOption struct {
	Interactive bool
}

InteractiveOption allow user to choose whether the mode is interactive

func (*InteractiveOption) SetFlag

func (b *InteractiveOption) SetFlag(cmd *cobra.Command)

SetFlag set the option flag to this cmd

type JenkinsClient

type JenkinsClient interface {
	GetCurrentJenkinsFromOptions() (jenkinsServer *config.JenkinsServer)
	GetCurrentJenkinsAndClient(jClient *client.JenkinsCore) *config.JenkinsServer
}

JenkinsClient is the interface of get Jenkins client

type JenkinsConfigMgr

type JenkinsConfigMgr interface {
	GetMirror(string) string

	GetGitHubClient() *github.Client
	SetGitHubClient(gitHubClient *github.Client)
}

JenkinsConfigMgr is the interface of getting configuration

type MsgConfirm

type MsgConfirm interface {
	Confirm(message string) bool
}

MsgConfirm is the interface for confirming a message

type Option

type Option struct {
	ExecContext     util.ExecContext
	SystemCallExec  util.SystemCallExec
	LookPathContext util.LookPathContext
	RoundTripper    http.RoundTripper
	Logger          *zap.Logger

	GitHubClient *github.Client

	Stdio terminal.Stdio

	// EditFileName allow editor has a better performance base on this
	EditFileName string
}

Option contains the common options

func (*Option) Editor

func (o *Option) Editor(defaultContent, message string) (content string, err error)

Editor edit a file than return the content

func (*Option) Select

func (o *Option) Select(options []string, message, defaultOpt string) (target string, err error)

Select return a target

type Selector

type Selector interface {
	Select(options []string, message, defaultOpt string) (target string, err error)
}

Selector is the interface for selecting an option

type WatchOption

type WatchOption struct {
	Watch    bool
	Interval int
	Count    int
}

WatchOption for the resources which can be watched

func (*WatchOption) SetFlag

func (o *WatchOption) SetFlag(cmd *cobra.Command)

SetFlag for WatchOption