https://github.com/essentialkaos/htmlcov

Utility for converting Go coverage profiles into HTML pages
https://github.com/essentialkaos/htmlcov

coverage golang

Last synced: about 1 month ago
JSON representation

Utility for converting Go coverage profiles into HTML pages

• Host: GitHub
• URL: https://github.com/essentialkaos/htmlcov
• Owner: essentialkaos
• License: apache-2.0
• Created: 2022-05-19T20:32:57.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-11-13T09:08:36.000Z (about 1 month ago)
• Last Synced: 2024-11-13T10:20:39.082Z (about 1 month ago)
• Topics: coverage, golang
• Language: Go
• Homepage: https://kaos.sh/htmlcov
• Size: 1.18 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        




  

  

  

  

  



Installation • Command-line completion • Man documentation • Usage • CI Status • Contributing • License





`htmlcov` is an utility for converting Go coverage profiles into HTML pages. It's just better version of `go tool cover -html=cover.out -o coverage.html` command.

![Screenshot](.github/images/screenshot1.png)

![Screenshot](.github/images/screenshot2.png)

### Installation

#### From source

To build the `htmlcov` from scratch, make sure you have a working [Go 1.22+](https://github.com/essentialkaos/.github/blob/master/GO-VERSION-SUPPORT.md) workspace (_[instructions](https://go.dev/doc/install)_), then:

```

go install github.com/essentialkaos/htmlcov@latest

```

#### Prebuilt binaries

You can download prebuilt binaries for Linux and macOS from [EK Apps Repository](https://apps.kaos.st/htmlcov/latest):

```bash

bash <(curl -fsSL https://apps.kaos.st/get) htmlcov

```

### Command-line completion

You can generate completion for `bash`, `zsh` or `fish` shell.

Bash:

```bash

sudo htmlcov --completion=bash 1> /etc/bash_completion.d/htmlcov

```

ZSH:

```bash

sudo htmlcov --completion=zsh 1> /usr/share/zsh/site-functions/htmlcov

```

Fish:

```bash

sudo htmlcov --completion=fish 1> /usr/share/fish/vendor_completions.d/htmlcov.fish

```

### Man documentation

You can generate man page using next command:

```bash

htmlcov --generate-man | sudo gzip > /usr/share/man/man1/htmlcov.1.gz

```

### Usage



### CI Status

| Branch | Status |

|--------|----------|

| `master` | [![CI](https://kaos.sh/w/htmlcov/ci.svg?branch=master)](https://kaos.sh/w/htmlcov/ci?query=branch:master) |

| `develop` | [![CI](https://kaos.sh/w/htmlcov/ci.svg?branch=develop)](https://kaos.sh/w/htmlcov/ci?query=branch:develop) |

### Contributing

Before contributing to this project please read our [Contributing Guidelines](https://github.com/essentialkaos/contributing-guidelines#contributing-guidelines).

### License

[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)