xplat

Documentation

Overview

Helper methods for supporting cross-platform shells.

This takes into account both the operating system and the shell environment that the process is running within. The following environments are supported: * Linux * MacOS * Windows with WSL/PowerShell/CMD/Git Bash (mingw)

Index

• func DetectShell() string
• func EnsureInPath(value string)
• func FileExt() string
• func GetMSystem() string
• func InPath(value string) bool
• func PrependPath(value string)

Functions

func DetectShell

func DetectShell() string

DetectShell uses environment variables to determine the containing shell environment.

Values: unknown, posix, mingw, powershell, cmd, $SHELL (e.g. sh, bash)

This is not guaranteed to always work depending on customizations to the default Windows environment variables. It uses the following heuristics: * MSYSTEM is set * SHELL is set * PSModulePath containing user's home directory

func EnsureInPath

func EnsureInPath(value string)

EnsureInPath adds the specified path to the beginning of the PATH environment variable when it is not already in PATH. Detects if this is an Azure CI build and exports the updated PATH.

func FileExt

func FileExt() string

FileExt returns the default file extension based on the operating system.

func GetMSystem

func GetMSystem() string

GetMSystem returns current the MSys2 subsystem.

Allowed values are: (empty), mingw32, mingw64, msys2.

func InPath

func InPath(value string) bool

InPath determines if the path is in the PATH environment variable.

func PrependPath

func PrependPath(value string)

PrependPath adds the specified path to the beginning of the PATH environment variable. Detects if this is an Azure CI build and exports the updated PATH.