localio

package

v2.1.3 Latest Latest Go to latest Published: Apr 12, 2023 License: GPL-3.0 Imports: 27 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/mr-pmillz/pimp-my-shell

Links

Open Source Insights

Documentation ¶

Index ¶

func AptInstall(packages *InstalledPackages, aptName ...string) error
func BrewInstallCaskProgram(brewName, brewFullName string, packages *InstalledPackages) error
func BrewInstallProgram(brewName, binaryName string, packages *InstalledPackages) error
func BrewTap(brewTap string, packages *InstalledPackages) error
func CmdExec(args ...string) (string, error)
func CommandExists(cmd string) (string, bool)
func Contains(s []string, str string) bool
func CopyStringToFile(data, dest string) error
func CorrectOS(osType string) bool
func DownloadAndInstallLatestVersionOfGolang(homeDir string, packages *InstalledPackages) error
func DownloadFile(dest, url string) error
func EmbedFileCopy(dst string, src fs.File) error
func EmbedFileStringAppendToDest(data []byte, dest string) error
func EmbedFileStringPrependToDest(data []byte, dest string) error
func ExecCMD(command string) (string, error)
func Exists(path string) (bool, error)
func GetCPUType() string
func GitClone(url, directory string) error
func Infof(format string, args ...interface{})
func InstallPipPackages(installedPackages *PipInstalled, pkgName ...string) error
func IsRoot() bool
func LogError(err error) error
func LogWarningf(format string, args ...interface{})
func PipInstall(packagesToInstall []string) error
func ResolveAbsPath(path string) (string, error)
func RunCommandPipeOutput(command string) error
func RunCommands(cmds []string) error
func SetVariableValue(varName, val, osType, configPath string) error
func StartTmuxSession() error
func TimeTrack(start time.Time, name string)
func VersionGreaterOrEqual(versionString string, minVersionString string) bool
type AptInstalled
- func NewAptInstalled() (*AptInstalled, error)
type BrewInstalled
- func NewBrewInstalled() (*BrewInstalled, error)
type Directories
- func NewDirectories() (*Directories, error)
type InstalledPackages
type PipInstalled
- func NewPipInstalled() (*PipInstalled, error)
type PythonVersions
- func GetPythonAndPipVersion() (*PythonVersions, error)
type Record
- func NewRecord(filename string) *Record
- func (r *Record) PrependStringToFile(content string) error
type Version

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AptInstall ¶

func AptInstall(packages *InstalledPackages, aptName ...string) error

AptInstall ...

func BrewInstallCaskProgram ¶

func BrewInstallCaskProgram(brewName, brewFullName string, packages *InstalledPackages) error

BrewInstallCaskProgram ...

func BrewInstallProgram ¶

func BrewInstallProgram(brewName, binaryName string, packages *InstalledPackages) error

BrewInstallProgram ...

func BrewTap ¶

func BrewTap(brewTap string, packages *InstalledPackages) error

BrewTap ...

func CmdExec ¶

func CmdExec(args ...string) (string, error)

CmdExec Execute a command and return stdout

func CommandExists ¶

func CommandExists(cmd string) (string, bool)

CommandExists ...

func Contains ¶

func Contains(s []string, str string) bool

Contains checks if a string is present in a slice

func CopyStringToFile ¶

func CopyStringToFile(data, dest string) error

CopyStringToFile ...

func CorrectOS ¶

func CorrectOS(osType string) bool

CorrectOS ... Useful for go tests

func DownloadAndInstallLatestVersionOfGolang ¶

func DownloadAndInstallLatestVersionOfGolang(homeDir string, packages *InstalledPackages) error

DownloadAndInstallLatestVersionOfGolang Only for linux x86_64. Mac uses homebrew

func DownloadFile ¶

func DownloadFile(dest, url string) error

DownloadFile ...

func EmbedFileCopy ¶

func EmbedFileCopy(dst string, src fs.File) error

EmbedFileCopy ...

func EmbedFileStringAppendToDest ¶

func EmbedFileStringAppendToDest(data []byte, dest string) error

EmbedFileStringAppendToDest takes a slice of bytes and writes it as a string to dest file path

func EmbedFileStringPrependToDest ¶

