internal

Documentation

Index

• Constants
• Variables
• func Build(repo *Repository, opts BuildOptions) error
• func CheckEngines(repo *Repository) error
• func Clean(repo *Repository) error
• func DumpEnvironment(env *Environment)
• func EnsureTmp(repo *Repository) error
• func InstallDependencies(repo *Repository, opts InstallDependenciesOptions) error
• func Publish(repo *Repository, pkg *Package) error
• func ReadJSON(filename string, data interface{}) (err error)
• func Run(repo *Repository, opts RunOptions) error
• func TempDir(repo *Repository, prefix string) (string, error)
• func TempFile(repo *Repository, prefix string) (*os.File, error)
• func Warnf(format string, args ...interface{})
• func WriteJSON(filename string, data interface{}) (err error)
• func WritePackageJSON(metadata PackageMetadata, dir string) error
• type BuildOptions
• type Config
• type Dependency
• type Environment
  • func AnalyzeEnvironment(repo *Repository) (*Environment, error)
• type EnvironmentEngine
• type Executable
• type InstallDependenciesOptions
• type PackResult
  • func Pack(repo *Repository, pkg *Package) (PackResult, error)
• type Package
• type PackageConfig
• type PackageMetadata
  • func ReadPackageJSON(dir string) (*PackageMetadata, error)
• type PublishConfig
• type Repository
  • func LoadRepository(searchDir string) (*Repository, error)
• type RunOptions

Constants

const DefaultRegistry = "https://registry.npmjs.org/"

Variables

var ErrNoConfig = fmt.Errorf("cannot find %s config file", configName)

Functions

func Build

func Build(repo *Repository, opts BuildOptions) error

func CheckEngines

func CheckEngines(repo *Repository) error

func Clean

func Clean(repo *Repository) error

func DumpEnvironment

func DumpEnvironment(env *Environment)

func EnsureTmp

func EnsureTmp(repo *Repository) error

func InstallDependencies

func InstallDependencies(repo *Repository, opts InstallDependenciesOptions) error

func Publish

func Publish(repo *Repository, pkg *Package) error

func ReadJSON

func ReadJSON(filename string, data interface{}) (err error)

func Run

func Run(repo *Repository, opts RunOptions) error

Status code may be returend within an exec.ExitError return value.

func TempDir

func TempDir(repo *Repository, prefix string) (string, error)

func TempFile

func TempFile(repo *Repository, prefix string) (*os.File, error)

func Warnf

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

func WriteJSON

func WriteJSON(filename string, data interface{}) (err error)

func WritePackageJSON

func WritePackageJSON(metadata PackageMetadata, dir string) error

Types

type BuildOptions

type BuildOptions struct {
	Package *Package
	Version string
	Types   bool
	Watch   bool
}

type Config

type Config struct {
	Engines      map[string]string
	Repository   string
	Registry     string
	Packages     map[string]PackageConfig
	Dependencies map[string]string
}

type Dependency

type Dependency struct {
	Name    string
	Version string
}

type Environment

type Environment struct {
	Engines []EnvironmentEngine
	OK      bool
}

func AnalyzeEnvironment

func AnalyzeEnvironment(repo *Repository) (*Environment, error)

type EnvironmentEngine

type EnvironmentEngine struct {
	Name            string
	ActualVersion   string
	ExpectedVersion string
	OK              bool
}

type Executable

type Executable struct {
	Name       string
	Entrypoint string
}

type InstallDependenciesOptions

type InstallDependenciesOptions struct {
	Frozen bool
}

type PackResult

type PackResult struct {
	PackagePath string
}

func Pack

func Pack(repo *Repository, pkg *Package) (PackResult, error)

type Package

type Package struct {
	Name        string
	Public      bool
	Description string
	Index       string
	Executables map[string]*Executable
}

type PackageConfig

type PackageConfig struct {
	Public      bool
	Description string
	Index       string
	Executables map[string]string
}

type PackageMetadata

type PackageMetadata struct {
	Name          string            `json:"name,omitempty"`
	Description   string            `json:"description,omitempty"`
	Version       string            `json:"version,omitempty"`
	Private       bool              `json:"private"`
	Repository    string            `json:"repository,omitempty"`
	Main          string            `json:"main,omitempty"`
	Bin           map[string]string `json:"bin,omitempty"`
	Dependencies  map[string]string `json:"dependencies,omitempty"`
	Scripts       map[string]string `json:"scripts,omitempty"`
	PublishConfig *PublishConfig    `json:"publishConfig,omitempty"`
}

func ReadPackageJSON

func ReadPackageJSON(dir string) (*PackageMetadata, error)

type PublishConfig

type PublishConfig struct {
	Registry string `json:"registry"`
}

type Repository

type Repository struct {
	ConfigPath   string
	RootDir      string
	OutDir       string
	DistDir      string
	TmpDir       string
	Engines      map[string]string
	Packages     map[string]*Package
	Dependencies map[string]*Dependency
	Url          string
	Registry     string
}

func LoadRepository

func LoadRepository(searchDir string) (*Repository, error)

type RunOptions

type RunOptions struct {
	Watch      bool
	Entrypoint string
	Args       []string
	BuildOnly  bool
}