config

package

v0.1.4 Latest Latest Go to latest Published: May 14, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Paintersrp/an

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func EnsureConfigExists(homeDir string) error
func GetConfigPath(homeDir string) string
type Config
- func Load(home string) (*Config, error)
type ConfigInitError
- func (e *ConfigInitError) Error() string
type PinMap

Constants ¶

This section is empty.

Variables ¶

View Source

var ValidEditors = map[string]bool{
	"nvim": true,
}

View Source

var ValidModes = map[string]bool{
	"strict":  true,
	"confirm": true,
	"free":    true,
}

Functions ¶

func EnsureConfigExists ¶

func EnsureConfigExists(homeDir string) error

func GetConfigPath ¶

func GetConfigPath(homeDir string) string

Types ¶

type Config ¶

type Config struct {
	PinManager     *pin.PinManager `yaml:"-"`
	NamedPins      PinMap          `yaml:"named_pins"       json:"named_pins"`
	NamedTaskPins  PinMap          `yaml:"named_task_pins"  json:"named_task_pins"`
	VaultDir       string          `yaml:"vaultdir"         json:"vault_dir"`
	Editor         string          `yaml:"editor"           json:"editor"`
	NvimArgs       string          `yaml:"nvimargs"         json:"nvim_args"`
	FileSystemMode string          `yaml:"fsmode"           json:"fs_mode"`
	PinnedFile     string          `yaml:"pinned_file"      json:"pinned_file"`
	PinnedTaskFile string          `yaml:"pinned_task_file" json:"pinned_task_file"`
	SubDirs        []string        `yaml:"subdirs"          json:"sub_dirs"`
}

func Load ¶

func Load(home string) (*Config, error)

func (*Config) AddPin ¶

func (cfg *Config) AddPin(pinName, file, pinType string) error

func (*Config) AddSubdir ¶

func (cfg *Config) AddSubdir(name string) error

func (*Config) ChangeEditor ¶

func (cfg *Config) ChangeEditor(editor string) error

func (*Config) ChangeMode ¶

func (cfg *Config) ChangeMode(mode string) error

func (*Config) ChangePin ¶

func (cfg *Config) ChangePin(file, pinType, pinName string) error

func (*Config) ClearPinnedFile ¶

func (cfg *Config) ClearPinnedFile(pinType string) error

func (*Config) DeleteNamedPin ¶

func (cfg *Config) DeleteNamedPin(pinName, pinType string) error

func (*Config) GetConfigPath ¶

func (cfg *Config) GetConfigPath() string

func (*Config) HandleSubdir ¶

func (cfg *Config) HandleSubdir(subdirName string)

func (*Config) ListPins ¶

func (cfg *Config) ListPins(pinType string) error

func (*Config) RenamePin ¶

func (cfg *Config) RenamePin(oldName, newName, pinType string) error

func (*Config) Save ¶

func (cfg *Config) Save() error

type ConfigInitError ¶

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

func (*ConfigInitError) Error ¶

func (e *ConfigInitError) Error() string

type PinMap ¶

type PinMap map[string]string

Source Files ¶

View all Source files

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