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 Oneliner, extensionMap map[string]extensions.Extension) (types.ListItem, error)
• type ExtensionRef
  • func (e *ExtensionRef) UnmarshalJSON(b []byte) error
• type Oneliner

Variables

var DefaultConfig = Config{
	Schema: "https://github.com/pomdtr/sunbeam/releases/latest/download/config.schema.json",
	Oneliners: []Oneliner{
		{
			Title:   "Open Sunbeam Docs",
			Command: "sunbeam open https://pomdtr.github.io/sunbeam/book/introduction.html",
		},
		{
			Title:   "Edit Config",
			Command: "sunbeam edit --config",
		},
	},
	Extensions: map[string]ExtensionRef{
		"devdocs": {
			Origin: "https://raw.githubusercontent.com/pomdtr/sunbeam/main/extensions/devdocs.sh",
		},
		"google": {
			Origin: "https://raw.githubusercontent.com/pomdtr/sunbeam/main/extensions/google.sh",
		},
	},
}

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"`
	Oneliners  []Oneliner              `json:"oneliners,omitempty"`
	Extensions map[string]ExtensionRef `json:"extensions,omitempty"`
}

func Load

func Load() (Config, error)

func (Config) RootItem

func (c Config) RootItem(item Oneliner, extensionMap map[string]extensions.Extension) (types.ListItem, error)

type ExtensionRef

type ExtensionRef struct {
	Origin      string         `json:"origin"`
	Preferences map[string]any `json:"preferences,omitempty"`
}

func (*ExtensionRef) UnmarshalJSON

func (e *ExtensionRef) UnmarshalJSON(b []byte) error

type Oneliner

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