Skip to content

Test that completions can contain a space for bash #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
marckhouzam wants to merge 1 commit into from
Closed

Test that completions can contain a space for bash #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions testprog/testprog.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package main

import (
"fmt"
"log"
"os"
"strings"

Expand Down Expand Up @@ -211,6 +212,26 @@ var manyCompsCmd = &cobra.Command{
Run: func(cmd *cobra.Command, args []string) {},
}

// ======================================================
// Command that provide completions containing a space
// ======================================================
var compWithSpaceCmd = &cobra.Command{
Use: "space",
Short: "Completions that contain a space",
ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
var comps []string
if len(args) == 0 {
comps = []string{"with space", "desc for with space\tDescription for comp with space"}
}
return comps, cobra.ShellCompDirectiveNoFileComp
},
Run: func(cmd *cobra.Command, args []string) {
if len(args) > 0 && args[0] != "with space" && args[0] != "with space and desc" {
log.Fatal("Got wrong arg")
}
},
}

func setFlags() {
rootCmd.Flags().String("customComp", "", "test custom comp for flags")
rootCmd.RegisterFlagCompletionFunc("customComp", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
Expand All @@ -236,6 +257,7 @@ func main() {
errorCmd,
dashArgCmd,
manyCompsCmd,
compWithSpaceCmd,
)

prefixCmd.AddCommand(
Expand Down
11 changes: 11 additions & 0 deletions tests/bash/comp-tests.bash
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,17 @@ _completionTests_timing "testprog manycomps " 0.2 "insert-completions no descs"

unset COMP_TYPE

# Test that completions can contain a space.
# We only support this for bash completion v2
# https://github.com/spf13/cobra/issues/1740
# https://github.com/spf13/cobra/pull/1743
if [ "$BASHCOMP_VERSION" = bash2 ]; then
# Disable sorting as it would mistakenly split the completion on the space
BASH_COMP_NO_SORT=1
_completionTests_verifyCompletion "testprog space w" "with\ space" nofile
unset BASH_COMP_NO_SORT
fi

# Test descriptions of bash v2
if [ "$BASHCOMP_VERSION" = bash2 ]; then

Expand Down