npm

Documentation

Overview

Package npm handles the creation of artefacts required for publishing the oto generate package

Index

• Constants
• func GeneratePackageInfo(npmPackage Package) ([]byte, error)
• func Publish(path string, options PublishOptions) error
• type Package
• type PublishOptions

Constants

const (
	// NPMPackageMain is an arbitrary output name for client
	NPMPackageMain = "client.js"
	// NPMRegistry is the default registry url for most JS projects.
	NPMRegistry = "//registry.npmjs.org/"
	// GithubRegistry is the NPM registry url Github uses
	GHRegistry = "//npm.pkg.github.com/"
)

Functions

func GeneratePackageInfo

func GeneratePackageInfo(npmPackage Package) ([]byte, error)

GeneratePackageInfo validates that all Package fields are present and returns the marshalled bytes of the package json

func Publish

func Publish(path string, options PublishOptions) error

Types

type Package

type Package struct {
	Name    string `json:"name"`
	Version string `json:"version"`
	Main    string `json:"main"`
}

Package contains all the fields required for creating an npm package

type PublishOptions

type PublishOptions struct {
	Token       string
	DryRun      bool
	Private     bool
	RegistryURL string
	// Owner is used only for Github
	Owner string
}