common

Documentation

Index

• Constants
• func GetAliasesDel() []string
• func GetEditorHelpText() string
• func GetSystemStdio() terminal.Stdio
• type BatchOption
  • func (b *BatchOption) Confirm(message string) bool
  • func (b *BatchOption) SetFlag(cmd *cobra.Command)
• type CommonOption
  • func (o *CommonOption) Editor(defaultContent, message string) (content string, err error)
  • func (o *CommonOption) Select(options []string, message, defaultOpt string) (target string, err error)
• type EditContent
• type FormatOutput
• type HookOption
• type InteractiveOption
  • func (b *InteractiveOption) SetFlag(cmd *cobra.Command)
• type JenkinsClient
• type JenkinsConfigMgr
• type MsgConfirm
• type OutputOption
  • func (o *OutputOption) GetLine(obj reflect.Value) []string
  • func (o *OutputOption) ListFilter(obj interface{}) interface{}
  • func (o *OutputOption) Match(item reflect.Value) bool
  • func (o *OutputOption) Output(obj interface{}) (data []byte, err error)
  • func (o *OutputOption) OutputV2(obj interface{}) (err error)
  • func (o *OutputOption) SetFlag(cmd *cobra.Command)
  • func (o *OutputOption) SetFlagWithHeaders(cmd *cobra.Command, headers string)
• type RenderCell
• type Selector
• type WatchOption
  • func (o *WatchOption) SetFlag(cmd *cobra.Command)

Constants

const (
	// JSONOutputFormat is the format of json
	JSONOutputFormat string = "json"
	// YAMLOutputFormat is the format of yaml
	YAMLOutputFormat string = "yaml"
	// TableOutputFormat is the format of table
	TableOutputFormat string = "table"
)

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

const (
	Since = "since"
)

Functions

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 GetSystemStdio

func GetSystemStdio() terminal.Stdio

GetSystemStdio returns the stdio from system

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 CommonOption

type CommonOption 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
}

CommonOption contains the common options

func (*CommonOption) Editor

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

Editor edit a file than return the content

func (*CommonOption) Select

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

Select return a target

type EditContent

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

EditContent is the interface for editing content from a file

type FormatOutput

type FormatOutput interface {
	Output(obj interface{}, format string) (data []byte, err error)
}

FormatOutput is the interface of format output

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 OutputOption

type OutputOption struct {
	Format string

	Columns        string
	WithoutHeaders bool
	Filter         []string

	Writer        io.Writer
	CellRenderMap map[string]RenderCell
}

OutputOption represent the format of output

func (*OutputOption) GetLine

func (o *OutputOption) GetLine(obj reflect.Value) []string

GetLine returns the line of a table

func (*OutputOption) ListFilter

func (o *OutputOption) ListFilter(obj interface{}) interface{}

ListFilter filter the data list by fields

func (*OutputOption) Match

func (o *OutputOption) Match(item reflect.Value) bool

Match filter an item

func (*OutputOption) Output

func (o *OutputOption) Output(obj interface{}) (data []byte, err error)

Output print the object into byte array Deprecated see also OutputV2

func (*OutputOption) OutputV2

func (o *OutputOption) OutputV2(obj interface{}) (err error)

OutputV2 print the data line by line

func (*OutputOption) SetFlag

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

SetFlag set flag of output format Deprecated, see also SetFlagWithHeaders

func (*OutputOption) SetFlagWithHeaders

func (o *OutputOption) SetFlagWithHeaders(cmd *cobra.Command, headers string)

SetFlagWithHeaders set the flags of output

type RenderCell

type RenderCell = func(string) string

RenderCell render a specific cell in a table

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