Skip to content

Escape single quotes in shellCommand completions for fish #811

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

Merged
merged 1 commit into from
Sep 19, 2025
Merged

Escape single quotes in shellCommand completions for fish #811

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
2 changes: 1 addition & 1 deletion Examples/math/Math.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ extension Math.Statistics {
var directory: String?

@Option(
completion: .shellCommand("head -100 /usr/share/dict/words | tail -50")
completion: .shellCommand("head -100 '/usr/share/dict/words' | tail -50")
)
var shell: String?

Expand Down
4 changes: 3 additions & 1 deletion Sources/ArgumentParser/Completions/FishCompletionsGenerator.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,9 @@ extension CommandInfoV0 {
case .directory:
results += ["-\(r)fa '(\(completeDirectoriesFunctionName))'"]
case .shellCommand(let shellCommand):
results += ["-\(r)fka '(\(shellCommand))'"]
results += [
"-\(r)fka '(\(shellCommand.fishEscapeForSingleQuotedString()))'"
]
case .custom, .customAsync:
results += [
"""
Expand Down
2 changes: 1 addition & 1 deletion Tests/ArgumentParserExampleTests/Snapshots/testMathBashCompletionScript().bash
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ _math_stats_quantiles() {
return
;;
'--shell')
__math_add_completions -W "$(eval 'head -100 /usr/share/dict/words | tail -50')"
__math_add_completions -W "$(eval 'head -100 '\''/usr/share/dict/words'\'' | tail -50')"
return
;;
'--custom')
Expand Down
2 changes: 1 addition & 1 deletion Tests/ArgumentParserExampleTests/Snapshots/testMathFishCompletionScript().fish
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ complete -c 'math' -n '__math_should_offer_completions_for "math stats quantiles
complete -c 'math' -n '__math_should_offer_completions_for "math stats quantiles" 3' -fka '(__math_custom_completion ---completion stats quantiles -- positional@2)'
complete -c 'math' -n '__math_should_offer_completions_for "math stats quantiles"' -l 'file' -rfa '(set -l exts \'txt\' \'md\';for p in (string match -e -- \'*/\' (commandline -t);or printf \n)*.{$exts};printf %s\n $p;end;__fish_complete_directories (commandline -t) \'\')'
complete -c 'math' -n '__math_should_offer_completions_for "math stats quantiles"' -l 'directory' -rfa '(__math_complete_directories)'
complete -c 'math' -n '__math_should_offer_completions_for "math stats quantiles"' -l 'shell' -rfka '(head -100 /usr/share/dict/words | tail -50)'
complete -c 'math' -n '__math_should_offer_completions_for "math stats quantiles"' -l 'shell' -rfka '(head -100 \'/usr/share/dict/words\' | tail -50)'
complete -c 'math' -n '__math_should_offer_completions_for "math stats quantiles"' -l 'custom' -rfka '(__math_custom_completion ---completion stats quantiles -- --custom (count (__math_tokens -pc)) (__math_tokens -tC))'
complete -c 'math' -n '__math_should_offer_completions_for "math stats quantiles"' -l 'custom-deprecated' -rfka '(__math_custom_completion ---completion stats quantiles -- --custom-deprecated)'
complete -c 'math' -n '__math_should_offer_completions_for "math stats quantiles"' -l 'version' -d 'Show the version.'
Expand Down
2 changes: 1 addition & 1 deletion Tests/ArgumentParserExampleTests/Snapshots/testMathZshCompletionScript().zsh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ _math_stats_quantiles() {
'*:values:'
'--file:file:_files -g '\''*.txt *.md'\'''
'--directory:directory:_files -/'
'--shell:shell:{local -a list;list=(${(f)"$(head -100 /usr/share/dict/words | tail -50)"});_describe -V "" list}'
'--shell:shell:{local -a list;list=(${(f)"$(head -100 '\''/usr/share/dict/words'\'' | tail -50)"});_describe -V "" list}'
'--custom:custom:{__math_custom_complete ---completion stats quantiles -- --custom "${current_word_index}" "$(__math_cursor_index_in_current_word)"}'
'--custom-deprecated:custom-deprecated:{__math_custom_complete ---completion stats quantiles -- --custom-deprecated}'
'--version[Show the version.]'
Expand Down
2 changes: 1 addition & 1 deletion Tests/ArgumentParserUnitTests/Snapshots/testMathDumpHelp().json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -603,7 +603,7 @@
{
"completionKind" : {
"shellCommand" : {
"command" : "head -100 \/usr\/share\/dict\/words | tail -50"
"command" : "head -100 '\/usr\/share\/dict\/words' | tail -50"
}
},
"isOptional" : true,
Expand Down
2 changes: 1 addition & 1 deletion Tests/ArgumentParserUnitTests/Snapshots/testMathStatsDumpHelp().json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@
{
"completionKind" : {
"shellCommand" : {
"command" : "head -100 \/usr\/share\/dict\/words | tail -50"
"command" : "head -100 '\/usr\/share\/dict\/words' | tail -50"
}
},
"isOptional" : true,
Expand Down