pet

Documentation

Index

• Constants
• func Description(config *Config) model.ManagerDescription
• type Config
  • func AutoDiscoveryConfig(system *system.System) *Config
• type Manager
  • func NewManager(options ...Option) (*Manager, error)
  • func (m *Manager) GetSnippets() []model.Snippet
  • func (m Manager) Info() []model.InfoLine
  • func (m Manager) Key() model.ManagerKey
  • func (m *Manager) Sync(model.SyncEventChannel)
• type Option
  • func WithConfig(config Config) Option
  • func WithSystem(system *system.System) Option

Constants

const Key = model.ManagerKey("pet")

Functions

func Description

func Description(config *Config) model.ManagerDescription

Types

type Config

type Config struct {
	Enabled      bool     `yaml:"enabled" head_comment:"Set to true if you want to use pet."`
	LibraryPaths []string `yaml:"libraryPaths" head_comment:"List of pet snippet files."`
	IncludeTags  []string `` /* 132-byte string literal not displayed */
}

func AutoDiscoveryConfig

func AutoDiscoveryConfig(system *system.System) *Config

type Manager

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

func NewManager

func NewManager(options ...Option) (*Manager, error)

func (*Manager) GetSnippets

func (m *Manager) GetSnippets() []model.Snippet

func (Manager) Info

func (m Manager) Info() []model.InfoLine

func (Manager) Key

func (m Manager) Key() model.ManagerKey

func (*Manager) Sync

func (m *Manager) Sync(model.SyncEventChannel)

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option configures a Manager.

func WithConfig

func WithConfig(config Config) Option

func WithSystem

func WithSystem(system *system.System) Option

WithSystem sets the utils.System instance to be used by Manager.