common

package
v0.14.0 Latest Latest
Warning

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

 Go to latest Published: May 2, 2025 License: MIT Imports: 17 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func FilterValidArgs added in v0.14.0 

func FilterValidArgs(valid, args []string, toComplete string) []string

FilterValidArgs filters the valid arguments and keeps only the ones that match the toComplete string and that are not present in args

Note: the result is a new slice, the original is not modified

func GetGitSection added in v0.10.0 

func GetGitSection(context context.Context, reader io.Reader, name string) (section *ini.Section, err error)

GetGitSection returns the INI section from the git config file

func NewCache added in v0.12.0 

func NewCache[T any]() *cache.Cache[T]

func OpenGitConfig added in v0.10.0 

func OpenGitConfig(context context.Context) (io.ReadCloser, error)

OpenGitConfig opens the .git/config file in the current folder or one of its parents

func Verbose added in v0.13.0 

func Verbose(context context.Context, cmd *cobra.Command, format string, args ...any)

Verbose prints a message if the verbose flag is set

func WhatIf added in v0.10.2 

func WhatIf(context context.Context, cmd *cobra.Command, format string, args ...any) (proceed bool)

WhatIf prints what would be done by the command

If the DryRun flag is set, it prints what would be done by the command and tells the caller to not proceed

otherwise it does nothing

Types

type Entity added in v0.5.0 

type Entity struct {
	Type  string `json:"type"  mapstructure:"type"`
	ID    int    `json:"id"    mapstructure:"id"`
	Name  string `json:"name"  mapstructure:"name"`
	Links Links  `json:"links" mapstructure:"links"`
}

type ErrorProcessing added in v0.9.0 

type ErrorProcessing int
const (
	StopOnError ErrorProcessing = iota
	WarnOnError
	IgnoreErrors
)

func (ErrorProcessing) CompletionFunc added in v0.9.0 

func (ep ErrorProcessing) CompletionFunc() func(*cobra.Command, []string, string) ([]string, cobra.ShellCompDirective)

CompletionFunc returns the completion function of the ErrorProcessing

implements the pflag.Value interface

func (*ErrorProcessing) Set added in v0.9.0 

func (ep *ErrorProcessing) Set(value string) error

Set sets the ErrorProcessing value

implements the pflag.Value interface

func (ErrorProcessing) String added in v0.9.0 

func (ep ErrorProcessing) String() string

String returns the string representation of the ErrorProcessing

implements the fmt.Stringer interface

func (ErrorProcessing) Type added in v0.9.0 

func (ep ErrorProcessing) Type() string

Type returns the type of the ErrorProcessing

implements the pflag.Value interface

func (ErrorProcessing) Values added in v0.9.0 

func (ep ErrorProcessing) Values() []string

Values returns the allowed values of the ErrorProcessing

type FileAnchor added in v0.9.0 

type FileAnchor struct {
	From uint64 `json:"from,omitempty" mapstructure:"from"`
	To   uint64 `json:"to,omitempty"   mapstructure:"to"`
	Path string `json:"path"           mapstructure:"path"`
}

func (FileAnchor) String added in v0.9.0 

func (anchor FileAnchor) String() string

String gets a string representation of this FileAnchor

implements fmt.Stringer 

type Link struct {
	Name   string  `json:"name,omitempty" mapstructure:"name"`
	HREF   url.URL `json:"-"`
	GitRef string  `json:"-"`
}

func (Link) MarshalJSON added in v0.5.0 

func (link Link) MarshalJSON() (data []byte, err error)

MarshalJSON implements the json.Marshaler interface.

func (*Link) UnmarshalJSON added in v0.5.0 

func (link *Link) UnmarshalJSON(data []byte) (err error)

UnmarshalJSON implements the json.Unmarshaler interface. 

type Links struct {
	Self           *Link  `json:"self,omitempty"            mapstructure:"self"`
	HTML           *Link  `json:"html,omitempty"            mapstructure:"html"`
	Avatar         *Link  `json:"avatar,omitempty"          mapstructure:"avatar"`
	Branches       *Link  `json:"branches,omitempty"        mapstructure:"branches"`
	Forks          *Link  `json:"forks,omitempty"           mapstructure:"forks"`
	Commits        *Link  `json:"commits,omitempty"         mapstructure:"commits"`
	PullRequests   *Link  `json:"pullrequests,omitempty"    mapstructure:"pullrequests"`
	Approve        *Link  `json:"approve,omitempty"         mapstructure:"approve"`
	RequestChanges *Link  `json:"request-changes,omitempty" mapstructure:"request-changes"`
	Diff           *Link  `json:"diff,omitempty"            mapstructure:"diff"`
	DiffStat       *Link  `json:"diffstat,omitempty"        mapstructure:"diffstat"`
	Patch          *Link  `json:"patch,omitempty"           mapstructure:"patch"`
	Comments       *Link  `json:"comments,omitempty"        mapstructure:"comments"`
	Activity       *Link  `json:"activity,omitempty"        mapstructure:"activity"`
	Merge          *Link  `json:"merge,omitempty"           mapstructure:"merge"`
	Decline        *Link  `json:"decline,omitempty"         mapstructure:"decline"`
	Statuses       *Link  `json:"statuses,omitempty"        mapstructure:"statuses"`
	Tags           *Link  `json:"tags,omitempty"            mapstructure:"tags"`
	Watchers       *Link  `json:"watchers,omitempty"        mapstructure:"watchers"`
	Downloads      *Link  `json:"downloads,omitempty"       mapstructure:"downloads"`
	Source         *Link  `json:"source,omitempty"          mapstructure:"source"`
	Clone          []Link `json:"clone,omitempty"           mapstructure:"clone"`
	Hooks          *Link  `json:"hooks,omitempty"           mapstructure:"hooks"`
}

type RenderedText 

type RenderedText struct {
	Type   string `json:"type,omitempty" mapstructure:"type"`
	Raw    string `json:"raw"            mapstructure:"raw"`
	Markup string `json:"markup"         mapstructure:"markup"` // markdown, creaole, plaintext
	HTML   string `json:"html,omitempty" mapstructure:"html"`
}

type Tableable added in v0.3.0 

type Tableable interface {
	GetHeader(short bool) []string    // GetHeader retrieves the headers to show, if short is true get the short version
	GetRow(headers []string) []string // GetRow retrieves the row to show for the given headers
}

Tableable is an interface for objects that can be printed as a table

type Tableables added in v0.3.0 

type Tableables interface {
	GetHeader() []string                           // GetHeader retrieves the headers to show
	GetRowAt(index int, headers []string) []string // GetRow retrieves the row to show for the given headers
	Size() int                                     // Size gets the number of elements
}

Tableables is an interface for array of objects that can be printed as a table

type UUID added in v0.4.0 

type UUID uuid.UUID

func NewUUID added in v0.4.0 

func NewUUID() UUID

func ParseUUID added in v0.4.0 

func ParseUUID(s string) (UUID, error)

func (UUID) IsNil added in v0.4.0 

func (u UUID) IsNil() bool

func (UUID) MarshalJSON added in v0.4.0 

func (u UUID) MarshalJSON() ([]byte, error)

func (UUID) String added in v0.4.0 

func (u UUID) String() string

func (*UUID) UnmarshalJSON added in v0.4.0 

func (u *UUID) UnmarshalJSON(payload []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.