completion

Documentation

Overview

Package completion provides the defined CLI completion actions for Vela.

Usage:

import "github.com/go-vela/cli/action/completion"

Index

• Constants
• type Config
  • func (c *Config) Generate() error
  • func (c *Config) Validate() error

Constants

const BashAutoComplete = `` /* 554-byte string literal not displayed */

BashAutoComplete represents the script used to enable automatic completion for the Bash (https://www.gnu.org/software/bash/) Unix shell.

const ZshAutoComplete = `` /* 534-byte string literal not displayed */

ZshAutoComplete represents the script used to enable automatic completion for the Zsh (https://ohmyz.sh/) Unix shell.

Types

type Config

type Config struct {
	Action string
	Bash   bool
	Zsh    bool
}

Config represents the configuration necessary to perform completion related requests with Vela.

func (*Config) Generate

func (c *Config) Generate() error

Generate produces a script used to enable automatic completion for a Unix shell based off the provided configuration.

func (*Config) Validate

func (c *Config) Validate() error

Validate verifies the configuration provided.