Source File
	env.go

Belonging Package
	github.com/carapace-sh/carapace/internal/env

package env

import (
	"encoding/json"
	"errors"
	"os"
	"strings"

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

const (
	CARAPACE_COMPLINE      = "CARAPACE_COMPLINE"      // TODO
	CARAPACE_COVERDIR      = "CARAPACE_COVERDIR"      // coverage directory for sandbox tests
	CARAPACE_EXPERIMENTAL  = "CARAPACE_EXPERIMENTAL"  // enable experimental features
	CARAPACE_HIDDEN        = "CARAPACE_HIDDEN"        // show hidden commands/flags
	CARAPACE_LENIENT       = "CARAPACE_LENIENT"       // allow unknown flags
	CARAPACE_LOG           = "CARAPACE_LOG"           // enable logging
	CARAPACE_MATCH         = "CARAPACE_MATCH"         // match case insensitive
	CARAPACE_NOSPACE       = "CARAPACE_NOSPACE"       // nospace suffixes
	CARAPACE_SANDBOX       = "CARAPACE_SANDBOX"       // mock context for sandbox tests
	CARAPACE_TOOLTIP       = "CARAPACE_TOOLTIP"       // enable tooltip style
	CARAPACE_UNFILTERED    = "CARAPACE_UNFILTERED"    // skip the final filtering step
	CARAPACE_ZSH_HASH_DIRS = "CARAPACE_ZSH_HASH_DIRS" // zsh hash directories
	CLICOLOR               = "CLICOLOR"               // disable color
	NO_COLOR               = "NO_COLOR"               // disable color
)

func ColorDisabled() bool {
	return getBool(NO_COLOR) || os.Getenv(CLICOLOR) == "0"
}

func Experimental() bool {
	return getBool(CARAPACE_EXPERIMENTAL)
}

func Lenient() bool {
	return getBool(CARAPACE_LENIENT)
}

func Hashdirs() string {
	return os.Getenv(CARAPACE_ZSH_HASH_DIRS)
}

func Sandbox() (m *common.Mock, err error) {
	sandbox := os.Getenv(CARAPACE_SANDBOX)
	if sandbox == "" || !isGoRun() {
		return nil, errors.New("no sandbox")
	}

	err = json.Unmarshal([]byte(sandbox), &m)
	return
}

func Log() bool {
	return getBool(CARAPACE_LOG)
}

func Hidden() bool {
	return getBool(CARAPACE_HIDDEN)
}

func CoverDir() string {
	return os.Getenv(CARAPACE_COVERDIR) // custom env for GOCOVERDIR so that it works together with `-coverprofile`
}

func isGoRun() bool { return strings.HasPrefix(os.Args[0], os.TempDir()+"/go-build") }

func Match() string { // see match.Match
	return os.Getenv(CARAPACE_MATCH)
}

func Nospace() string {
	return os.Getenv(CARAPACE_NOSPACE)
}

func Tooltip() bool {
	return getBool(CARAPACE_TOOLTIP)
}

func Compline() string {
	return os.Getenv(CARAPACE_COMPLINE)
}

func Unfiltered() bool {
	return getBool(CARAPACE_UNFILTERED)
}

func getBool(s string) bool {
	switch os.Getenv(s) {
	case "true", "1":
		return true
	default:
		return false
	}
}

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.