carolynvs/magex

Helper methods for Magefiles

Magefile Extensions

This library provides helper methods to use with mage.

Below is a sample of the type of helpers available. Full examples and documentation is on godoc.

// +build mage

package main

import (
	"github.com/carolynvs/magex/pkg"
	"github.com/carolynvs/magex/shx"
)

// Check if packr2 is in the bin/ directory and is at least v2.
// If not, install [email protected] into bin/
func EnsurePackr2() error {
	opts := pkg.EnsurePackageOptions{
		Name: "github.com/gobuffalo/packr/v2/packr2",
		DefaultVersion: "v2.8.0",
		VersionCommand: "version",
		Destination: "bin",
    }
   return pkg.EnsurePackageWith(opts)
}

// Install mage if it's not available, and ensure it's in PATH. We don't care which version
func Mage() error {
    return pkg.EnsureMage("")
}

// Run a docker registry in a container. Do not print stdout and only print
// stderr when the command fails even when -v is set.
//
// Useful for commands that you only care about when it fails, keeping unhelpful
// output out of your logs.
func StartRegistry() error {
    return shx.RunE("docker", "run", "-d", "-p", "5000:5000", "--name", "registry", "registry:2")
}

// Use go to download a tool, build and install it manually so 
// that it has version information embedded in the final binary.
func CustomInstallTool() error {
	err := shx.RunE("go", "get", "-u", "github.com/magefile/mage")
	if err != nil {
    		return err
	}
    
	src := filepath.Join(GOPATH(), "src/github.com/magefile/mage")
	return shx.Command("go", "run", "bootstrap.go").In(src).RunE()
}

magex's Issues

Support running commands from strings

It would be nice to not have to specify the arguments as a string slice and instead pass a single space separated string.

shx.Run("go test ./...")

There is a library that can help with this, https://github.com/mattn/go-shellwords

You could extend this further and support newline separated commands

shx.Run(`
go build -o bin/stuff .
go test ./...
./bin/stuff --version
`)

If you were feeling really spicy, you could define a parser for a simplified Makefile syntax and then execute the Makefile in the same directory.

magefile.go
Makefile

magefile.go

//go:generate magic command to generate a magefile with extra targets based on the Makefile 

Fork notice

See https://github.com/uwu-tools/magex#attribution / uwu-tools/magex#1. 🖤

Copy should preserve file permisisons

Allow installing into local directory

Right now we always install into the GOPATH/bin directory so that people can immediately use the installed binaries. But that can cause contention between projects and the version that they require. Installing into a local directory, such as ./tools/, would allow each project to have their own copies which they can make accessible by adding it to the PATH.

shx.Copy doesn't work for copying a single file

I am having trouble copying a single file. I think because the code is calling walk?

Use semver ranges for version comparison

Support saying that I need at least 1.x of a cli, so that when we check if it's installed, we don't try to reinstall if it's higher than the specified version.

shx.Copy should support relative paths

I would like to use shx.Copy("../bin", "someplace) and have it work but it's failing to resolve "../bin" correctly.