config

Documentation

Index

• Variables
• func CommandParam(command types.CommandSpec, name string) (types.Param, bool)
• func ExtractParams(args []string, command types.CommandSpec) (map[string]any, error)
• func Path() string
• type Config
  • func Load() (Config, error)
  • func (c Config) RootItem(item RootItem, extensions extensions.ExtensionMap) (types.ListItem, error)
• type RootItem

Variables

var DefaultConfig = Config{
	Schema: "https://github.com/pomdtr/sunbeam/releases/latest/download/config.schema.json",
	Root: []RootItem{
		{
			Title:   "Open Sunbeam Docs",
			Command: "sunbeam open https://pomdtr.github.io/sunbeam/book/introduction.html",
		},
		{
			Title:   "Edit Config",
			Command: "sunbeam edit --config",
		},
	},
}

Functions

func CommandParam

func CommandParam(command types.CommandSpec, name string) (types.Param, bool)

func ExtractParams

func ExtractParams(args []string, command types.CommandSpec) (map[string]any, error)

func Path

func Path() string

Types

type Config

type Config struct {
	Schema  string            `json:"$schema,omitempty"`
	Root    []RootItem        `json:"root,omitempty"`
	EnvFile string            `json:"envFile,omitempty"`
	Env     map[string]string `json:"-"`
}

func Load

func Load() (Config, error)

func (Config) RootItem

func (c Config) RootItem(item RootItem, extensions extensions.ExtensionMap) (types.ListItem, error)

type RootItem

type RootItem struct {
	Title   string `json:"title"`
	Command string `json:"command"`
}