[docs] secrets edit does not work on windows when $env:EDITOR has spaces

[serverhorror]

When trying to edit files on Windows tailor doesn't accept the $env:EDITOR when the command has spaces, no shell/cmd parsing happens.

• https://github.com/opendevstack/tailor/blob/master/pkg/cli/cli.go#L148-L152

It would be nice to note that in the docs

Example:

tailor secrets edit foo.yaml
# Failed to edit file: Could not decrypt file: Reading key 'private.key' failed: invalid argument.
tailor secrets generate-key alice@example.invalid
# Public Key written to alice.key. This file can be committed.
# Private Key written to private.key. This file MUST NOT be committed.
tailor secrets edit foo.yaml
# Failed to edit file: Could not edit file: Please install 'code.exe -w' or set/change $EDITOR.
echo $env:EDITOR
code.exe -w

This works:

> cat $(where.exe codew.cmd)
@echo off

setlocal
REM Usually located in $env:LOCALAPPDATA\Programs\Microsoft VS Code\bin\code.cmd
code.cmd -w  %*
endlocal

Working session:

$env:EDITOR="codew.cmd"
tailor secrets edit foo.yaml
cat .\foo.yaml
user: alice=wcFMAySUogUAXelZARAAouVsMK85N3XNj+UlIATv...==

[michaelsauter]

Hmm. I believe this is because $EDITOR is supposed to be the name of a program. The full variable value is assumed to be an executable in your path. I can't find any examples online how to pass parameters to that by default. I don't think you can. What might work (on Unix at least) is to create an alias?

[serverhorror]

Some users don't have the choice of an OS :) -- the example works for Windows and wraps the editor so it is usable.

If you look at, for example, git this does work:

more ..\.gitconfig
[core]
  editor = code --wait
[diff]
  tool = vscode
[difftool "vscode"]
  cmd = code --wait --diff $LOCAL $REMOTE
[merge]
  tool = vscode
[mergetool "vscode"]
  cmd = code --wait $MERGED

You might want to use something like this:

• https://github.com/google/shlex/blob/e7afc7fbc51079733e9468cdfd1efcd7d196cd1d/shlex_test.go#L71
  • https://pkg.go.dev/github.com/google/shlex
• https://play.golang.org/p/Xgo7aqNGDl2 (completely untested, just quickly cobbled together)

Although I think just mentioning that would be enough

[michaelsauter]

@serverhorror Thanks for the example. You're right, I think using shlex could be an option.