config

Documentation

Index

• func LoadConfig()
• func SetDefaults()
• type ColorVariant
• type ColorsConfig
• type Config
  • func GetConfig() (config Config)
• type DirTreeColors
• type PaneColors
• type SettingsConfig
• type StatusBarColors

Functions

func LoadConfig

func LoadConfig()

LoadConfig loads a users config and creates the config if it does not exist located at ~/.fm.yml.

func SetDefaults

func SetDefaults()

SetDefaults sets default values for the config.

Types

type ColorVariant

type ColorVariant struct {
	Foreground string `mapstructure:"foreground"`
	Background string `mapstructure:"background"`
}

ColorVariant struct represents a color.

type ColorsConfig

type ColorsConfig struct {
	DirTree   DirTreeColors   `mapstructure:"dir_tree"`
	Pane      PaneColors      `mapstructure:"pane"`
	Spinner   string          `mapstructure:"spinner"`
	StatusBar StatusBarColors `mapstructure:"status_bar"`
}

ColorsConfig struct represets the colors of the UI.

type Config

type Config struct {
	Settings SettingsConfig `mapstructure:"settings"`
	Colors   ColorsConfig   `mapstructure:"colors"`
}

Config represents the main config for the application.

func GetConfig

func GetConfig() (config Config)

GetConfig returns the users config.

type DirTreeColors

type DirTreeColors struct {
	SelectedItem   string `mapstructure:"selected_item"`
	UnselectedItem string `mapstructure:"unselected_item"`
}

DirTreeColors struct represents the colors for the dirtree.

type PaneColors

type PaneColors struct {
	ActiveBorderColor   string `mapstructure:"active_border_color"`
	InactiveBorderColor string `mapstructure:"inactive_border_color"`
}

PaneColors represents the colors for a pane.

type SettingsConfig

type SettingsConfig struct {
	StartDir         string `mapstructure:"start_dir"`
	ShowIcons        bool   `mapstructure:"show_icons"`
	RoundedPanes     bool   `mapstructure:"rounded_panes"`
	EnableLogging    bool   `mapstructure:"enable_logging"`
	EnableMouseWheel bool   `mapstructure:"enable_mousewheel"`
	PrettyMarkdown   bool   `mapstructure:"pretty_markdown"`
}

SettingsConfig struct represents the config for the settings.

type StatusBarColors

type StatusBarColors struct {
	SelectedFile ColorVariant `mapstructure:"selected_file"`
	Bar          ColorVariant `mapstructure:"bar"`
	TotalFiles   ColorVariant `mapstructure:"total_files"`
	Logo         ColorVariant `mapstructure:"logo"`
}

StatusBarColors represents the colors for the status bar.