x/urfave-cli
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #879 from saschagrunert/escape-single-quotes

Browse Source 
Escape single quotes in fish shell completion
This commit is contained in:
Audrius Butkevicius 2019-08-30 15:53:55 +01:00 committed by GitHub
commit 3eca1090a3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs_test.go
View File

@ -11,7 +11,7 @@ func testApp() *App {
app.Flags = []Flag{ app.Flags = []Flag{
StringFlag{ StringFlag{
Name: "socket, s", Name: "socket, s",
Usage: "some usage text", Usage: "some 'usage' text",
Value: "value", Value: "value",
TakesFile: true, TakesFile: true,
}, },

10
fish.go
View File

@ -78,7 +78,8 @@ func (a *App) prepareFishCommands(commands []Command, allCommands *[]string, pre
)) ))
if command.Usage != "" { if command.Usage != "" {
completion.WriteString(fmt.Sprintf(" -d '%s'", command.Usage)) completion.WriteString(fmt.Sprintf(" -d '%s'",
escapeSingleQuotes(command.Usage)))
} }
if !command.HideHelp { if !command.HideHelp {
@ -144,7 +145,8 @@ func (a *App) prepareFishFlags(flags []Flag, previousCommands []string) []string
} }
if flag.GetUsage() != "" { if flag.GetUsage() != "" {
completion.WriteString(fmt.Sprintf(" -d '%s'", flag.GetUsage())) completion.WriteString(fmt.Sprintf(" -d '%s'",
escapeSingleQuotes(flag.GetUsage())))
} }
completions = append(completions, completion.String()) completions = append(completions, completion.String())
@ -182,3 +184,7 @@ func (a *App) fishSubcommandHelper(allCommands []string) string {
return fishHelper return fishHelper
} }
func escapeSingleQuotes(input string) string {
return strings.Replace(input, `'`, `\'`, -1)
}

2
testdata/expected-doc-full.man vendored
View File

@ -49,7 +49,7 @@ greet [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...]
\fB\-\-flag, \-\-fl, \-f\fP="": \fB\-\-flag, \-\-fl, \-f\fP="":
.PP .PP
\fB\-\-socket, \-s\fP="": some usage text (default: value) \fB\-\-socket, \-s\fP="": some 'usage' text (default: value)
.SH COMMANDS .SH COMMANDS

2
testdata/expected-doc-full.md vendored
View File

@ -32,7 +32,7 @@ greet [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...]
**--flag, --fl, -f**="": **--flag, --fl, -f**="":
**--socket, -s**="": some usage text (default: value) **--socket, -s**="": some 'usage' text (default: value)
# COMMANDS # COMMANDS

2
testdata/expected-doc-no-commands.md vendored
View File

@ -32,5 +32,5 @@ greet [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...]
**--flag, --fl, -f**="": **--flag, --fl, -f**="":
**--socket, -s**="": some usage text (default: value) **--socket, -s**="": some 'usage' text (default: value)

2
testdata/expected-fish-full.fish vendored
View File

@ -9,7 +9,7 @@ function __fish_greet_no_subcommand --description 'Test if there has been any su
return 0 return 0
end end
complete -c greet -n '__fish_greet_no_subcommand' -l socket -s s -r -d 'some usage text' complete -c greet -n '__fish_greet_no_subcommand' -l socket -s s -r -d 'some \'usage\' text'
complete -c greet -n '__fish_greet_no_subcommand' -f -l flag -s fl -s f -r complete -c greet -n '__fish_greet_no_subcommand' -f -l flag -s fl -s f -r
complete -c greet -n '__fish_greet_no_subcommand' -f -l another-flag -s b -d 'another usage text' complete -c greet -n '__fish_greet_no_subcommand' -f -l another-flag -s b -d 'another usage text'
complete -c greet -n '__fish_greet_no_subcommand' -f -l help -s h -d 'show help' complete -c greet -n '__fish_greet_no_subcommand' -f -l help -s h -d 'show help'