Install shell completions (#209)

.gitignore

@@ -15,3 +15,5 @@ build
 dist
 key.*
 *.asc
+
+completions

.goreleaser.yml

@@ -1,3 +1,7 @@
+before:
+  hooks:
+    - ./scripts/completions.sh
+
 builds:
   - env:
       - CGO_ENABLED=0
@@ -13,6 +17,10 @@ archives:
   # https://github.com/spacelift-io/setup-spacectl
   - format: zip
     name_template: "{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}"
+    files:
+      - LICENSE
+      - README.md
+      - completions/*
 
 dockers:
   - use: buildx
@@ -99,6 +107,10 @@ brews:
     homepage: https://github.com/spacelift-io/spacectl
     description: "Spacelift client and CLI"
     license: "MIT"
+    extra_install: |
+      bash_completion.install "completions/{{ .ProjectName }}.bash" => "{{ .ProjectName }}"
+      zsh_completion.install "completions/{{ .ProjectName }}.zsh" => "_{{ .ProjectName }}"
+      fish_completion.install "completions/{{ .ProjectName }}.fish"
 
 winget:
   - name: "{{ .ProjectName }}"

internal/cmd/completion/bash_autocomplete

@@ -0,0 +1,32 @@
+#! /bin/bash
+
+# Macs have bash3 for which the bash-completion package doesn't include
+# _init_completion. This is a minimal version of that function.
+_cli_init_completion() {
+  COMPREPLY=()
+  _get_comp_words_by_ref "$@" cur prev words cword
+}
+
+_cli_bash_autocomplete() {
+  if [[ "${COMP_WORDS[0]}" != "source" ]]; then
+    local cur opts base words
+    COMPREPLY=()
+    cur="${COMP_WORDS[COMP_CWORD]}"
+    if declare -F _init_completion >/dev/null 2>&1; then
+      _init_completion -n "=:" || return
+    else
+      _cli_init_completion -n "=:" || return
+    fi
+    words=("${words[@]:0:$cword}")
+    if [[ "$cur" == "-"* ]]; then
+      requestComp="${words[*]} ${cur} --generate-bash-completion"
+    else
+      requestComp="${words[*]} --generate-bash-completion"
+    fi
+    opts=$(eval "${requestComp}" 2>/dev/null)
+    COMPREPLY=($(compgen -W "${opts}" -- ${cur}))
+    return 0
+  fi
+}
+
+complete -o bashdefault -o default -o nospace -F _cli_bash_autocomplete spacectl

internal/cmd/completion/completion.go

@@ -0,0 +1,56 @@
+package completion
+
+import (
+	"bytes"
+	_ "embed"
+	"io"
+	"os"
+	"strings"
+
+	"github.com/urfave/cli/v2"
+)
+
+var (
+	//go:embed bash_autocomplete
+	bashAutocomplete []byte
+
+	//go:embed zsh_autocomplete
+	zshAutocomplete []byte
+)
+
+func Command() *cli.Command {
+	return &cli.Command{
+		Name:  "completion",
+		Usage: "Print out shell completion script",
+		Subcommands: []*cli.Command{
+			{
+				Name:  "bash",
+				Usage: "Print out bash shell completion script",
+				Action: func(cliCtx *cli.Context) error {
+					_, err := io.Copy(os.Stdout, bytes.NewReader(bashAutocomplete))
+					return err
+				},
+			},
+			{
+				Name:  "zsh",
+				Usage: "Print out zsh shell completion script",
+				Action: func(cliCtx *cli.Context) error {
+					_, err := io.Copy(os.Stdout, bytes.NewReader(zshAutocomplete))
+					return err
+				},
+			},
+			{
+				Name:  "fish",
+				Usage: "Print out fish shell completion script",
+				Action: func(cliCtx *cli.Context) error {
+					s, err := cliCtx.App.ToFishCompletion()
+					if err != nil {
+						return err
+					}
+					_, err = io.Copy(os.Stdout, strings.NewReader(s))
+					return err
+				},
+			},
+		},
+	}
+}

internal/cmd/completion/zsh_autocomplete

@@ -0,0 +1,20 @@
+#compdef spacectl
+
+_cli_zsh_autocomplete() {
+  local -a opts
+  local cur
+  cur=${words[-1]}
+  if [[ "$cur" == "-"* ]]; then
+    opts=("${(@f)$(${words[@]:0:#words[@]-1} ${cur} --generate-bash-completion)}")
+  else
+    opts=("${(@f)$(${words[@]:0:#words[@]-1} --generate-bash-completion)}")
+  fi
+
+  if [[ "${opts[1]}" != "" ]]; then
+    _describe 'values' opts
+  else
+    _files
+  fi
+}
+
+compdef _cli_zsh_autocomplete spacectl

main.go

@@ -7,6 +7,7 @@ import (
 
 	"github.com/urfave/cli/v2"
 
+	"github.com/spacelift-io/spacectl/internal/cmd/completion"
 	"github.com/spacelift-io/spacectl/internal/cmd/module"
 	"github.com/spacelift-io/spacectl/internal/cmd/profile"
 	"github.com/spacelift-io/spacectl/internal/cmd/provider"
@@ -26,10 +27,11 @@ func main() {
 		log.Fatalf("Could not parse compilation date: %v", err)
 	}
 	app := &cli.App{
-		Name:     "spacectl",
-		Version:  version,
-		Compiled: compileTime,
-		Usage:    "Programmatic access to Spacelift GraphQL API.",
+		Name:                 "spacectl",
+		Version:              version,
+		Compiled:             compileTime,
+		Usage:                "Programmatic access to Spacelift GraphQL API.",
+		EnableBashCompletion: true,
 		Commands: []*cli.Command{
 			module.Command(),
 			profile.Command(),
@@ -39,6 +41,7 @@ func main() {
 			whoami.Command(),
 			versioncmd.Command(version),
 			workerpools.Command(),
+			completion.Command(),
 		},
 	}
 

scripts/completions.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+set -e
+
+rm -rf completions
+mkdir completions
+
+for sh in bash zsh fish; do
+	go run main.go completion "$sh" >"completions/spacectl.$sh"
+done