common

Documentation

Overview

nvm-common has common methods for use in both nvm and nvm-shim

Index

• Constants
• Variables
• func CreateSymlinks(version Version) (err error)
• func Debugger()
• func GetConfig() (cfg config, err error)
• func GetNVMDir(path ...string) (string, error)
• func GetNodeBin(version Version, bin string) (string, error)
• func SetConfig(cfg config) error
• type Version
  • func GetVersion(v string) (Version, error)
  • func (v Version) IsSpecific() bool
  • func (v Version) Major() int
  • func (v Version) Minor() int
  • func (v Version) Patch() int
• type VersionError
  • func (ve VersionError) Error() string

Constants

const CONFIG_NAME = "config.json"

config filename

const CONFIG_PERM = 0644

config file permissions

const NVM_DIR string = ".nevermind"

user-relative path to app directory

const NVM_SHIM = "nvm-shim"

basename of binary in NVM_DIR

Variables

var DEBUG = os.Getenv("DEBUG")

Enables debugger with DEBUG=1

If you want node logs too, set DEBUG=*

Functions

func CreateSymlinks

func CreateSymlinks(version Version) (err error)

create symlinks of bins

func Debugger

func Debugger()

sets up logger if DEBUG=1

logging is disabled by default, but you could also pass DEBUG=0 if that's something you think you need to do

func GetConfig

func GetConfig() (cfg config, err error)

func GetNVMDir

func GetNVMDir(path ...string) (string, error)

get a path relative to common.NVM_DIR returns directory string, and error

func GetNodeBin

func GetNodeBin(version Version, bin string) (string, error)

bin should likely be "node", "npm", "npx"; or any other node bin installed globally (e.g. yarn, typescript) returns directory string, and error

func SetConfig

func SetConfig(cfg config) error

Types

type Version

type Version string

a semver string without the leading "v" returned by common.GetVersion

func GetVersion

func GetVersion(v string) (Version, error)

case-insensitive, leading v, major.minor.patch

func (Version) IsSpecific

func (v Version) IsSpecific() bool

has all major.minor.patch

func (Version) Major

func (v Version) Major() int

func (Version) Minor

func (v Version) Minor() int

func (Version) Patch

func (v Version) Patch() int

type VersionError

type VersionError struct {
	// contains filtered or unexported fields
}

func (VersionError) Error

func (ve VersionError) Error() string