Skip to content

BADGES.md

Latest commit

 

History

History
74 lines (53 loc) · 2.29 KB

BADGES.md

File metadata and controls

74 lines (53 loc) · 2.29 KB

Badges

Generate SVG badges for your README (test status, coverage, Go version, etc.).

Overview

badges generates a static SVG image containing multiple badges and updates your README.md to display it. It is designed to work with minimal configuration, suitable for CI/CD pipelines or local development.

Usage

CLI

# Generate and update README with defaults
badges

# Customize values
badges -test-status="Failing" -coverage=50 -module-name="my-mod"

Flags

Flag Description Default
-module-name Module name testmodule
-test-status Test status label Passing
-coverage Coverage percentage 85
-race-status Race detection status Clean
-vet-status Go vet status OK
-license License type MIT
-readme Path to README file README.md

Library

You can importantly use the badges package directly in your Go code to generate SVGs programmatically.

import "github.com/tinywasm/devflow"

func main() {
    // Define badges in "Label:Value:Color" format
    // Special commands:
    // - output_svgfile:<path>
    // - readmefile:<path>
    
    handler := devflow.NewBadges(
        "Go:1.20:#007d9c",
        "Tests:Passing:#4c1",
        "Coverage:90%:#4c1",
        "output_svgfile:docs/my_badges.svg",
    )
    
    // Generate SVG and get markdown update args
    _, err := handler.BuildBadges()
    if err != nil {
        panic(err)
    }
}

How it works

  1. SVG Generation: Creates a single SVG file containing all defined badges.
  2. README Update: Updates a specific section in your markdown file (default BADGES_SECTION) with a link to the generated SVG.

Markdown Section

The badges tool automatically manages the badge image in your README.md. It will:

  1. Create new entry: If no badge line exists, insert <img src="docs/img/badges.svg"> after the first line (title)
  2. Update existing: If a badge <img src="...badges.svg"> line exists, update it in place
  3. Migrate old format: If old section markers exist (<!-- START_SECTION:BADGES_SECTION --> / <!-- END_SECTION:BADGES_SECTION -->), remove them and replace with the single img line

No section markers are required — the tool detects the badge by pattern matching.