npmi

Documentation

Index

• Variables
• func New(options *Options, log hclog.Logger) (*main, error)
• func NewConfigBuilder() *configBuilder
• func NewWithConfig(options *Options, config *Config, log hclog.Logger) (*main, error)
• type Config
• type LocalCacheOptions
• type LogLevel
  • func LogLevelFromString(levelStr string) LogLevel
  • func (l LogLevel) String() string
• type MinioCacheOptions
• type NpmInstaller
  • func NewNpmInstaller(config *Config, log hclog.Logger) *NpmInstaller
  • func (i *NpmInstaller) Run() (stdout string, stderr string, err error)
  • func (i *NpmInstaller) RunPrecacheCommand(commandLine string) (stdout string, stderr string, err error)
• type Options

Variables

var (
	Version    = "dev"
	Commit     = "none"
	CommitDate = "unknown"
)

Functions

func New

func New(options *Options, log hclog.Logger) (*main, error)

New builds a configuration for the current runtime and returns a pre-configured NPMI main

func NewConfigBuilder

func NewConfigBuilder() *configBuilder

func NewWithConfig

func NewWithConfig(options *Options, config *Config, log hclog.Logger) (*main, error)

NewWithConfig creates a NPMI main using the supplied options and config

Types

type Config

type Config struct {
	Platform string
	// contains filtered or unexported fields
}

type LocalCacheOptions

type LocalCacheOptions struct {
	Dir string `env:"NPMI_LOCAL_DIR"`
}

LocalCacheOptions constains configuration for Local Cache

type LogLevel

type LogLevel int32

const (
	NoLevel LogLevel = iota
	Info
	Debug
	Trace
)

func LogLevelFromString

func LogLevelFromString(levelStr string) LogLevel

func (LogLevel) String

func (l LogLevel) String() string

type MinioCacheOptions

type MinioCacheOptions struct {
	Endpoint        string `env:"NPMI_MINIO_ENDPOINT"`
	AccessKeyID     string `env:"NPMI_MINIO_ACCESS_KEY_ID"`
	SecretAccessKey string `env:"NPMI_MINIO_SECRET_ACCESS_KEY"`
	Bucket          string `env:"NPMI_MINIO_BUCKET"`
	UseTLS          bool   `env:"NPMI_MINIO_TLS"`
	InsecureTLS     bool   `env:"NPMI_MINIO_TLS_INSECURE"`
}

MinioCacheOptions contains configuration for Minio Cache

type NpmInstaller

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

func NewNpmInstaller

func NewNpmInstaller(config *Config, log hclog.Logger) *NpmInstaller

func (*NpmInstaller) Run

func (i *NpmInstaller) Run() (stdout string, stderr string, err error)

Run installs packages from NPM

func (*NpmInstaller) RunPrecacheCommand

func (i *NpmInstaller) RunPrecacheCommand(commandLine string) (stdout string, stderr string, err error)

RunPrecacheCommand runs a given command before inserting freshly installed NPM deps into cache

type Options

type Options struct {
	Verbose            bool `env:"NPMI_VERBOSE"`
	Force              bool `env:"NPMI_FORCE"`
	LocalCache         *LocalCacheOptions
	LogLevel           LogLevel `env:"NPMI_LOGLEVEL"`
	MinioCache         *MinioCacheOptions
	PrecacheCommand    string `env:"NPMI_PRECACHE"`
	TempDir            string `env:"NPMI_TEMP_DIR"`
	UseLocalCache      bool   `env:"NPMI_LOCAL"`
	UseMinioCache      bool   `env:"NPMI_MINIO"`
	Json               bool   `env:"NPMI_JSON"`
	TarDoubleDotPaths  bool   `env:"NPMI_TAR_DOUBLE_DOT_PATHS"`
	TarAbsolutePaths   bool   `env:"NPMI_TAR_ABSOLUTE_PATHS"`
	TarLinksOutsideCwd bool   `env:"NPMI_TAR_LINKS_OUTSIDE_CWD"`
}

Options describes the runtime configuration