Skip to content

fix shell completion description escape #102

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix shell completion description escape #102

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
7 changes: 6 additions & 1 deletion Sources/SwiftCLI/CompletionGenerator.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,12 @@ public final class ZshCompletionGenerator: CompletionGenerator {
}

private func escapeDescription(_ description: String) -> String {
return description.replacingOccurrences(of: "\"", with: "\\\"")
// @see `man bash` and search for "Enclosing characters in double quotes"
return description
.replacingOccurrences(of: #"\"#, with: #"\\"#)
.replacingOccurrences(of: "\"", with: "\\\"") // (") -> (\")
.replacingOccurrences(of: #"`"#, with: #"\`"#)
.replacingOccurrences(of: #"$"#, with: #"\$"#)
}

private func functionName(for routable: RoutablePath) -> String {
Expand Down