Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Module ¶
type Module struct {
Config ModuleConfig
}
func NewModule ¶
func NewModule(config ModuleConfig) Module
func (Module) OptionsOrCache ¶
type ModuleConfig ¶
type ModuleConfig struct {
// Name is used to override the default module name
Name string `yaml:"name,omitempty"`
// Options is a list of static options
StaticOptions []StaticOption `yaml:"options"`
}
type StaticOption ¶
type StaticOption struct {
// Id is a unique identifier for the option
Id string `yaml:"id"`
// Name is the name of the option
Name string `yaml:"name"`
// DisplayName is the name that should be displayed in the fuzzy finder
DisplayName string `yaml:"display-name"`
// Description is a short description of the option
Description string `yaml:"description"`
// Web is the URL to open when the option is selected
Web string `yaml:"web"`
// StartDirectory is the initial working directory
StartDirectory string `yaml:"start-directory"`
// Tags can be used to filter options
Tags []string `yaml:"tags"`
// Context
Context map[string]string `yaml:"context"`
// Layout can be used to override the default layout used by the option (e.g. ssh/project)
Layout string `yaml:"layout"`
// Preview to render in the preview window
Preview string `yaml:"preview"`
}
Click to show internal directories.
Click to hide internal directories.