zsh

Documentation

Overview

Package zsh provides zsh completion

Index

• Constants
• Variables
• func ActionRawValues(currentWord string, meta common.Meta, values common.RawValues) string
• func Snippet(cmd *cobra.Command) string

Constants

const (
	DEFAULT_STATE state = iota
	// Word starts with `"`.
	// Values need to end with `"` as well.
	// Weirdly regardless whether there are additional quotes within the word.
	QUOTING_ESCAPING_STATE
	// Word starts with `'`.
	// Values need to end with `'` as well.
	// Weirdly regardless whether there are additional quotes within the word.
	QUOTING_STATE
	// Word starts and ends with `"`.
	// Space suffix somehow ends up within the quotes.
	//    `"action"<TAB>`
	//    `"action "<CURSOR>`
	// Workaround for now is to force nospace.
	FULL_QUOTING_ESCAPING_STATE
	// Word starts and ends with `'`.
	// Space suffix somehow ends up within the quotes.
	//    `'action'<TAB>`
	//    `'action '<CURSOR>`
	// Workaround for now is to force nospace.
	FULL_QUOTING_STATE
)

Variables

var NamedDirectories = make(namedDirectories)

NamedDirectories provides rudimentary named directory support as these aren't expanded by zsh in the `${words}` provided to the compdef function

Functions

func ActionRawValues

func ActionRawValues(currentWord string, meta common.Meta, values common.RawValues) string

ActionRawValues formats values for zsh

func Snippet

func Snippet(cmd *cobra.Command) string

Snippet creates the zsh completion script