Skip to content

zsh: fix quoting state #1095

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
rsteube merged 1 commit into from
Jan 19, 2025
Merged

zsh: fix quoting state #1095

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
4 changes: 2 additions & 2 deletions docs/src/development/vhs/doubleQuoteOpen/out/doubleQuoteOpen.zsh.ascii
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@


────────────────────────────────────────────────────────────────────────────────
> example action embeddedP1 "embeddedP2\ with\ space
> example action embeddedP1 "embeddedP2\ with\ space"






────────────────────────────────────────────────────────────────────────────────
> example action embeddedP1 "embeddedP2\ with\ space
> example action embeddedP1 "embeddedP2\ with\ space"



Expand Down
4 changes: 2 additions & 2 deletions docs/src/development/vhs/singleQuoteOpen/out/singleQuoteOpen.zsh.ascii
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@


────────────────────────────────────────────────────────────────────────────────
> example action embeddedP1 'embeddedP2\ with\ space
> example action embeddedP1 'embeddedP2\ with\ space'






────────────────────────────────────────────────────────────────────────────────
> example action embeddedP1 'embeddedP2\ with\ space
> example action embeddedP1 'embeddedP2\ with\ space'



Expand Down
4 changes: 2 additions & 2 deletions example/cmd/_test/zsh.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ function _example_completion {
if echo ${words}"''" | xargs echo 2>/dev/null > /dev/null; then
local lines="$(echo ${words}"''" | CARAPACE_ZSH_HASH_DIRS="$(hash -d)" xargs example _carapace zsh )"
elif echo ${words} | sed "s/\$/'/" | xargs echo 2>/dev/null > /dev/null; then
local lines="$(echo ${words} | sed "s/\$/'/" | CARAPACE_ZSH_HASH_DIRS="$(hash -d)" xargs example _carapace zsh)"
local lines="$(echo ${words} | sed "s/\$/'/" | CARAPACE_STATE=QUOTING_STATE CARAPACE_ZSH_HASH_DIRS="$(hash -d)" xargs example _carapace zsh)"
else
local lines="$(echo ${words} | sed 's/$/"/' | CARAPACE_ZSH_HASH_DIRS="$(hash -d)" xargs example _carapace zsh)"
local lines="$(echo ${words} | sed 's/$/"/' | CARAPACE_STATE=QUOTING_ESCAPING_STATE CARAPACE_ZSH_HASH_DIRS="$(hash -d)" xargs example _carapace zsh)"
fi

local zstyle message data
Expand Down
13 changes: 13 additions & 0 deletions internal/env/env.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"os"
"strings"

shlex "github.com/carapace-sh/carapace-shlex"
"github.com/carapace-sh/carapace/internal/common"
)

Expand All @@ -18,6 +19,7 @@ const (
CARAPACE_MATCH = "CARAPACE_MATCH" // match case insensitive
CARAPACE_NOSPACE = "CARAPACE_NOSPACE" // nospace suffixes
CARAPACE_SANDBOX = "CARAPACE_SANDBOX" // mock context for sandbox tests
CARAPACE_STATE = "CARAPACE_STATE" // current word state
CARAPACE_TOOLTIP = "CARAPACE_TOOLTIP" // enable tooltip style
CARAPACE_ZSH_HASH_DIRS = "CARAPACE_ZSH_HASH_DIRS" // zsh hash directories
CLICOLOR = "CLICOLOR" // disable color
Expand Down Expand Up @@ -76,6 +78,17 @@ func Tooltip() bool {
return getBool(CARAPACE_TOOLTIP)
}

func State() shlex.LexerState {
switch os.Getenv(CARAPACE_STATE) {
case "QUOTING_STATE":
return shlex.QUOTING_STATE
case "QUOTING_ESCAPING_STATE":
return shlex.QUOTING_ESCAPING_STATE
default:
return shlex.START_STATE
}
}

func getBool(s string) bool {
switch os.Getenv(s) {
case "true", "1":
Expand Down
12 changes: 12 additions & 0 deletions internal/shell/zsh/action.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ import (
"fmt"
"strings"

shlex "github.com/carapace-sh/carapace-shlex"
"github.com/carapace-sh/carapace/internal/common"
"github.com/carapace-sh/carapace/internal/env"
)

var sanitizer = strings.NewReplacer(
Expand Down Expand Up @@ -63,6 +65,16 @@ func ActionRawValues(currentWord string, meta common.Meta, values common.RawValu
val.Value = quoteValue(val.Value)
val.Value = strings.ReplaceAll(val.Value, `\`, `\\`) // TODO find out why `_describe` needs another backslash
val.Value = strings.ReplaceAll(val.Value, `:`, `\:`) // TODO find out why `_describe` needs another backslash

switch env.State() {
// TODO depending on state value needs to be formatted differently
// TODO backspace strings are currently an issue
case shlex.QUOTING_STATE:
val.Value = val.Value + `'`
case shlex.QUOTING_ESCAPING_STATE:
val.Value = val.Value + `"`
}

if !meta.Nospace.Matches(val.Value) {
val.Value = val.Value + " "
}
Expand Down
4 changes: 2 additions & 2 deletions internal/shell/zsh/snippet.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ function _%v_completion {
if echo ${words}"''" | xargs echo 2>/dev/null > /dev/null; then
local lines="$(echo ${words}"''" | CARAPACE_ZSH_HASH_DIRS="$(hash -d)" xargs %v _carapace zsh )"
elif echo ${words} | sed "s/\$/'/" | xargs echo 2>/dev/null > /dev/null; then
local lines="$(echo ${words} | sed "s/\$/'/" | CARAPACE_ZSH_HASH_DIRS="$(hash -d)" xargs %v _carapace zsh)"
local lines="$(echo ${words} | sed "s/\$/'/" | CARAPACE_STATE=QUOTING_STATE CARAPACE_ZSH_HASH_DIRS="$(hash -d)" xargs %v _carapace zsh)"
else
local lines="$(echo ${words} | sed 's/$/"/' | CARAPACE_ZSH_HASH_DIRS="$(hash -d)" xargs %v _carapace zsh)"
local lines="$(echo ${words} | sed 's/$/"/' | CARAPACE_STATE=QUOTING_ESCAPING_STATE CARAPACE_ZSH_HASH_DIRS="$(hash -d)" xargs %v _carapace zsh)"
fi

local zstyle message data
Expand Down
Loading