mirror of
https://github.com/gopasspw/gopass.git
synced 2026-10-20 04:18:28 +02:00
Dominik Schulz
7c63ba09b7
Migrate the entire codebase from github.com/urfave/cli/v2 to github.com/urfave/cli/v3 (v3.9.0). Key breaking changes addressed: - cli.App removed, replaced by *cli.Command - ActionFunc signature: func(*Context) error -> func(context.Context, *Command) error - BeforeFunc signature: func(*Context) error -> func(context.Context, *Command) (context.Context, error) - app.RunContext -> app.Run - app.EnableBashCompletion -> app.EnableShellCompletion - Subcommands field renamed to Commands - EnvVars on flags -> Sources: cli.EnvVars(...) - cli.NewContext removed; test helpers updated to use cmd.Run() pattern - cli.Flag interface updated (Apply removed, Get/PreParse/PostParse/Set added) - VersionPrinter type changed to func(*Command) Also updates .capabilities.json baseline to reflect new cli/v3 call paths. Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
107 lines
3.0 KiB
Go
107 lines
3.0 KiB
Go
package fish
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"html/template"
|
|
"strings"
|
|
|
|
"github.com/urfave/cli/v3"
|
|
)
|
|
|
|
// ErrUnknownType is returned when an unknown type is encountered.
|
|
var ErrUnknownType = fmt.Errorf("unknown type")
|
|
|
|
func longName(name string) string {
|
|
// "If s does not contain sep and sep is not empty, Split returns a slice of length 1 whose only element is s."
|
|
// from https://golang.org/pkg/strings/#Split.
|
|
return strings.TrimSpace(strings.Split(name, ",")[0])
|
|
}
|
|
|
|
func shortName(name string) string {
|
|
parts := strings.Split(name, ",")
|
|
if len(parts) < 2 {
|
|
return ""
|
|
}
|
|
|
|
return strings.TrimSpace(parts[1])
|
|
}
|
|
|
|
func escapePasswordName(name string) string {
|
|
// Escape special characters for fish completions.
|
|
// In fish, we use single quotes in the complete command, so we need to handle single quotes.
|
|
// We also escape backslashes to be safe.
|
|
name = strings.ReplaceAll(name, "\\", "\\\\")
|
|
// Single quotes need to be escaped by ending the single-quoted string, adding an escaped single quote, and starting a new single-quoted string
|
|
// E.g. 'hello'world' becomes 'hello'\''world'
|
|
name = strings.ReplaceAll(name, "'", "'\\''")
|
|
|
|
return name
|
|
}
|
|
|
|
func formatFlag(name, usage, typ string) string {
|
|
switch typ {
|
|
case "short":
|
|
return shortName(name)
|
|
case "long":
|
|
return longName(name)
|
|
case "usage":
|
|
return usage
|
|
default:
|
|
return ""
|
|
}
|
|
}
|
|
|
|
func formatFlagFunc(typ string) func(cli.Flag) (string, error) {
|
|
return func(f cli.Flag) (string, error) {
|
|
switch ft := f.(type) {
|
|
case *cli.BoolFlag:
|
|
return formatFlag(ft.Name, ft.Usage, typ), nil
|
|
case *cli.Float64Flag:
|
|
return formatFlag(ft.Name, ft.Usage, typ), nil
|
|
case *cli.GenericFlag:
|
|
return formatFlag(ft.Name, ft.Usage, typ), nil
|
|
case *cli.Int64Flag:
|
|
return formatFlag(ft.Name, ft.Usage, typ), nil
|
|
case *cli.Int64SliceFlag:
|
|
return formatFlag(ft.Name, ft.Usage, typ), nil
|
|
case *cli.IntFlag:
|
|
return formatFlag(ft.Name, ft.Usage, typ), nil
|
|
case *cli.IntSliceFlag:
|
|
return formatFlag(ft.Name, ft.Usage, typ), nil
|
|
case *cli.StringFlag:
|
|
return formatFlag(ft.Name, ft.Usage, typ), nil
|
|
case *cli.StringSliceFlag:
|
|
return formatFlag(ft.Name, ft.Usage, typ), nil
|
|
case *cli.Uint64Flag:
|
|
return formatFlag(ft.Name, ft.Usage, typ), nil
|
|
case *cli.UintFlag:
|
|
return formatFlag(ft.Name, ft.Usage, typ), nil
|
|
default:
|
|
return "", fmt.Errorf("error '%T': %w", f, ErrUnknownType)
|
|
}
|
|
}
|
|
}
|
|
|
|
// GetCompletion returns a fish completion script.
|
|
func GetCompletion(a *cli.Command) (string, error) {
|
|
tplFuncs := template.FuncMap{
|
|
"formatShortFlag": formatFlagFunc("short"),
|
|
"formatLongFlag": formatFlagFunc("long"),
|
|
"formatFlagUsage": formatFlagFunc("usage"),
|
|
"escapePasswordName": escapePasswordName,
|
|
}
|
|
|
|
tpl, err := template.New("fish").Funcs(tplFuncs).Parse(fishTemplate)
|
|
if err != nil {
|
|
return "", fmt.Errorf("failed to parse template: %w", err)
|
|
}
|
|
|
|
buf := &bytes.Buffer{}
|
|
if err := tpl.Execute(buf, a); err != nil {
|
|
return "", fmt.Errorf("failed to execute template: %w", err)
|
|
}
|
|
|
|
return buf.String(), nil
|
|
}
|