Skip to content

Latest commit

 

History

History
28 lines (19 loc) · 1.8 KB

File metadata and controls

28 lines (19 loc) · 1.8 KB

Go Reference Go Report Card

This is the way

testclarity is a command-line tool for giving clarity to your go tests. Here's how to install it:

go install github.com/sreyardship/testclarity/cmd/testclarity@latest

All credits should go to https://github.com/sreyardship/testclarity from which this project is forked.

Why fork?

gotestdox is very focused on the "documentation" part of the equation. I.e. taking your test name and generate documenation out of those. We believe this should be taken a step further and into your daily development work. By constantly showing you the resulting documentation generated by your test names you are able to faster realize when you're design is badly designed. This is based on the assumption that the intent of the test informs the usefulness of it, which we believe is usually the case (no empherical research to back that up though).

For reference see:

What extra features are there then?

Today there's only one flag -v which makes testclarity verbose and prints the output of tests with filename and numbers. But features in line with the vision for this tooling will be integrated and developed going forward, in lieu of time.

Links

Gopher image by MariaLetta