jenkins-cli: github.com/jenkins-zh/jenkins-cli/app/cmd/common Index | Files

package common

import "github.com/jenkins-zh/jenkins-cli/app/cmd/common"

Index

Package Files

cmd_valid.go common.go completion.go plugin.go version_since.go

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"
)

func ArrayCompletion Uses

❖
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 Uses

❖
func ExistsRegularFile(flagName string) cobra.PositionalArgs

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

func GetAliasesDel Uses

❖
func GetAliasesDel() []string

GetAliasesDel returns the aliases for delete command

func GetEditorHelpText Uses

❖
func GetEditorHelpText() string

GetEditorHelpText returns the help text related a text editor

func GetJCLIPluginPath Uses

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

GetJCLIPluginPath returns the path of a jcli plugin

func GetSystemStdio Uses

❖
func GetSystemStdio() terminal.Stdio

GetSystemStdio returns the stdio from system

func NoFileCompletion Uses

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

NoFileCompletion avoid completion with files

type BatchOption Uses

❖
type BatchOption struct {
    Batch bool

    Stdio terminal.Stdio
}

BatchOption represent the options for a batch operation

func (*BatchOption) Confirm Uses

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

Confirm promote user if they really want to do this

func (*BatchOption) SetFlag Uses

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

SetFlag the flag for batch option

type EditContent Uses

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

EditContent is the interface for editing content from a file

type HookOption Uses

❖
type HookOption struct {
    SkipPreHook  bool
    SkipPostHook bool
}

HookOption is the option whether skip command hook

type InteractiveOption Uses

❖
type InteractiveOption struct {
    Interactive bool
}

InteractiveOption allow user to choose whether the mode is interactive

func (*InteractiveOption) SetFlag Uses

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

SetFlag set the option flag to this cmd

type JenkinsClient Uses

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

JenkinsClient is the interface of get Jenkins client

type JenkinsConfigMgr Uses

❖
type JenkinsConfigMgr interface {
    GetMirror(string) string

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

JenkinsConfigMgr is the interface of getting configuration

type MsgConfirm Uses

❖
type MsgConfirm interface {
    Confirm(message string) bool
}

MsgConfirm is the interface for confirming a message

type Option Uses

❖
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 Uses

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

Editor edit a file than return the content

func (*Option) Select Uses

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

Select return a target

type Selector Uses

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

Selector is the interface for selecting an option

type WatchOption Uses

❖
type WatchOption struct {
    Watch    bool
    Interval int
    Count    int
}

WatchOption for the resources which can be watched

func (*WatchOption) SetFlag Uses

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

SetFlag for WatchOption

Package common imports 12 packages (graph) and is imported by 3 packages. Updated 2021-01-27. Refresh now. Tools for package owners.