launchr

Documentation

Overview

Package launchr provides common app functionality.

Index

• Constants
• Variables
• func EnsurePath(parts ...string) error
• func GetFsAbsPath(fs fs.FS) string
• func GetTypePkgPathName(v interface{}) (string, string)
• func InitPluginInfo(pi *PluginInfo, p Plugin)
• func InitServiceInfo(si *ServiceInfo, s Service)
• func RegisterPlugin(p Plugin)
• type App
• type AppVersion
  • func NewVersion(name, ver, bwith string, plugins PluginsMap) *AppVersion
  • func Version() *AppVersion
  • func (v *AppVersion) Full() string
  • func (v *AppVersion) Short() string
  • func (v *AppVersion) String() string
• type CobraPlugin
• type Config
  • func ConfigFromFS(root fs.FS) Config
• type ConfigAware
• type GeneratePlugin
• type ManagedFS
• type OnAppInitPlugin
• type Plugin
• type PluginGeneratedData
• type PluginInfo
  • func (p PluginInfo) GetPackagePath() string
  • func (p PluginInfo) String() string
• type PluginManager
  • func NewPluginManagerWithRegistered() PluginManager
• type PluginsMap
• type Service
• type ServiceInfo
  • func (s ServiceInfo) String() string

Constants

const PkgPath = "github.com/launchrctl/launchr"

PkgPath is a main module path.

Variables

var (
	ErrNoConfigFile = errors.New("config file is not found") // ErrNoConfigFile when config file doesn't exist in FS.
)

Functions

func EnsurePath

func EnsurePath(parts ...string) error

EnsurePath creates all directories in the path.

func GetFsAbsPath

func GetFsAbsPath(fs fs.FS) string

GetFsAbsPath returns absolute path for a FS struct.

func GetTypePkgPathName

func GetTypePkgPathName(v interface{}) (string, string)

GetTypePkgPathName returns type package path and name for internal usage.

func InitPluginInfo

func InitPluginInfo(pi *PluginInfo, p Plugin)

InitPluginInfo sets private fields for internal usage only.

func InitServiceInfo

func InitServiceInfo(si *ServiceInfo, s Service)

InitServiceInfo sets private fields for internal usage only.

func RegisterPlugin

func RegisterPlugin(p Plugin)

RegisterPlugin add a plugin to global pull.

Types

type App

type App interface {
	// Name returns app name.
	Name() string
	// GetWD provides app's working dir.
	GetWD() string
	// Streams returns application cli.
	Streams() cli.Streams
	// AddService registers a service in the app.
	// Panics if a service is not unique.
	AddService(s Service)
	// GetService retrieves a service of type v and assigns it to v.
	// Panics if a service is not found.
	GetService(v interface{})

	GetPluginAssets(p Plugin) fs.FS
	// RegisterFS registers a File System in launchr.
	// It may be a FS for action discovery, see action.DiscoveryFS.
	RegisterFS(fs ManagedFS)
	// GetRegisteredFS returns an array of registered File Systems.
	GetRegisteredFS() []ManagedFS
}

App stores global application state.

type AppVersion

type AppVersion struct {
	Name        string
	Version     string
	OS          string
	Arch        string
	BuiltWith   string
	CoreVersion string
	CoreReplace string
	Plugins     []string
}

AppVersion stores application version.

func NewVersion

func NewVersion(name, ver, bwith string, plugins PluginsMap) *AppVersion

NewVersion creates version info with used plugins info.

func Version

func Version() *AppVersion

Version provides app version info.

func (*AppVersion) Full

func (v *AppVersion) Full() string

Full outputs version string in a full format.

func (*AppVersion) Short

func (v *AppVersion) Short() string

Short outputs a short version string.

func (*AppVersion) String

func (v *AppVersion) String() string

String implements Stringer interface.

type CobraPlugin

type CobraPlugin interface {
	Plugin
	// CobraAddCommands is a hook called when cobra root command is available.
	// Plugins may register its command line commands here.
	CobraAddCommands(*cobra.Command) error
}

CobraPlugin is an interface to implement a plugin for cobra.

type Config

type Config interface {
	Service
	// DirPath returns an absolute path to config directory.
	DirPath() string
	// Path provides an absolute path to launchr config directory.
	Path(parts ...string) string
	// EnsurePath creates all directories in the path.
	EnsurePath(parts ...string) error
	// Get returns a value by key to a parameter v. Parameter v must be a pointer to a value.
	// Error may be returned on decode.
	Get(key string, v interface{}) error
}

Config is a launchr config storage interface.

func ConfigFromFS

func ConfigFromFS(root fs.FS) Config

ConfigFromFS parses launchr app config directory and its content.

type ConfigAware

type ConfigAware interface {
	// SetLaunchrConfig sets a launchr config to the struct.
	SetLaunchrConfig(Config)
}

ConfigAware provides an interface for structs to support launchr configuration setting.

type GeneratePlugin

type GeneratePlugin interface {
	Plugin
	// Generate is a function called when application is generating code and assets for the build.
	Generate(buildPath string, workDir string) (*PluginGeneratedData, error)
}

GeneratePlugin is an interface to generate supporting files before build.

type ManagedFS

type ManagedFS interface {
	fs.FS
	FS() fs.FS
}

ManagedFS is a common interface for FS registered in launchr.

type OnAppInitPlugin

type OnAppInitPlugin interface {
	Plugin
	// OnAppInit is hook function called on application initialisation.
	// Plugins may save app global object, retrieve or provide services here.
	OnAppInit(app App) error
}

OnAppInitPlugin is an interface to implement a plugin for app initialisation.

type Plugin

type Plugin interface {
	// PluginInfo requests a type to provide information about the plugin.
	PluginInfo() PluginInfo
}

Plugin is a common interface for launchr plugins.

type PluginGeneratedData

type PluginGeneratedData struct {
	Plugins []string
}

PluginGeneratedData is a struct containing a result information of plugin generation.

type PluginInfo

type PluginInfo struct {
	// Weight defines the order of plugins calling. @todo rework to a real dependency resolving.
	Weight int
	// contains filtered or unexported fields
}

PluginInfo provides information about the plugin and is used as a unique data to indentify a plugin.

func (PluginInfo) GetPackagePath

func (p PluginInfo) GetPackagePath() string

GetPackagePath returns the package path of the PluginInfo.

func (PluginInfo) String

func (p PluginInfo) String() string

type PluginManager

type PluginManager interface {
	Service
	All() PluginsMap
}

PluginManager handles plugins.

func NewPluginManagerWithRegistered

func NewPluginManagerWithRegistered() PluginManager

NewPluginManagerWithRegistered creates PluginManager with registered plugins.

type PluginsMap

type PluginsMap = map[PluginInfo]Plugin

PluginsMap is a type alias for plugins map.

type Service

type Service interface {
	ServiceInfo() ServiceInfo
}

Service is a common interface for a service to register.

type ServiceInfo

type ServiceInfo struct {
	// contains filtered or unexported fields
}

ServiceInfo provides service info for its initialization.

func (ServiceInfo) String

func (s ServiceInfo) String() string