build

Documentation

Overview

Package build provides a spell incantation for the "build" command of the Go toolchain.

Index

• Constants
• type Option
  • func WithBinaryArtifactName(name string) Option
  • func WithCrossCompileTargetPlatforms(platforms ...string) Option
  • func WithFlags(flags ...string) Option
  • func WithGoOptions(goOpts ...spellGo.Option) Option
  • func WithOutputDir(dir string) Option
• type Options
  • func NewOptions(opts ...Option) *Options
• type Spell
  • func New(wand wand.Wand, ac app.Config, opts ...Option) *Spell
  • func (s *Spell) Env() map[string]string
  • func (s *Spell) Formula() []string
  • func (s *Spell) Kind() spell.Kind
  • func (s *Spell) Options() interface{}

Constants

const (
	// DefaultDistOutputDirName is the default directory name for production and distribution builds.
	DefaultDistOutputDirName = "dist"
)

Types

type Option

type Option func(*Options)

Option is a spell incantation option for the Go toolchain "build" command.

func WithBinaryArtifactName

func WithBinaryArtifactName(name string) Option

WithBinaryArtifactName sets the name for the binary build artifact.

func WithCrossCompileTargetPlatforms

func WithCrossCompileTargetPlatforms(platforms ...string) Option

WithCrossCompileTargetPlatforms sets the names of cross-compile platform targets.

func WithFlags

func WithFlags(flags ...string) Option

WithFlags sets additional flags to pass to the Go `build` command along with the base Go flags.

func WithGoOptions

func WithGoOptions(goOpts ...spellGo.Option) Option

WithGoOptions sets shared Go toolchain commands options.

func WithOutputDir

func WithOutputDir(dir string) Option

WithOutputDir sets the output directory, relative to the project root, for compilation artifacts.

type Options

type Options struct {
	*spellGo.Options

	// BinaryArtifactName is the name for the binary build artifact.
	BinaryArtifactName string

	// CrossCompileTargetPlatforms are the names of cross-compile platform targets.
	//
	// See `go tool dist list` and the `go` command documentations for more details:
	// - https://github.com/golang/go/blob/master/src/cmd/dist/build.go
	CrossCompileTargetPlatforms []string

	// Flags are additional flags to pass to the Go `build` command along with the base Go flags.
	//
	// See `go help build` and the Go command documentation for more details:
	// - https://golang.org/cmd/go/#hdr-Compile_packages_and_dependencies
	Flags []string

	// OutputDir is the output directory, relative to the project root, for compilation artifacts.
	OutputDir string
	// contains filtered or unexported fields
}

Options are spell incantation options for the Go toolchain "build" command.

func NewOptions

func NewOptions(opts ...Option) *Options

NewOptions creates new spell incantation options for the Go toolchain "build" command.

type Spell

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

Spell is a spell incantation for the "build" command of the Go toolchain.

func New

func New(wand wand.Wand, ac app.Config, opts ...Option) *Spell

New creates a new spell incantation for the "build" command of the Go toolchain.

func (*Spell) Env

func (s *Spell) Env() map[string]string

Env returns spell incantation specific environment variables.

func (*Spell) Formula

func (s *Spell) Formula() []string

Formula returns the spell incantation formula. Note that configured flags are applied after the "GOFLAGS" environment variable and could overwrite already defined flags.

See `go help environment`, `go help env` and the `go` command documentations for more details:

• https://golang.org/cmd/go/#hdr-Environment_variables

func (*Spell) Kind

func (s *Spell) Kind() spell.Kind

Kind returns the spell incantation kind.

func (*Spell) Options

func (s *Spell) Options() interface{}

Options returns the spell incantation options.