build

package

v0.1.0 Latest Latest Go to latest Published: Jul 2, 2026 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Ceinl/plums

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Build(ctx context.Context, opts Options) (string, error)
func CacheKey(configDir string, opts Options) (string, error)
func CachedOutputPath(key string) (string, error)
func DefaultConfigDir() (string, error)
func DefaultOutputPath() (string, error)
func GenerateGoMod(opts Options) string
func GenerateMain(opts Options) string
func GenerateMainForModule(opts Options, modulePath string) string
func ModulePath(configDir string) (string, error)
func ModuleVersion(version string) string
func TidyConfigDir(ctx context.Context, configDir string, stdout, stderr io.Writer) error
type Options

Constants ¶

View Source

const (
	UserModulePath  = "github.com/Ceinl/plums-user"
	PlumsModulePath = "github.com/Ceinl/plums"
)

Variables ¶

This section is empty.

Functions ¶

func Build ¶

func Build(ctx context.Context, opts Options) (string, error)

func CacheKey ¶

func CacheKey(configDir string, opts Options) (string, error)

func CachedOutputPath ¶

func CachedOutputPath(key string) (string, error)

func DefaultConfigDir ¶

func DefaultConfigDir() (string, error)

func DefaultOutputPath ¶

func DefaultOutputPath() (string, error)

func GenerateGoMod ¶

func GenerateGoMod(opts Options) string

func GenerateMain ¶

func GenerateMain(opts Options) string

func GenerateMainForModule ¶

func GenerateMainForModule(opts Options, modulePath string) string

func ModulePath ¶

func ModulePath(configDir string) (string, error)

func ModuleVersion ¶

func ModuleVersion(version string) string

func TidyConfigDir ¶

func TidyConfigDir(ctx context.Context, configDir string, stdout, stderr io.Writer) error

TidyConfigDir runs `go mod tidy` in configDir when go.sum is missing, so a freshly seeded config module resolves its imports in editors (gopls needs go.sum entries) without the user running go commands by hand. Callers treat failure as non-fatal: the auto-build path tidies its own work module anyway, and an offline first launch should not break seeding.

Types ¶

type Options ¶

type Options struct {
	ConfigDir      string
	OutputPath     string
	WorkDir        string
	PlumsModuleDir string
	PlumsVersion   string
	Version        string
	Commit         string
	BuildDate      string
	Force          bool
	Stdout         io.Writer
	Stderr         io.Writer
}

Source Files ¶

View all Source files

build.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL