gocmd

Documentation

Overview

Package gocmd provides helers for invoking Go tooling.

Index

• Variables
• func Build(dir string) error
• func CurrentMod(dir string) (string, error)
• func EditReplace(dir, mod, modPath string) error
• func ListModName(dir string) (string, error)
• func ModInit(dir, importPath, goVersion string) error
• func ModTidy(dir string) error
• func ModTidyAll(dir string) error
• func Vet(dir string) error
• func WorkUse(dir string) error

Variables

var (
	// ErrBuildConstraint is returned when the Go command returns this error.
	ErrBuildConstraint error = errors.New("build constraints exclude all Go files")
)

Functions

func Build

func Build(dir string) error

Build attempts to build all packages recursively from the given directory.

func CurrentMod

func CurrentMod(dir string) (string, error)

CurrentMod returns the module name of the provided directory.

func EditReplace

func EditReplace(dir, mod, modPath string) error

EditReplace edits a module dependency with a local reference.

func ListModName

func ListModName(dir string) (string, error)

ListModName finds a module's name for a given directory.

func ModInit

func ModInit(dir, importPath, goVersion string) error

ModInit creates a new module in the specified directory.

func ModTidy

func ModTidy(dir string) error

ModTidy tidies go.mod file in the specified directory.

func ModTidyAll

func ModTidyAll(dir string) error

ModTidyAll tidies all mod files from the specified root directory.

func Vet

func Vet(dir string) error

Vet runs linters on all .go files recursively from the given directory.

func WorkUse

func WorkUse(dir string) error

WorkUse updates the go.work file for added modules.