shellutil

Documentation

Index

• Constants
• func AddTokenSwapEntry(entry *TokenSwapEntry) error
• func DefaultTermSize() waveobj.TermSize
• func DetectLocalShellPath() string
• func EncodeEnvVarsForShell(shellType string, env map[string]string) (string, error)
• func GetEnvStrKey(envStr string) string
• func GetLocalBashRcFileOverride() string
• func GetLocalWaveFishFilePath() string
• func GetLocalWavePowershellEnv() string
• func GetLocalWshBinaryPath(version string, goos string, goarch string) (string, error)
• func GetLocalZshZDotDir() string
• func GetMacUserShell() string
• func GetShellTypeFromShellPath(shellPath string) string
• func HardQuote(s string) string
• func HardQuoteFish(s string) string
• func HardQuotePowerShell(s string) string
• func InitCustomShellStartupFiles() error
• func InitRcFiles(waveHome string, absWshBinDir string) error
• func IsValidEnvVarName(name string) bool
• func SoftQuote(s string) string
• func UpdateCmdEnv(cmd *exec.Cmd, envVars map[string]string)
• func WaveshellLocalEnvVars(termType string) map[string]string
• type TokenSwapEntry
  • func GetAndRemoveTokenSwapEntry(token string) *TokenSwapEntry
  • func (t *TokenSwapEntry) PackForClient() (string, error)
• type UnpackedTokenType
  • func UnpackSwapToken(token string) (*UnpackedTokenType, error)
  • func (t *UnpackedTokenType) Pack() (string, error)

Constants

const (
	ShellType_bash    = "bash"
	ShellType_zsh     = "zsh"
	ShellType_fish    = "fish"
	ShellType_pwsh    = "pwsh"
	ShellType_unknown = "unknown"
)

const (
	// there must be no spaces in these integration dir paths
	ZshIntegrationDir  = "shell/zsh"
	BashIntegrationDir = "shell/bash"
	PwshIntegrationDir = "shell/pwsh"
	FishIntegrationDir = "shell/fish"
	WaveHomeBinDir     = "bin"

	ZshStartup_Zprofile = `
# Source the original zprofile
[ -f ~/.zprofile ] && source ~/.zprofile
`

	ZshStartup_Zshrc = `` /* 556-byte string literal not displayed */

	ZshStartup_Zlogin = `` /* 181-byte string literal not displayed */

	ZshStartup_Zshenv = `` /* 372-byte string literal not displayed */

	BashStartup_Bashrc = `` /* 792-byte string literal not displayed */

	FishStartup_Wavefish = `` /* 344-byte string literal not displayed */

	PwshStartup_wavepwsh = `` /* 523-byte string literal not displayed */

)

const DefaultShellPath = "/bin/bash"

const DefaultTermCols = 80

const DefaultTermRows = 24

const DefaultTermType = "xterm-256color"

const (
	MaxQuoteSize = 10000000 // 10MB
)

Functions

func AddTokenSwapEntry

func AddTokenSwapEntry(entry *TokenSwapEntry) error

func DefaultTermSize

func DefaultTermSize() waveobj.TermSize

func DetectLocalShellPath

func DetectLocalShellPath() string

func EncodeEnvVarsForShell

func EncodeEnvVarsForShell(shellType string, env map[string]string) (string, error)

func GetEnvStrKey

func GetEnvStrKey(envStr string) string

func GetLocalBashRcFileOverride

func GetLocalBashRcFileOverride() string

func GetLocalWaveFishFilePath

func GetLocalWaveFishFilePath() string

func GetLocalWavePowershellEnv

func GetLocalWavePowershellEnv() string

func GetLocalWshBinaryPath

func GetLocalWshBinaryPath(version string, goos string, goarch string) (string, error)

func GetLocalZshZDotDir

func GetLocalZshZDotDir() string

func GetMacUserShell

func GetMacUserShell() string

func GetShellTypeFromShellPath

func GetShellTypeFromShellPath(shellPath string) string

func HardQuote

func HardQuote(s string) string

func HardQuoteFish

func HardQuoteFish(s string) string

does not encode newlines or backticks

func HardQuotePowerShell

func HardQuotePowerShell(s string) string

func InitCustomShellStartupFiles

func InitCustomShellStartupFiles() error

in a Once block so it can be called multiple times we run it at startup, but also before launching local shells so we know everything is initialized before starting the shell

func InitRcFiles

func InitRcFiles(waveHome string, absWshBinDir string) error

absWshBinDir must be an absolute, expanded path (no ~ or $HOME, etc.) it will be hard-quoted appropriately for the shell

func IsValidEnvVarName

func IsValidEnvVarName(name string) bool

func SoftQuote

func SoftQuote(s string) string

func UpdateCmdEnv

func UpdateCmdEnv(cmd *exec.Cmd, envVars map[string]string)

func WaveshellLocalEnvVars

func WaveshellLocalEnvVars(termType string) map[string]string

Types

type TokenSwapEntry

type TokenSwapEntry struct {
	Token      string             `json:"token"`
	SockName   string             `json:"sockname,omitempty"`
	RpcContext *wshrpc.RpcContext `json:"rpccontext,omitempty"`
	Env        map[string]string  `json:"env,omitempty"`
	ScriptText string             `json:"scripttext,omitempty"`
	Exp        time.Time          `json:"-"`
}

func GetAndRemoveTokenSwapEntry

func GetAndRemoveTokenSwapEntry(token string) *TokenSwapEntry

func (*TokenSwapEntry) PackForClient

func (t *TokenSwapEntry) PackForClient() (string, error)

type UnpackedTokenType

type UnpackedTokenType struct {
	Token      string             `json:"token"` // uuid
	SockName   string             `json:"sockname,omitempty"`
	RpcContext *wshrpc.RpcContext `json:"rpccontext,omitempty"`
}

func UnpackSwapToken

func UnpackSwapToken(token string) (*UnpackedTokenType, error)

func (*UnpackedTokenType) Pack

func (t *UnpackedTokenType) Pack() (string, error)