Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/orlangure/gocovsh

Go Coverage in your terminal: a tool for exploring Go Coverage reports from the command line 💻
https://github.com/orlangure/gocovsh

cli coverage coverage-report go golang golang-cli testing

Last synced: 7 days ago
JSON representation

Go Coverage in your terminal: a tool for exploring Go Coverage reports from the command line 💻

Host: GitHub
URL: https://github.com/orlangure/gocovsh
Owner: orlangure
License: gpl-3.0
Created: 2022-01-29T21:47:58.000Z (almost 3 years ago)
Default Branch: master
Last Pushed: 2024-01-17T20:25:03.000Z (10 months ago)
Last Synced: 2024-10-28T09:59:08.498Z (9 days ago)
Topics: cli, coverage, coverage-report, go, golang, golang-cli, testing
Language: Go
Homepage:
Size: 2.43 MB
Stars: 354
Watchers: 3
Forks: 14
Open Issues: 13
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

charm-in-the-wild - gocovsh - Explore Go coverage reports from the CLI. (_built with Bubble Tea_) (Applications / Development Tools)

README

        


    



# 
Gocovsh - Go Coverage in your terminal


`gocovsh` is a tool for exploring [Go Coverage

reports](https://go.dev/blog/cover) from the command line.

Don't skip the [Giving back](#giving-back) section! 💰

[Demo](#demo) below 🎬 👇

There is a Russian word *Ковш* (pronounced like "Kovsh") which means *a ladle*

or *a dipper*. ["The Big Dipper"](https://en.wikipedia.org/wiki/Big_Dipper) is

also a part of the constellation [Ursa

Major](https://en.wikipedia.org/wiki/Ursa_Major), thus the friendly

dipper-shaped Gopher mascot, created by [Michael Zolotov](https://www.mzolotov.com/).

## 
 ![Test](https://github.com/orlangure/gnomock/workflows/Test/badge.svg) [![Go Report Card](https://goreportcard.com/badge/github.com/orlangure/gocovsh)](https://goreportcard.com/report/github.com/orlangure/gocovsh) [![codecov](https://codecov.io/gh/orlangure/gocovsh/branch/master/graph/badge.svg?token=F0XYPSEIMK)](https://codecov.io/gh/orlangure/gocovsh) [![go-recipes](https://raw.githubusercontent.com/nikolaydubina/go-recipes/main/badge.svg?raw=true)](https://github.com/nikolaydubina/go-recipes)



## Installation

### Using [Homebrew](https://brew.sh/)

```bash

brew install orlangure/tap/gocovsh

```

### Pre-built binary

Grab your pre-built binary from the

[Releases](https://github.com/orlangure/gocovsh/releases) page.

### From source

```bash

# install latest, probably unreleased version

go install github.com/orlangure/gocovsh@latest

# or install a specific version

go install github.com/orlangure/[email protected]

```

## Usage

1. Generate Go coverage report at your project's root with

    ```bash

    go test -cover -coverprofile coverage.out

    ```

   For more information about generating Go coverage reports, see 📝 [my blog

   post](https://fedorov.dev/posts/2020-06-27-golang-end-to-end-test-coverage/).

2. Run `gocovsh` at the same folder with `coverage.out` report and `go.mod`

   file (`go.mod` is required).

   ```bash

   gocovsh                        # show all files from coverage report

   git diff --name-only | gocovsh # only show changed files

   git diff | gocovsh             # show coverage on top of current diff

   gocovsh --profile profile.out  # for other coverage profile names

   ```

3. Use `j/k/enter/esc` keys to explore the report. See built-in help for more

   key-bindings.

## Themes

`gocovsh` supports 4 nice themes (using [Catppuccin

Theme](https://github.com/catppuccin/catppuccin) project) and an ugly default

one at this moment. To change the theme, set `GOCOVSH_THEME` environment

variable to one of the following values: `mocha`, `latte`, `frappe` or

`macchiato`:

```bash

GOCOVSH_THEME=mocha gocovsh

GOCOVSH_THEME=latte gocovsh

GOCOVSH_THEME=frappe gocovsh

GOCOVSH_THEME=macchiato gocovsh

```

To always use the same theme, add `export GOCOVSH_THEME=` to your

`~/.bashrc`, `~/.zshrc` or any other file that you use for shell configuration.

## Giving back

This is a free and open source project that hopefully helps its users, at least

a little. Even though I don't need donations to support it, I understand that

there are people that wish to give back anyway. If you are one of them, I

encourage you to [plant some trees with Tree

Nation](https://tree-nation.com/plant/offer) 🌲 🌳 🌴

If you want me to know about your contribution, make sure to use

`[email protected]` as the recipient email.

Thank you!

## Demo

### Viewing Go code coverage reports

![go code coverage report viewer in the command line](./examples/general.gif)

### Only show Go code coverage of changed files

![go code coverage report of changed files in the command line](./examples/changed-files.gif)

### Go code coverage on top of `git diff`

![go code coverage report on top of git diff in the command line](./examples/diff-view.gif)