cmd_toolkit

package module

Go to main page

Versions in this module

v0

v0.11.0

May 20, 2024

v0.10.0

May 3, 2024

Changes in this version

+ func AssignFileSystem(fs afero.Fs) afero.Fs

+ func FileSystem() afero.Fs

v0.9.0

May 2, 2024

v0.8.4

Apr 20, 2024

v0.8.3

Mar 10, 2024

v0.8.2

Feb 25, 2024

v0.8.1

Feb 24, 2024

v0.8.0

Feb 23, 2024

Changes in this version

+ func BuildInformationHeader() string

+ func Copyright(o output.Bus, first int, timestamp, owner string) string

+ func DecoratedAppName(applicationName, applicationVersion, timestamp string) string

+ func FlowerBox(lines []string) []string

+ func FormatBuildDependencies(dependencies []string) []string

+ func FormatGoVersion(version string) string

+ func InterpretBuildData() (version string, dependencies []string)

v0.7.0

Feb 22, 2024

Changes in this version

+ func LogPath() string

v0.6.0

Dec 5, 2023

Changes in this version

type IntBounds

+ func (b *IntBounds) Default() int

+ func (b *IntBounds) Maximum() int

+ func (b *IntBounds) Minimum() int

v0.5.1

Nov 28, 2023

v0.5.0

Nov 26, 2023

Changes in this version

+ func GenerateAboutContent(o output.Bus)

v0.4.1

Nov 25, 2023

v0.4.0

Nov 23, 2023

Changes in this version

+ func FlagIndicator() string

+ func SetFlagIndicator(val string)

v0.3.0

Nov 14, 2023

v0.2.3

Nov 8, 2023

v0.2.2

Nov 8, 2023

v0.2.1-alpha

Nov 8, 2023

v0.2.0

Nov 4, 2023

Changes in this version

+ func InitLoggingWithLevel(o output.Bus, l output.Level) (ok bool)

type ProductionLogger

+ func (pl ProductionLogger) ExitFunc() (f func(int))

+ func (pl ProductionLogger) SetExitFunc(f func(int))

v0.1.2

Oct 3, 2023

v0.1.1

Jul 18, 2023

v0.1.0

Feb 8, 2023

v0.0.3

Feb 7, 2023

v0.0.2

Feb 7, 2023

v0.0.1

Feb 7, 2023

Changes in this version

+ const ApplicationDataEnvVarName

+ const StdDirPermissions

+ const StdFilePermissions

+ func AddCommandData(name string, d *CommandDescription)

+ func AppName() (string, error)

+ func ApplicationPath() string

+ func BuildDependencies() []string

+ func CopyFile(src, dest string) (err error)

+ func CreateAppSpecificPath(topDir string) (string, error)

+ func CreateFile(fileName string, content []byte) (err error)

+ func CreateFileInDirectory(dir, name string, content []byte) error

+ func DecorateBoolFlagUsage(usage string, defaultValue bool) string

+ func DecorateIntFlagUsage(usage string, defaultValue int) string

+ func DecorateStringFlagUsage(usage, defaultValue string) string

+ func DefaultConfigFileName() string

+ func DereferenceEnvVar(s string) (string, error)

+ func DirExists(path string) bool

+ func Execute(o output.Bus, logInit func(output.Bus) bool, ...) (exitCode int)

+ func GoVersion() string

+ func InitApplicationPath(o output.Bus) (initialized bool)

+ func InitBuildData(f func() (*debug.BuildInfo, bool), version, creation string)

+ func InitLogging(o output.Bus) (ok bool)

+ func LogCommandStart(o output.Bus, name string, m map[string]any)

+ func LogFileDeletionFailure(o output.Bus, s string, e error)

+ func LogUnreadableDirectory(o output.Bus, s string, e error)

+ func Mkdir(dir string) (err error)

+ func PlainFileExists(path string) bool

+ func ProcessArgs(o output.Bus, f *flag.FlagSet, rawArgs []string) (ok bool)

+ func ReadDirectory(o output.Bus, dir string) (files []fs.DirEntry, ok bool)

+ func ReportDirectoryCreationFailure(o output.Bus, cmd, dir string, e error)

+ func ReportFileCreationFailure(o output.Bus, cmd, file string, e error)

+ func ReportFileDeletionFailure(o output.Bus, file string, e error)

+ func ReportInvalidConfigurationData(o output.Bus, s string, e error)

+ func ReportNothingToDo(o output.Bus, cmd string, fields map[string]any)

+ func SecureAbsolutePath(path string) string

+ func SetAppName(s string) (err error)

+ func SetApplicationPath(s string) (previous string)

+ func SetAuthor(s string)

+ func SetDefaultConfigFileName(s string)

+ func SetFirstYear(i int)

+ func WriteDirectoryCreationError(o output.Bus, d string, e error)

+ type CommandDescription struct

+ Initializer func(output.Bus, *Configuration, *flag.FlagSet) (CommandProcessor, bool)

+ IsDefault bool

+ type CommandProcessor interface

+ Exec func(output.Bus, []string) bool

+ func ProcessCommand(o output.Bus, args []string) (cmd CommandProcessor, cmdArgs []string, ok bool)

+ type Configuration struct

+ func EmptyConfiguration() *Configuration

+ func NewConfiguration(o output.Bus, data map[string]any) *Configuration

+ func ReadConfigurationFile(o output.Bus) (c *Configuration, ok bool)

+ func (c *Configuration) BoolDefault(key string, defaultValue bool) (b bool, err error)

+ func (c *Configuration) BooleanValue(key string) (value, ok bool)

+ func (c *Configuration) HasSubConfiguration(key string) bool

+ func (c *Configuration) IntDefault(key string, b *IntBounds) (i int, err error)

+ func (c *Configuration) IntValue(key string) (value int, ok bool)

+ func (c *Configuration) String() string

+ func (c *Configuration) StringDefault(key, defaultValue string) (s string, err error)

+ func (c *Configuration) StringValue(key string) (value string, ok bool)

+ func (c *Configuration) SubConfiguration(key string) *Configuration

+ type EnvVarMemento struct

+ func NewEnvVarMemento(name string) *EnvVarMemento

+ func (mem *EnvVarMemento) Restore()

+ type IntBounds struct

+ func NewIntBounds(v1, v2, v3 int) *IntBounds

+ type ProductionLogger struct

+ func (pl ProductionLogger) Debug(msg string, fields map[string]any)

+ func (pl ProductionLogger) Error(msg string, fields map[string]any)

+ func (pl ProductionLogger) Fatal(msg string, fields map[string]any)

+ func (pl ProductionLogger) Info(msg string, fields map[string]any)

+ func (pl ProductionLogger) Panic(msg string, fields map[string]any)

+ func (pl ProductionLogger) Trace(msg string, fields map[string]any)

+ func (pl ProductionLogger) Warning(msg string, fields map[string]any)

v0.0.1-alpha.4

Feb 7, 2023

v0.0.1-alpha.3

Feb 7, 2023

v0.0.1-alpha.2

Feb 5, 2023

v0.0.1-alpha

Feb 4, 2023

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