gostd

Documentation

Overview

Package gostd contains go standard helpers.

Index

• Variables
• func GoTest(g *emd.Generator) func(string, string, ...string) (string, error)
• func PkgDoc(files ...string) (string, error)
• func Register(g *emd.Generator) error

Variables

var BadgeGoDoc = `{{define "badge/godoc" -}}
[!` +
	`[GoDoc]` +
	`(https://godoc.org/{{.ProviderURL}}/{{.User}}/{{.Name}}?status.svg)` +
	`]` +
	`(http://godoc.org/{{.ProviderURL}}/{{.User}}/{{.Name}})
{{- end}}`

BadgeGoDoc is a template to show a godoc badge.

var BadgeGoReport = `{{define "badge/goreport" -}}
[!` +
	`[Go Report Card]` +
	`(https://goreportcard.com/badge/{{.ProviderURL}}/{{.User}}/{{.Name}})` +
	`]` +
	`(https://goreportcard.com/report/{{.ProviderURL}}/{{.User}}/{{.Name}})
{{- end}}`

BadgeGoReport is a template to show a goreport badge.

var InstructionGoGetInstall = `{{define "go/install" -}}
` + "```sh" + `
go get {{.ProviderURL}}/{{.User}}/{{.Name}}
` + "```" + `
{{- end}}`

InstructionGoGetInstall is a template to show instructions to install the package with go get.

Functions

func GoTest

func GoTest(g *emd.Generator) func(string, string, ...string) (string, error)

GoTest Reads the first of the files, or `main.go`, lookup for its package comment and returns it as plain text.

func PkgDoc

func PkgDoc(files ...string) (string, error)

PkgDoc Reads the first of the files, or `main.go`, lookup for its package comment and returns it as plain text.

func Register

func Register(g *emd.Generator) error

Register go standard helpers to the generator.