build.go

package commands

import (
	"fmt"
	"os"
	"path/filepath"
	"strings"

	"github.com/quikdev/go/context"
	"github.com/quikdev/go/util"

	goupx "github.com/alegrey91/go-upx"
	fs "github.com/coreybutler/go-fsutil"
	"github.com/dustin/go-humanize"
)

type Build struct {
	Bundle      []string `name:"bundle" short:"b" type:"string" help:"Bundle the application into a tarball/zipball" enum:"zip,tar"`
	OS          []string `name:"os" type:"string" help:"The operating system(s) to build for (any options from 'go tool dist list' is valid)"`
	WASM        bool     `name:"wasm" type:"bool" help:"Output a web assembly (OS is ignored when this option is true)"`
	Output      string   `name:"output" short:"o" type:"string" help:"Output file name"`
	Tips        bool     `name:"tips" short:"t" type:"bool" help:"Display tips in the generated commands"`
	Minify      bool     `name:"minify" short:"m" type:"bool" help:"Set ldflags to strip debugging symbols and remove DWARF generations"`
	Shrink      bool     `name:"shrink" short:"s" type:"bool" help:"Set gccgoflags to strip debugging symbols and remove DWARF generations"`
	Compress    bool     `name:"compress" short:"c" type:"bool" help:"Compress with UPX"`
	Tiny        bool     `name:"tiny" type:"bool" help:"Use tinygo (if available) instead of go to build."`
	DryRun      bool     `name:"dry-run" short:"d" type:"bool" help:"Display the command without executing it."`
	NoWork      bool     `name:"nowork" type:"bool" help:"Set GOWORK=off when building"`
	Update      bool     `name:"update" short:"u" type:"bool" help:"Update (go mod tidy) before building."`
	IgnoreCache bool     `name:"no-cache" type:"bool" help:"Ignore the cache and rebuild, even if no Go files have changed."`
	Profile     []string `name:"profile" optional:"" help:"Name of the manifest.json profile attribute to apply."`
	File        string   `arg:"source" optional:"" help:"Go source file (ex: main.go)"`
	// Container string `name:"container" default:"docker" type:"string" enum:"docker,podman" help:"The containerization technology to build with"`
}

func (b *Build) Run(c *Context) error {
	ctx := context.New(b.Profile...)
	ctx.Configure()

	if len(strings.TrimSpace(ctx.InputFile())) == 0 {
		_, err := util.FindMainFileInDirectory("./")
		if err != nil {
			util.Stderr(err)
			util.SubtleHighlight("Only apps with a 'package main' can be built (not modules).")
			os.Exit(1)
		}
	}

	if b.IgnoreCache {
		ctx.IgnoreCache = b.IgnoreCache
	}

	if b.Update {
		ctx.Tidy = true
	}

	if b.Tiny {
		ctx.Tiny = b.Tiny
	}

	if b.WASM {
		ctx.OS = []string{"js"}
	} else {
		ctx.OS = b.OS
	}

	// Autorecognize UPX support
	if b.Compress == util.EmptyBool {
		b.Compress = ctx.UPX
	}

	if b.Minify {
		ctx.StripSymbols = true
		ctx.StripDebugging = true
	}

	if b.Shrink {
		ctx.GCCGoFlags.Add("-s")
		ctx.GCCGoFlags.Add("-w")
	}

	// Run this before go mod tidy to determine whether the output is cached
	cmd := ctx.BuildCommand()
	if c.Debug {
		b.Tips = true
	}

	if !b.DryRun {
		if ctx.Tidy {
			if !ctx.Cached {
				util.BailOnError(util.StreamNoStdErr("go mod tidy"))
				// util.Run("go mod tidy"))
				fmt.Println("")
			}
		}
	}

	// Display command
	fmt.Println(cmd.Display(b.Tips))

	parentdir := filepath.Dir(ctx.Output())
	if !fs.Exists(parentdir) {
		fs.Mkdirp(parentdir)
	}

	// Run command
	if !b.DryRun {
		if b.NoWork {
			os.Setenv("GOWORK", "off")
		}

		if ctx.BuildFast {
			current := os.Getenv("GOGC")
			if len(current) == 0 {
				current = "2000"
			}

			os.Setenv("GOGC", current)
		}

		cmd.Run(ctx.CWD)

		if b.Compress {
			util.Stdout("\n# compressing executable\n")
			upx := goupx.NewUPX()
			options := goupx.Options{
				CompressionTuningOpt: goupx.CompressionTuningOptions{
					Brute: 1,
				},
			}
			_, err := upx.Compress(ctx.Output(), 9, options)
			util.BailOnError(err)
			util.HighlightCommand("upx", upx.GetArgs()...)
			util.Stdout(fmt.Sprintf("  ↳ Name: %v\n  ↳ Format: %v\n  ↳ Original: %v\n  ↳ Compressed: %v\n  ↳ Ratio: %v%% of original\n", upx.CmdExecution.GetName(), upx.CmdExecution.GetFormat(), humanize.Bytes(upx.CmdExecution.GetOriginalFileSize()), humanize.Bytes(upx.CmdExecution.GetCompressedFileSize()), upx.CmdExecution.GetRatio()))
		}
	}

	return nil
}