report

package

v0.4.3 Latest Latest Go to latest Published: Apr 5, 2026 License: MIT Imports: 7 Imported by: 0

Details

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

Repository

github.com/git-pkgs/brief

Links

Open Source Insights

Documentation ¶

Overview ¶

Package report formats brief detection results for output.

Index ¶

Variables
func Human(w io.Writer, r *brief.Report, verbose bool)
func JSON(w io.Writer, r *brief.Report) error
func Markdown(w io.Writer, r *brief.Report, verbose bool)
func MissingHuman(w io.Writer, r *brief.MissingReport)
func MissingJSON(w io.Writer, r *brief.MissingReport) error
func MissingMarkdown(w io.Writer, r *brief.MissingReport)

Constants ¶

This section is empty.

Variables ¶

View Source

var CategoryLabels = map[string]string{
	"test":           "Test",
	"lint":           "Lint",
	"format":         "Format",
	"typecheck":      "Typecheck",
	"docs":           "Docs",
	"build":          "Build",
	"codegen":        "Codegen",
	"database":       "Database",
	"security":       "Security",
	"ci":             "CI",
	"container":      "Container",
	"infrastructure": "Infra",
	"monorepo":       "Monorepo",
	"environment":    "Environment",
	"i18n":           "i18n",
	"release":        "Release",
	"coverage":       "Coverage",
	"dependency_bot": "Dep Updates",
}

CategoryLabels maps category keys to human-readable labels.

View Source

var CategoryOrder = []string{"test", "lint", "format", "typecheck", "docs", "build", "codegen", "database", "security", "ci", "container", "infrastructure", "monorepo", "environment", "i18n", "release", "coverage", "dependency_bot"}

CategoryOrder defines the stable display order for tool categories.

Functions ¶

func Human ¶

func Human(w io.Writer, r *brief.Report, verbose bool)

Human writes the report in human-readable format.

func JSON ¶

func JSON(w io.Writer, r *brief.Report) error

JSON writes the report as JSON.

func Markdown ¶ added in v0.4.1

func Markdown(w io.Writer, r *brief.Report, verbose bool)

Markdown writes the report in markdown format.

func MissingHuman ¶ added in v0.4.0

func MissingHuman(w io.Writer, r *brief.MissingReport)

MissingHuman writes the missing report in human-readable format.

func MissingJSON ¶ added in v0.4.0

func MissingJSON(w io.Writer, r *brief.MissingReport) error

MissingJSON writes the missing report as JSON.

func MissingMarkdown ¶ added in v0.4.1

func MissingMarkdown(w io.Writer, r *brief.MissingReport)

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