command

Documentation

Overview

Copyright © 2022 NAME HERE <EMAIL ADDRESS>

Index

• Constants
• Variables
• func Execute() error
• type Bootstrap
  • func (b *Bootstrap) Root(options ...ConfigureOptionFn) *cobra.Command
• type ConfigureOptionFn
• type ConfigureOptionsInfo
• type Jabber
  • func (j *Jabber) Scan() language.Tag
• type LocaleDetector
• type MagickParameterSet

Constants

const (
	RootPsName                = "root-ps"
	PreviewFamName            = "preview-family"
	WorkerPoolFamName         = "worker-pool-family"
	FoldersFamName            = "folders-family"
	ProfileFamName            = "profile-family"
	CascadeFamName            = "cascade-family"
	SamplingFamName           = "sampling-family"
	TextualInteractionFamName = "textual-family"
)

const MagickPsName = "magick-ps"

Variables

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() error

Types

type Bootstrap

type Bootstrap struct {
	Container     *assistant.CobraContainer
	OptionsInfo   ConfigureOptionsInfo
	Configs       *common.Configs
	Vfs           storage.VirtualFS
	Logger        *slog.Logger
	Presentation  common.PresentationOptions
	Observers     common.Observers
	Notifications common.LifecycleNotifications
}

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(options ...ConfigureOptionFn) *cobra.Command

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

type ConfigureOptionFn

type ConfigureOptionFn func(*ConfigureOptionsInfo)

type ConfigureOptionsInfo

type ConfigureOptionsInfo struct {
	Detector LocaleDetector
	Config   *common.ConfigInfo
	Runner   common.ConfigRunner
}

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 MagickParameterSet

type MagickParameterSet struct {
	// remove the follow:
	//
	Directory string
	Concise   bool
	Pattern   string
	Threshold uint
}