gotoolbox

README

gotoolbox

My personal set of tools for the "go tool" command.

(TODO)

Documentation

Index

• Variables
• func CacheDirPath() string
• func Download(url string) (io.ReadCloser, error)
• func Exec(binPath string) error
• func OpenFileInArchive(archiveFile *os.File, archiveFileSize int64, archiveFormat ArchiveFormat, ...) (io.ReadCloser, error)
• func SelectByLibc(glibc, other string) string
• type ArchiveFormat
• type Artifact
• type Checksum
• type ReadCloserWrapper
  • func (r *ReadCloserWrapper) Close() error
• type Tool
  • func (t *Tool) DownloadIfNeeded() (string, error)
  • func (t *Tool) Run()

Variables

var IsGlibcEnv = sync.OnceValue(
	func() bool {

		if out, err := os.ReadFile("/proc/self/maps"); err == nil {
			if muslRegex.Match(out) {
				return false
			}
		}

		if lddPath, err := exec.LookPath("ldd"); err == nil {
			if ldd, err := os.ReadFile(lddPath); err == nil {
				if muslRegex.Match(ldd) {
					return false
				} else if glibcRegex.Match(ldd) {
					return true
				}
			}

			if lddVersion, err := exec.Command(
				lddPath, "--version",
			).CombinedOutput(); err == nil {
				if muslRegex.Match(lddVersion) {
					return false
				} else if glibcRegex.Match(lddVersion) {
					return true
				}
			}
		}

		return false
	},
)

IsGlibcEnv returns true if the host platform is a GNU libc environment. Otherwise, e.g. on musl libc environments, returns false.

Functions

func CacheDirPath

func CacheDirPath() string

func Download

func Download(url string) (io.ReadCloser, error)

func Exec

func Exec(binPath string) error

func OpenFileInArchive

func OpenFileInArchive(
	archiveFile *os.File,
	archiveFileSize int64,
	archiveFormat ArchiveFormat,
	inArchiveFilePath string,
) (io.ReadCloser, error)

func SelectByLibc

func SelectByLibc(glibc, other string) string

SelectByLibc returns [glibc] if glibc was detected, otherwise returns [other] on e.g. musl libc environments. If glibc was not explicitly detected it will default to [other].

Types

type ArchiveFormat

type ArchiveFormat int

const (
	NotAnArchive ArchiveFormat = iota
	ZipArchive
	TarArchive
	TarGzipArchive
	TarBzip2Archive
)

type Artifact

type Artifact struct {
	CacheName         string
	DownloadURL       string
	Checksum          Checksum
	ArchiveFormat     ArchiveFormat
	InArchiveFilePath string
}

Artifact defines where and how to download the artifact for a tool.

type Checksum

type Checksum struct {
	Algorithm crypto.Hash
	Digest    string
}

Checksum defines how to verify the downloaded Artifact.

type ReadCloserWrapper

type ReadCloserWrapper struct {
	io.Reader
	Closer io.Closer
}

ReadCloserWrapper is an io.ReadCloser which wraps an io.Reader with an optionally definable io.Closer.

func (*ReadCloserWrapper) Close

func (r *ReadCloserWrapper) Close() error

type Tool

type Tool struct {
	Name     string
	Artifact Artifact
}

Tool defines a gotoolbox tool.

func (*Tool) DownloadIfNeeded

func (t *Tool) DownloadIfNeeded() (string, error)

TODO: Compare with dprint and goreleaser npm install.js scripts.

func (*Tool) Run

func (t *Tool) Run()