npm

Documentation

Overview

Package npm builds and publishes platform-specific npm packages wrapping Go binaries. It delegates publishing to the npm CLI via os/exec.

Index

• func Publish(ctx context.Context, cfg *Config) error
• type Artifact
• type Config

Functions

func Publish

func Publish(ctx context.Context, cfg *Config) error

Publish builds platform npm packages and a root coordinator package, then publishes all of them via `npm publish`.

Types

type Artifact

type Artifact struct {
	GOOS          string
	GOARCH        string
	Path          string
	NpmOS         string // e.g. "linux"
	NpmCPU        string // e.g. "x64"
	PackageSuffix string // e.g. "linux-x64"
}

Artifact is a resolved binary file path for one os/arch pair.

type Config

type Config struct {
	Name       string
	Version    string
	Summary    string
	License    string
	Artifacts  []Artifact
	DryRun     bool
	Org        string
	Tag        string
	Provenance bool
	ReadmePath string
	Repository string
	Stdout     io.Writer
}

Config parameterizes an npm publish run.