Source File
	uid.go

Belonging Package
	github.com/carapace-sh/carapace/pkg/uid

// Package uid provides unique identifiers
package uid

import (
	"net/url"
	"os"
	"path/filepath"
	"strings"

	"github.com/carapace-sh/carapace/internal/pflagfork"
	"github.com/spf13/cobra"
)

type Context interface {
	Abs(s string) (string, error)
	Getenv(key string) string
	LookupEnv(key string) (string, bool)
}

// Command creates a uid for given command.
func Command(cmd *cobra.Command) *url.URL {
	path := []string{cmd.Name()}
	for parent := cmd.Parent(); parent != nil; parent = parent.Parent() {
		path = append(path, parent.Name())
	}
	reverse(path) // TODO slices.Reverse
	return &url.URL{
		Scheme: "cmd",
		Host:   path[0],
		Path:   strings.Join(path[1:], "/"),
	}
}

// reverse reverses the elements of the slice in place.
func reverse(s []string) {
	for i, j := 0, len(s)-1; i < j; i, j = i+1, j-1 {
		s[i], s[j] = s[j], s[i]
	}
}

// Flag creates a uid for given flag.
func Flag(cmd *cobra.Command, flag *pflagfork.Flag) *url.URL {
	uid := Command(cmd)
	values := uid.Query()
	values.Set("flag", flag.Name)
	uid.RawQuery = values.Encode()
	return uid
}

// Executable returns the name of the executable.
func Executable() string {
	executable, err := os.Executable()
	if err != nil {
		return "echo" // safe fallback that should never happen
	}
	switch base := filepath.Base(executable); base {
	case "cmd.test":
		return "example" // for `go test -v ./...`
	case "ld-musl-x86_64.so.1":
		return filepath.Base(os.Args[0]) // alpine container workaround (gcompat)
	default:
		return base
	}
}

// Map maps values to uids to simplify testing.
//
//	Map(
//	    "go.mod", "file://path/to/go.mod",
//	    "go.sum", "file://path/to/go.sum",
//	)
func Map(uids ...string) func(s string) (*url.URL, error) {
	return func(s string) (*url.URL, error) {
		for i := 0; i < len(uids); i += 2 {
			if uids[i] == s {
				return url.Parse(uids[i+1])
			}
		}
		return &url.URL{}, nil
	}
}

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.