func EmbedFileStringPrependToDest(data []byte, dest string) error

EmbedFileStringPrependToDest takes a slice of bytes and prepend writes it as a string to the beginning of the dest file path

func ExecCMD ¶

func ExecCMD(command string) (string, error)

ExecCMD Execute a command

func Exists ¶

func Exists(path string) (bool, error)

Exists returns whether the given file or directory exists

func GetCPUType ¶

func GetCPUType() string

GetCPUType Returns the CPU type for the current runtime environment

func GitClone ¶

func GitClone(url, directory string) error

GitClone clones a public git repo url to directory

func Infof ¶ added in v2.1.3

func Infof(format string, args ...interface{})

Infof ...

func InstallPipPackages ¶ added in v2.1.3

func InstallPipPackages(installedPackages *PipInstalled, pkgName ...string) error

InstallPipPackages ...

func IsRoot ¶ added in v2.1.3

func IsRoot() bool

IsRoot checks if the current user is root or not

func LogError ¶ added in v2.1.3

func LogError(err error) error

LogError ...

func LogWarningf ¶ added in v2.1.3

func LogWarningf(format string, args ...interface{})

LogWarningf logs a warning to stdout

func PipInstall ¶ added in v2.1.3

func PipInstall(packagesToInstall []string) error

PipInstall ...

func ResolveAbsPath ¶

func ResolveAbsPath(path string) (string, error)

ResolveAbsPath ...

func RunCommandPipeOutput ¶

func RunCommandPipeOutput(command string) error

RunCommandPipeOutput runs a bash command and pipes the output to stdout and stderr in realtime

func RunCommands ¶

func RunCommands(cmds []string) error

RunCommands ...

func SetVariableValue ¶

func SetVariableValue(varName, val, osType, configPath string) error

SetVariableValue ...

func StartTmuxSession ¶

func StartTmuxSession() error

StartTmuxSession ...

func TimeTrack ¶ added in v2.1.3

func TimeTrack(start time.Time, name string)

TimeTrack ...

func VersionGreaterOrEqual ¶ added in v2.1.3

func VersionGreaterOrEqual(versionString string, minVersionString string) bool

VersionGreaterOrEqual ...

Types ¶

type AptInstalled ¶

type AptInstalled struct {
	Name []string
}

AptInstalled ...

func NewAptInstalled ¶

func NewAptInstalled() (*AptInstalled, error)

NewAptInstalled ...

type BrewInstalled ¶

type BrewInstalled struct {
	Names         []string
	CaskFullNames []string
	Taps          []string
}

BrewInstalled ...

func NewBrewInstalled ¶

func NewBrewInstalled() (*BrewInstalled, error)

NewBrewInstalled ...

type Directories ¶

type Directories struct {
	HomeDir string
}

Directories ...

func NewDirectories ¶

func NewDirectories() (*Directories, error)

NewDirectories ...

type InstalledPackages ¶

type InstalledPackages struct {
	AptInstalledPackages  *AptInstalled
	BrewInstalledPackages *BrewInstalled
}

InstalledPackages ...

type PipInstalled ¶ added in v2.1.3

type PipInstalled struct {
	Name     []string
	Versions PythonVersions
}

func NewPipInstalled ¶ added in v2.1.3

func NewPipInstalled() (*PipInstalled, error)

NewPipInstalled returns a slice of all the installed python3 pip packages

type PythonVersions ¶ added in v2.1.3

type PythonVersions struct {
	Python3Version string
	PipVersion     string
}

func GetPythonAndPipVersion ¶ added in v2.1.3

func GetPythonAndPipVersion() (*PythonVersions, error)

GetPythonAndPipVersion ...

type Record ¶

type Record struct {
	Filename string
	Contents []string
}

Record is a type for prepending string text to a file

func NewRecord ¶

func NewRecord(filename string) *Record

NewRecord returns the Record type

func (*Record) PrependStringToFile ¶

func (r *Record) PrependStringToFile(content string) error

PrependStringToFile prepends a given string to an existing file while preserving the original formatting

type Version ¶ added in v2.1.3

type Version struct {
	Major int
	Minor int
	Patch int
}

Source Files ¶

View all Source files

localio.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL