completion

Documentation

Overview

Package completion supports bash completion for commands built using package flags.

References

* https://www.gnu.org/software/bash/manual/html_node/Programmable-Completion-Builtins.html

Index

• func AddCompletion(value, description string, prefix string)
• func BashScript(w io.Writer, bin, name string) error
• func FishScript(w io.Writer, bin, name string) error
• func ZshScript(w io.Writer, bin, name string) error
• type Env
  • func (env *Env) Init() bool
  • func (env *Env) LeadingWords() []string
  • func (env *Env) WriteCompletions(command interface{}, words []string)

Functions

func AddCompletion

func AddCompletion(value, description string, prefix string)

AddCompletion prints the possible completion if it matches the prefix.

func BashScript

func BashScript(w io.Writer, bin, name string) error

func FishScript

func FishScript(w io.Writer, bin, name string) error

func ZshScript

func ZshScript(w io.Writer, bin, name string) error

Types

type Env

type Env struct {
	Line  string
	Point int
	Type  int
	Key   int
}

Env contains the information passed by the shell in environment variables.

func (*Env) Init

func (env *Env) Init() bool

func (*Env) LeadingWords

func (env *Env) LeadingWords() []string

func (*Env) WriteCompletions

func (env *Env) WriteCompletions(command interface{}, words []string)