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/bettercallshao/kwt

Links

Open Source Insights

Documentation ¶

Index ¶

func Home() string
func Ingest(source string) error
func List() []string
func Map() map[string]Menu
func MapRepo(repo string) map[string]Menu
func Pwd() string
func Render(action Action) (string, error)
type Action
type Menu
- func Load(name string) (Menu, error)
- func Parse(data []byte) (Menu, error)
type Param

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Home ¶

func Home() string

Home retrieves path of kwt home e.g. /home/james/.kwt

func Ingest ¶

func Ingest(source string) error

Ingest a file into system store

func List ¶

func List() []string

List generates list of menu names, home first, pwd after

func Map ¶ added in v0.6.0

func Map() map[string]Menu

Map loads all available menus

func MapRepo ¶ added in v0.6.0

func MapRepo(repo string) map[string]Menu

MapRepo loads available menus from repo

func Pwd ¶ added in v0.6.0

func Pwd() string

Pwd path used to find menus i.e. .kwt

func Render ¶

func Render(action Action) (string, error)

Render an action into a command

Types ¶

type Action ¶

type Action struct {
	Name     string   `json:"name" binding:"required"`
	Aliases  []string `json:"aliases"`
	Help     string   `json:"help"`
	Template string   `json:"template" binding:"required"`
	Params   []Param  `json:"params"`
}

Action struct: a thing a user can do

type Menu struct {
	Name    string   `json:"name" binding:"required"`
	Aliases []string `json:"aliases"`
	Version string   `json:"version"`
	Help    string   `json:"help"`
	Actions []Action `json:"actions" binding:"required"`
	Hash    string   `json:"hash"`
	Path    string   `json:"path"`
}

Menu struct: a list of actions

func Load ¶

func Load(name string) (Menu, error)

Load loads the menu identified by name

func Parse ¶

func Parse(data []byte) (Menu, error)

Parse a menu given a blob

type Param ¶

type Param struct {
	Name    string   `json:"name" binding:"required"`
	Aliases []string `json:"aliases"`
	Help    string   `json:"help"`
	Value   string   `json:"value"`
}

Param struct: a parameter for a action

Source Files ¶

View all Source files

menu.go

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