utils

Documentation

Overview

utility package for nvm/utils

Useful only for nvm (not the nvm-shim)

Index

• Constants
• Variables
• func CheckSha(node_body []byte, sha string) (err error)
• func DownloadNode(url string) (b []byte, err error)
• func FetchSha(url, filename string) (sha string, err error)
• func FlushTabs()
• func GetDownloadUrl(v common.Version, d exclusive_node_file) string
• func GetInstalledVersions() (versions []common.Version, err error)
• func GetLTS() (out common.Version, err error)
• func GetLatestFromVersion(version common.Version) (out common.Version, err error)
• func GetOsAndArch() (remote_os, remote_arch string)
• func PrintTabs(str string)
• func ProgressBar(b *[]byte, size int)
• func ReadNvmrc() (ver common.Version, err error)
• func Rename(source, target string) (err error)
• func SaveToFile(body []byte, filename string) error
• func UnGzip(source, target string) (string, error)
• func Untar(tarball, target string) error
• func ValidateUrl(url_str string) (string, error)
• type NodeDownload

Constants

const INDEX = "index.tab"

const SHASUMS = "SHASUMS256.txt"

remote filename which indicates sha's for each downloadable file

Variables

var BASE_URL = os.Getenv("NVM_NODEJS_ORG_MIRROR")

NVM_NODEJS_ORG_MIRROR - base url for downloading node; default: "https://nodejs.org/dist"

var CI = os.Getenv("CI")

CI usually sets CI=true? disable progress bars?

var ErrInvalidSha = errors.New("invalid sha")

error when verified sha did not match calculated file

var ErrNoNvmRc = errors.New("no .nvmrc found")

var ErrShaNotFound = errors.New("sha not found")

error when filename/sha not found

var Writer = tabwriter.NewWriter(os.Stderr, 1, 1, 4, ' ', 0)

customized writer to print help logs nicely

Functions

func CheckSha

func CheckSha(node_body []byte, sha string) (err error)

gets file sha and checks against a verified sha returns ErrInvalidSha

func DownloadNode

func DownloadNode(url string) (b []byte, err error)

func FetchSha

func FetchSha(url, filename string) (sha string, err error)

downloads shasums and gets verified sha for a filename

func FlushTabs

func FlushTabs()

flush tabbed output to stdout

func GetDownloadUrl

func GetDownloadUrl(v common.Version, d exclusive_node_file) string

determine where to download node install files

`v` a verified/parsed version string

`d` is a [commands.NodeDownload]

used by [commands.Install]

func GetInstalledVersions

func GetInstalledVersions() (versions []common.Version, err error)

func GetLTS

func GetLTS() (out common.Version, err error)

version is non-specific and we need to query the releases to find the latest version which fits the range

func GetLatestFromVersion

func GetLatestFromVersion(version common.Version) (out common.Version, err error)

version is non-specific and we need to query the releases to find the latest version which fits the range

func GetOsAndArch

func GetOsAndArch() (remote_os, remote_arch string)

TODO: this can be cached, or run once used to determine download url in [commands.GetDownloadUrl]

func PrintTabs

func PrintTabs(str string)

aligns tabs with tabwriter

func ProgressBar

func ProgressBar(b *[]byte, size int)

show a progress bar in stdout; needs bytes to be written using something like io.Reader.Read

func ReadNvmrc

func ReadNvmrc() (ver common.Version, err error)

get version in .nvmrc

func Rename

func Rename(source, target string) (err error)

rename or move file; moving may be required if using a docker container with volumes

func SaveToFile

func SaveToFile(body []byte, filename string) error

save `body` bytes to `filename` TODO: this may be deprecated if we transfer http response directly to file, sha, and progresssbar

func UnGzip

func UnGzip(source, target string) (string, error)

func Untar

func Untar(tarball, target string) error

TODO: gzipping can be done with the tarring: https://cs.opensource.google/go/x/build/+/8c11e572:internal/untar/untar.go reverse the effects of tarring

func ValidateUrl

func ValidateUrl(url_str string) (string, error)

check that a url string is valid

Types

type NodeDownload

type NodeDownload int

Enum for downloading either node or shasums

const (
	DOWNLOAD_NODE   NodeDownload = iota // downloads node
	DOWNLOAD_SHASUM                     // downloads SHASUMS
)