config

Documentation

Index

• func GetDebuggingEnabled() bool
• func SetDebuggingEnabled(value bool)
• type CommandConfig
• type Config
  • func Load() (Config, error)
• type EditorConfig

Functions

func GetDebuggingEnabled

func GetDebuggingEnabled() bool

GetDebuggingEnabled gets whether debugging is enabled

func SetDebuggingEnabled

func SetDebuggingEnabled(value bool)

SetDebuggingEnabled sets whether debugging is enabled

Types

type CommandConfig

type CommandConfig struct {
	Executable string   `json:"executable,omitempty"` // The program to run
	Arguments  []string `json:"args,omitempty"`       // The arguments to pass to the executable (filename will automatically be appended)
}

CommandConfig respresents the options for launching a command

type Config

type Config struct {
	KeyBindings map[string]interface{} `json:"keyBindings,omitempty"`
	Editor      EditorConfig           `json:"editor,omitempty"`
}

Config represents the user configuration options

func Load

func Load() (Config, error)

Load the user configuration settings

type EditorConfig

type EditorConfig struct {
	Command                 CommandConfig `json:"command,omitempty"`                 // The command to execute to launch the editor
	TranslateFilePathForWSL bool          `json:"translateFilePathForWSL,omitEmpty"` //nolint:golint,staticcheck // WSL use only. True to translate the path to a Windows path (e.g. when running under WSL but using a Windows editor)
	TempDir                 string        `json:"tempDir,omitempty"`                 // Specify the directory to use for temporary files for editing (defaults to OS temp dir)
	RevertToStandardBuffer  bool          `json:"revertToStandardBuffer,omitempty"`  // Set to true to revert to standard buffer while editing (e.g. for terminal-based editors)
}

EditorConfig represents the user options for external editor