mirror of
https://github.com/spf13/cobra
synced 2024-07-03 00:51:39 +00:00
0e4db1bd14
- Renamed completer to be cobra_completer to match docs - Added whitespace after each completion - Implemented ShellCompDirectiveError, ShellCompDirectiveNoSpace, ShellCompDirectiveNoFileComp - Disabled active help as it isn't supported by nushell - Added nushell to the default completion command
100 lines
3.3 KiB
Go
100 lines
3.3 KiB
Go
// Copyright 2013-2022 The Cobra Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package cobra
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"io"
|
|
"os"
|
|
)
|
|
|
|
func (c *Command) GenNushellCompletion(w io.Writer) error {
|
|
buf := new(bytes.Buffer)
|
|
WriteStringAndCheck(buf, fmt.Sprintf(`
|
|
# An external configurator that works with any cobra based
|
|
# command line application (e.g. kubectl, minikube)
|
|
let cobra_completer = {|spans|
|
|
|
|
let ShellCompDirectiveError = %[1]d
|
|
let ShellCompDirectiveNoSpace = %[2]d
|
|
let ShellCompDirectiveNoFileComp = %[3]d
|
|
let ShellCompDirectiveFilterFileExt = %[4]d
|
|
let ShellCompDirectiveFilterDirs = %[5]d
|
|
|
|
let cmd = $spans.0
|
|
let last_span = ($spans | last | str trim)
|
|
|
|
# skip the first entry in the span (the command) and join the rest of the span to create __complete args
|
|
let cmd_args = ($spans | skip 1 | str join ' ')
|
|
|
|
# If the last span entry was empty add "" to the end of the command args
|
|
let cmd_args = if ($last_span | is-empty) {
|
|
$'($cmd_args) ""'
|
|
} else {
|
|
$cmd_args
|
|
}
|
|
|
|
# The full command to be executed with active help disable (Nushell does not support active help)
|
|
let full_cmd = $'($cmd)_ACTIVE_HELP=0 ($cmd) __complete ($cmd_args)'
|
|
|
|
# Since nushell doesn't have anything like eval, execute in a subshell
|
|
let result = (do -i { nu -c $"'($full_cmd)'" } | complete)
|
|
|
|
# Create a record with all completion related info.
|
|
# directive and directive_str are for posterity
|
|
let stdout_lines = ($result.stdout | lines)
|
|
let directive = ($stdout_lines | last | str trim | str replace ":" "" | into int)
|
|
let completions = ($stdout_lines | drop | parse -r '([\w\-\.:\+\=]*)\t?(.*)' | rename value description)
|
|
|
|
# Add space at the end of each completion
|
|
let completions = if $directive != $ShellCompDirectiveNoSpace {
|
|
($completions | each {|it| {value: $"($it.value) ", description: $it.description}})
|
|
} else {
|
|
$completions
|
|
}
|
|
|
|
if $last_span =~ '=$' {
|
|
# return flag as part of the completion so that it doesn't get replaced
|
|
$completions | each {|it| $"($last_span)($it.value)" }
|
|
} else if $directive == $ShellCompDirectiveNoFileComp {
|
|
# Allow empty results as this will stop file completion
|
|
$completions
|
|
} else if ($completions | is-empty) or $directive == $ShellCompDirectiveError {
|
|
# Not returning null causes file completions to break
|
|
# Return null if there are no completions or ShellCompDirectiveError
|
|
null
|
|
} else {
|
|
$completions
|
|
}
|
|
|
|
}
|
|
`, ShellCompDirectiveError, ShellCompDirectiveNoSpace, ShellCompDirectiveNoFileComp,
|
|
ShellCompDirectiveFilterFileExt, ShellCompDirectiveFilterDirs))
|
|
|
|
_, err := buf.WriteTo(w)
|
|
return err
|
|
}
|
|
|
|
func (c *Command) GenNushellCompletionFile(filename string) error {
|
|
outFile, err := os.Create(filename)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer outFile.Close()
|
|
|
|
return c.GenNushellCompletion(outFile)
|
|
}
|