cmdutil

package

v1.11.0 Latest Latest Go to latest Published: Mar 24, 2026 License: MIT Imports: 17 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/aarondpn/redmine-cli

Links

Open Source Insights

Documentation ¶

Index ¶

func AddForceFlag(cmd *cobra.Command, force *bool)
func AddOutputFlag(cmd *cobra.Command, format *string)
func AddPaginationFlags(cmd *cobra.Command, limit, offset *int)
func CompleteActivities(f *Factory) ...
func CompleteCategories(f *Factory) ...
func CompleteGroups(f *Factory) ...
func CompleteIssueListStatus(f *Factory) ...
func CompleteOpenVersions(f *Factory) ...
func CompleteOutputFormat(_ *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)
func CompletePriorities(f *Factory) ...
func CompleteProjects(f *Factory) ...
func CompleteStatuses(f *Factory) ...
func CompleteTrackers(f *Factory) ...
func CompleteUserStatus(_ *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)
func CompleteUsers(f *Factory) ...
func CompleteVersionStatus(_ *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)
func CompleteVersions(f *Factory) ...
func ConfirmAction(in io.Reader, errOut io.Writer, message string) bool
func FormatError(err error) string
func ResolveProjectID(ctx context.Context, f *Factory, input string) (string, error)
func ResolveProjectIdentifier(ctx context.Context, f *Factory, input string) (string, error)
type Factory
- func NewFactory() *Factory
- func (f *Factory) ApiClient() (*api.Client, error)
- func (f *Factory) Config() (*config.Config, error)
- func (f *Factory) DebugLogger() *debug.Logger
- func (f *Factory) Printer(format string) output.Printer
type IOStreams
type SilentError
- func (e *SilentError) Error() string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AddForceFlag ¶

func AddForceFlag(cmd *cobra.Command, force *bool)

AddForceFlag adds the --force/-f flag to a command.

func AddOutputFlag ¶

func AddOutputFlag(cmd *cobra.Command, format *string)

AddOutputFlag adds the --output/-o flag to a command.

func AddPaginationFlags ¶

func AddPaginationFlags(cmd *cobra.Command, limit, offset *int)

AddPaginationFlags adds --limit and --offset flags to a command.

func CompleteActivities ¶ added in v1.11.0

func CompleteActivities(f *Factory) func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

CompleteActivities returns a completion function for the --activity flag.

func CompleteCategories ¶ added in v1.11.0

func CompleteCategories(f *Factory) func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

CompleteCategories returns a completion function for the --category flag. Requires --project to be set (or a default project in config).

func CompleteGroups ¶ added in v1.11.0

func CompleteGroups(f *Factory) func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

CompleteGroups returns a completion function for the --group flag. Returns empty completions gracefully if the user lacks admin privileges.

func CompleteIssueListStatus ¶ added in v1.11.0

func CompleteIssueListStatus(f *Factory) func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

CompleteIssueListStatus returns a completion function for the --status flag on the issues list command, which also accepts special values.

func CompleteOpenVersions ¶ added in v1.11.0

func CompleteOpenVersions(f *Factory) func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

CompleteOpenVersions returns a completion function for the --version flag that only shows open and locked versions (excludes closed). Useful for create/update commands where closed versions aren't valid targets.

func CompleteOutputFormat ¶ added in v1.11.0

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

CompleteOutputFormat provides static completions for the --output flag.

func CompletePriorities ¶ added in v1.11.0

func CompletePriorities(f *Factory) func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

CompletePriorities returns a completion function for the --priority flag.

func CompleteProjects ¶ added in v1.11.0

func CompleteProjects(f *Factory) func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

CompleteProjects returns a completion function for the --project flag.

func CompleteStatuses ¶ added in v1.11.0

func CompleteStatuses(f *Factory) func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

CompleteStatuses returns a completion function for the --status flag.

func CompleteTrackers ¶ added in v1.11.0

func CompleteTrackers(f *Factory) func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

CompleteTrackers returns a completion function for the --tracker flag.

func CompleteUserStatus ¶ added in v1.11.0

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

CompleteUserStatus provides static completions for user --status flag.

func CompleteUsers ¶ added in v1.11.0

func CompleteUsers(f *Factory) func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

CompleteUsers returns a completion function for user-related flags. Returns empty completions gracefully if the user lacks admin privileges.

func CompleteVersionStatus ¶ added in v1.11.0

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

CompleteVersionStatus provides static completions for version --status flag.

func CompleteVersions ¶ added in v1.11.0

func CompleteVersions(f *Factory) func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

CompleteVersions returns a completion function for the --version flag that shows all versions including closed ones. Requires --project to be set (or a default project in config).

func ConfirmAction ¶

func ConfirmAction(in io.Reader, errOut io.Writer, message string) bool

ConfirmAction prompts the user to confirm a destructive action. Returns true if the user confirms with "y" or "yes". If in is not interactive or the user declines, returns false.

func FormatError ¶

func FormatError(err error) string

FormatError converts an API error into a user-friendly message.

func ResolveProjectID ¶ added in v1.10.1

func ResolveProjectID(ctx context.Context, f *Factory, input string) (string, error)

ResolveProjectID resolves a project input to its numeric ID string.

func ResolveProjectIdentifier ¶ added in v1.10.1

func ResolveProjectIdentifier(ctx context.Context, f *Factory, input string) (string, error)

ResolveProjectIdentifier resolves a project input to its canonical identifier.

Types ¶

type Factory ¶

type Factory struct {
	ConfigPath string
	Verbose    bool

	IOStreams *IOStreams
	// contains filtered or unexported fields
}

Factory provides lazy access to configuration, API client, and output printer.

func NewFactory ¶

func NewFactory() *Factory

NewFactory creates a new Factory with default I/O streams.

func (*Factory) ApiClient ¶

func (f *Factory) ApiClient() (*api.Client, error)

ApiClient returns an API client (cached after first call).

func (*Factory) Config ¶

func (f *Factory) Config() (*config.Config, error)

Config returns the loaded configuration (cached after first call).

func (*Factory) DebugLogger ¶

func (f *Factory) DebugLogger() *debug.Logger

DebugLogger returns the debug logger, creating it on first call.

func (*Factory) Printer ¶

func (f *Factory) Printer(format string) output.Printer

Printer returns the output printer.

type IOStreams ¶

type IOStreams struct {
	In     io.Reader
	Out    io.Writer
	ErrOut io.Writer
	IsTTY  bool
}

IOStreams holds the standard I/O streams.

type SilentError ¶ added in v1.10.0

type SilentError struct{ Code int }

SilentError is returned when the error message has already been printed or should be suppressed. main.go will still exit with the given code.

func (*SilentError) Error ¶ added in v1.10.0

func (e *SilentError) Error() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL