completion

Documentation

Overview

Package completion renders deterministic shell completion scripts.

Index

• func Render(shell Shell, ruleIDs []string) ([]byte, error)
• type Shell

Functions

func Render

func Render(shell Shell, ruleIDs []string) ([]byte, error)

Render returns one complete completion script for shell. Rule IDs are validated and ordered before interpolation into shell-owned word lists.

Types

type Shell

type Shell string

Shell identifies one supported completion-script dialect.

const (
	Bash Shell = "bash"
	Zsh  Shell = "zsh"
	Fish Shell = "fish"
)