fslibrary

package
v1.4.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 12, 2023 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source
const Key = model.ManagerKey("fslibrary")

Variables

This section is empty.

Functions

func Description

func Description(config *Config) model.ManagerDescription

Types

type Config

type Config struct {
	Enabled            bool     `yaml:"enabled" head_comment:"If set to false, the files specified via libraryPath will not be provided to you."`
	LibraryPath        []string `yaml:"libraryPath" head_comment:"Paths directories that hold snippets files. Each file must hold one snippet only."`
	SuffixRegex        []string `yaml:"suffixRegex" head_comment:"Only files with endings which match one of the listed suffixes will be considered."`
	LazyOpen           bool     `` /* 150-byte string literal not displayed */
	HideTitleInPreview bool     `yaml:"hideTitleInPreview" head_comment:"If set to true, the title comment will not be shown in the preview window."`
}

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 added in v1.1.0

func (m Manager) Key() model.ManagerKey

func (*Manager) Sync added in v1.1.0

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.

Jump to

Keyboard shortcuts

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