grimoire

Documentation

Overview

Package grimoire provides standard magefile targets.

Index

• Variables
• func Ci()
• func Cover() error
• func Generate() error
• func Lint() error
• func Modules() []string
• func ShortCi()
• func ShortCover() error
• func Test() error
• func Tidy() error
• func Vendor() error
• func WithSubmodule(dir string) struct{}

Variables

var (
	Go = cast.DirPrepSh("go")
)

Some convenience methods

Functions

func Ci

func Ci()

Ci runs all tasks for continuous integration

func Cover

func Cover() error

Cover runs tests with coverage reporting depending on your codecov reporting setup, this will just work.

func Generate

func Generate() error

Generate runs go generate to generate any generated files. We check in our generated files, so this command only has to be run when you change something.

func Lint

func Lint() error

Lint runs golangci-lint to lint our code.

func Modules

func Modules() []string

Modules returns all registered module paths.

func ShortCi

func ShortCi()

ShortCi runs all short tests for continuous integration

func ShortCover

func ShortCover() error

ShortCover runs Cover but only for short tests

func Test

func Test() error

Test runs our unit tests.

func Tidy

func Tidy() error

Tidy runs tidy on all go modules.

func Vendor

func Vendor() error

Vendor installs dependencies into the vendor dir. While we typically use go modules for building, sometimes you want to install deps for legacy tooling to detect.

func WithSubmodule

func WithSubmodule(dir string) struct{}

WithSubmodule tells our mage setup that the calling repo has a submodule. It's probably a client module. If this is called, linting, testing, and generation will be called on the main module and the submodule.

This function can be called multiple times.