f6d1d85722
Add two new mage commands: - `mage format`: run `gofmt` on all the Go sources. - `mage formatCheck`: run the formatter to check formatting issues. This will output the diff to make the code format-compliant. These commands are also available via `make format` resp. `make format-check`.
82 lines
1.8 KiB
Go
82 lines
1.8 KiB
Go
//go:build mage
|
|
|
|
package main
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
|
|
"github.com/magefile/mage/mg"
|
|
"github.com/magefile/mage/sh"
|
|
"golang.org/x/vuln/scan"
|
|
"honnef.co/go/tools/lintcmd"
|
|
lintcmdversion "honnef.co/go/tools/lintcmd/version"
|
|
"honnef.co/go/tools/simple"
|
|
"honnef.co/go/tools/staticcheck"
|
|
"honnef.co/go/tools/stylecheck"
|
|
"honnef.co/go/tools/unused"
|
|
)
|
|
|
|
// Run unit tests, check for vulnerabilities, and run the linter
|
|
func Check(ctx context.Context) {
|
|
mg.CtxDeps(ctx, Test, Govulncheck, Staticcheck, Vet, FormatCheck)
|
|
}
|
|
|
|
// Run unit tests
|
|
func Test(ctx context.Context) error {
|
|
return sh.RunV(mg.GoCmd(), "test", "-short", "-failfast", "./...")
|
|
}
|
|
|
|
// Check for known vulnerabilities.
|
|
func Govulncheck(ctx context.Context) error {
|
|
cmd := scan.Command(ctx, "./...")
|
|
if err := cmd.Start(); err != nil {
|
|
return err
|
|
}
|
|
return cmd.Wait()
|
|
}
|
|
|
|
// Analyse the source code.
|
|
func Staticcheck() error {
|
|
cmd := lintcmd.NewCommand("staticcheck")
|
|
cmd.SetVersion(lintcmdversion.Version, lintcmdversion.MachineVersion)
|
|
cmd.ParseFlags([]string{"./..."})
|
|
cmd.AddAnalyzers(simple.Analyzers...)
|
|
cmd.AddAnalyzers(staticcheck.Analyzers...)
|
|
cmd.AddAnalyzers(stylecheck.Analyzers...)
|
|
cmd.AddAnalyzers(unused.Analyzer)
|
|
|
|
exitCode := cmd.Execute()
|
|
if exitCode != 0 {
|
|
return errors.New("staticcheck failed")
|
|
}
|
|
fmt.Println("staticcheck ok")
|
|
return nil
|
|
}
|
|
|
|
// Run `go vet`
|
|
func Vet() error {
|
|
return sh.RunV(mg.GoCmd(), "vet", "./...")
|
|
}
|
|
|
|
// Run `gofmt`, formatting all the source code.
|
|
func Format() error {
|
|
return sh.RunV("gofmt", "-s", "-w", ".")
|
|
}
|
|
|
|
// Run `gofmt` on all the source code, reporting all differences.
|
|
func FormatCheck(ctx context.Context) error {
|
|
output, err := sh.Output("gofmt", "-d", ".")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if output == "" {
|
|
// Format was OK.
|
|
return nil
|
|
}
|
|
|
|
return fmt.Errorf("Formatting check failed:\n%s", output)
|
|
}
|