https://github.com/tschaefer/gocover-ui

gocover-ui - modern HTML coverage report
https://github.com/tschaefer/gocover-ui

Last synced: 5 months ago
JSON representation

gocover-ui - modern HTML coverage report

• Host: GitHub
• URL: https://github.com/tschaefer/gocover-ui
• Owner: tschaefer
• License: mit
• Created: 2025-12-20T17:46:05.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2026-01-08T07:48:51.000Z (5 months ago)
• Last Synced: 2026-01-08T09:27:10.304Z (5 months ago)
• Language: Go
• Homepage: https://blog.tschaefer.org/gocover-ui
• Size: 3.14 MB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# gocover-ui

[![tag](https://img.shields.io/github/tag/tschaefer/gocover-ui.svg)](https://github.com/tschaefer/gocover-ui/releases)

![Build Status](https://github.com/tschaefer/gocover-ui/actions/workflows/ci.yml/badge.svg)

[![Go report](https://goreportcard.com/badge/github.com/tschaefer/gocover-ui)](https://goreportcard.com/report/github.com/tschaefer/gocover-ui)

[![Coverage](https://img.shields.io/codecov/c/github/tschaefer/gocover-ui)](https://codecov.io/gh/tschaefer/gocover-ui)

[![Contributors](https://img.shields.io/github/contributors/tschaefer/gocover-ui)](https://github.com/tschaefer/gocover-ui/graphs/contributors)

[![License](https://img.shields.io/github/license/tschaefer/gocover-ui)](./LICENSE)

Generate a modern, interactive HTML coverage report from a Go coverage

profile file.

`gocover-ui` computes per-line coverage by mapping profile blocks to lines.

If a line is covered by multiple blocks and only some of those blocks are

covered, that line is considered "partial". Uncovered lines are "missed", and

fully covered lines are "covered".

## Features:

- Index page with a file list and stats columns:

  - lines total

  - lines covered

  - lines partial

  - lines missed

  - coverage % (red/yellow/green color band)

- Ring (donut) chart that shows all files as arcs; arc length is proportional

  to tracked lines and segment color reflects the file coverage band.

![Index view](.screenshots/gocover-ui-index.png "gocover-ui index view")

- Per-file detail pages with an editor-style view that shows line numbers and

  colors each line according to coverage:

  - red = missed

  - yellow = partial

  - green = fully covered

- Line highighting on click to easily share specific lines.

![Index view](.screenshots/gocover-ui-file.png "gocover-ui file view")

## Usage:

Run `gocover-ui` on a Go source tree with a proper module and the related

coverage profile file.

```bash

go test -coverprofile=coverage.out ./...

gocover-ui -profile coverage.out -src . -out coverage

open coverage/index.html

```

Flags:

- `-clean`

    clean output directory before generating files (default false)

- `-out string`

    output directory for generated html files (default "coverage")

- `-profile string`

    coverage profile file (default "coverage.out")

- `-src string`

    source root directory on disk; default `.` (current directory)

- `-version`

    print version and exit

## Contributing

Contributions are welcome! Please fork the repository and submit a pull request.

For major changes, open an issue first to discuss your proposal.

Ensure that your code adheres to the existing style and includes appropriate

tests.

## License

This project is licensed under the [MIT License](LICENSE).