STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

finally properly handle quoted arguments to alias set

Browse source
This commit is contained in:
vilmibm 2020-06-03 15:00:49 -05:00
parent a3a6f25024
commit 6defbbf73f
2 changed files with 42 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

36
command/alias.go
View file

@ -27,7 +27,7 @@ var aliasSetCmd = &cobra.Command{
// linux in various shells against cobra 1.0; others on macos did /not/ see the same behavior.
DisableFlagParsing: true,
Short: "Create a shortcut for a gh command",
Long: `This command lets you write your own shortcuts for running gh. They can be simple strings or accept placeholder arguments.`,
Long: `This command lets you write your own shortcuts for running gh. They can be simple strings or accept placeholder arguments.`,
Example: `
gh alias set pv 'pr view'
# gh pv -w 123 -> gh pr view -w 123.
@ -57,15 +57,17 @@ func aliasSet(cmd *cobra.Command, args []string) error {
alias := args[0]
expansion := processArgs(args[1:])
out := colorableOut(cmd)
fmt.Fprintf(out, "- Adding alias for %s: %s\n", utils.Bold(alias), utils.Bold(expansion))
expansionStr := strings.Join(expansion, " ")
if validCommand(alias) {
out := colorableOut(cmd)
fmt.Fprintf(out, "- Adding alias for %s: %s\n", utils.Bold(alias), utils.Bold(expansionStr))
if validCommand([]string{alias}) {
return fmt.Errorf("could not create alias: %q is already a gh command", alias)
}
if !validCommand(expansion) {
return fmt.Errorf("could not create alias: %s does not correspond to a gh command", utils.Bold(expansion))
return fmt.Errorf("could not create alias: %s does not correspond to a gh command", utils.Bold(expansionStr))
}
successMsg := fmt.Sprintf("%s Added alias.", utils.Green("✓"))
@ -75,11 +77,11 @@ func aliasSet(cmd *cobra.Command, args []string) error {
utils.Green("✓"),
utils.Bold(alias),
utils.Bold(aliasCfg.Get(alias)),
utils.Bold(expansion),
utils.Bold(expansionStr),
)
}
err = aliasCfg.Add(alias, expansion)
err = aliasCfg.Add(alias, expansionStr)
if err != nil {
return fmt.Errorf("could not create alias: %s", err)
}
@ -89,16 +91,24 @@ func aliasSet(cmd *cobra.Command, args []string) error {
return nil
}
func validCommand(expansion string) bool {
split, _ := shlex.Split(expansion)
cmd, _, err := RootCmd.Traverse(split)
func validCommand(expansion []string) bool {
cmd, _, err := RootCmd.Traverse(expansion)
return err == nil && cmd != RootCmd
}
func processArgs(args []string) string {
func processArgs(args []string) []string {
if len(args) == 1 {
return args[0]
split, _ := shlex.Split(args[0])
return split
}
return strings.Join(args, " ")
newArgs := []string{}
for _, a := range args {
if !strings.HasPrefix(a, "-") && strings.Contains(a, " ") {
a = fmt.Sprintf("%q", a)
}
newArgs = append(newArgs, a)
}
return newArgs
}

21
command/alias_test.go
View file

@ -75,6 +75,23 @@ aliases:
test.ExpectLines(t, output.String(), "Changed alias co from pr checkout to pr checkout -Rcool/repo")
}
func TestAliasSet_space_args(t *testing.T) {
initBlankContext("", "OWNER/REPO", "trunk")
buf := bytes.NewBufferString("")
defer config.StubWriteConfig(buf)()
output, err := RunCommand(`alias set il issue list -l 'cool story'`)
if err != nil {
t.Fatalf("unexpected error: %s", err)
}
test.ExpectLines(t, output.String(), `Adding alias for il: issue list -l "cool story"`)
test.ExpectLines(t, buf.String(), `il: issue list -l "cool story"`)
}
func TestAliasSet_arg_processing(t *testing.T) {
initBlankContext("", "OWNER/REPO", "trunk")
cases := []struct {
@ -93,8 +110,8 @@ func TestAliasSet_arg_processing(t *testing.T) {
`iy: issue list --author=\$1 --label=\$2`},
{`alias set ii 'issue list --author="$1" --label="$2"'`,
`- Adding alias for ii: issue list --author="\$1" --label="\$2"`,
`ii: issue list --author="\$1" --label="\$2"`},
`- Adding alias for ii: issue list --author=\$1 --label=\$2`,
`ii: issue list --author=\$1 --label=\$2`},
{`alias set ix issue list --author='$1' --label='$2'`,
`- Adding alias for ix: issue list --author=\$1 --label=\$2`,