command

package

v0.3.4 Latest Latest Go to latest Published: Apr 18, 2023 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/snivilised/arcadia

Links

Open Source Insights

Documentation ¶

Overview ¶

Index ¶

Constants
Variables
func Execute(setter ...ExecutionOptionsFn) error
type Bootstrap
- func (b *Bootstrap) Root() *cobra.Command
type ConfigureOptionFn
type ExecutionOptions
type ExecutionOptionsFn
type Jabber
- func (j *Jabber) Scan() language.Tag
type LocaleDetector
type OutputFormatEnum
type RootParameterSet
type WidgetParameterSet

Constants ¶

View Source

const (
	AppEmoji        = "🦄"
	ApplicationName = "arcadia"
	RootPsName      = "root-ps"
	SourceID        = "github.com/snivilised/arcadia"
)

View Source

const WidgetPsName = "widget-ps"

Variables ¶

View Source

var (
	Version = strings.TrimSpace(version)
)

TODO: The version.txt should be updated in ci to contain the version number associated with the applied tag. Currently not yet defined in this template.

Functions ¶

func Execute ¶

func Execute(setter ...ExecutionOptionsFn) error

Types ¶

type Bootstrap ¶

type Bootstrap struct {
	Detector LocaleDetector
	// contains filtered or unexported fields
}

Bootstrap represents construct that performs start up of the cli without resorting to the use of Go's init() mechanism and minimal use of package global variables.

func (*Bootstrap) Root ¶

func (b *Bootstrap) Root() *cobra.Command

Root builds the command tree and returns the root command, ready to be executed.

type ConfigureOptionFn ¶

type ConfigureOptionFn func(*configureOptions)

type ExecutionOptions ¶

type ExecutionOptions struct {
	Detector LocaleDetector
	From     *xi18n.LoadFrom
}

type ExecutionOptionsFn ¶

type ExecutionOptionsFn func(o *ExecutionOptions)

type Jabber ¶

type Jabber struct {
}

Jabber is a LocaleDetector implemented using jibberjabber.

func (*Jabber) Scan ¶

func (j *Jabber) Scan() language.Tag

Scan returns the detected language tag.

type LocaleDetector ¶

type LocaleDetector interface {
	Scan() language.Tag
}

type OutputFormatEnum ¶

type OutputFormatEnum int

const (
	XMLFormatEn OutputFormatEnum
	JSONFormatEn
	TextFormatEn
	ScribbleFormatEn
)

type RootParameterSet ¶

type RootParameterSet struct {
	ConfigFile string
	Language   string
}

CLIENT-TODO: define valid properties on the root parameter set

type WidgetParameterSet ¶

type WidgetParameterSet struct {
	Directory string
	Format    OutputFormatEnum
	Concise   bool
	Pattern   string
	Threshold uint

	// the following are supporting fields required for widget command
	//
	OutputFormatEnumInfo *assistant.EnumInfo[OutputFormatEnum]
	OutputFormatEn       assistant.EnumValue[OutputFormatEnum]
}

Source Files ¶

View all Source files

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