Merge pull request #4 from go-tstr/codecov

Add codecov

Author: heppu

.github/workflows/go.yaml

@@ -23,4 +23,9 @@ jobs:
       run: go mod download
 
     - name: Test
-      run: go test ./...
+      run: go test -coverprofile=coverage.txt ./...
+      
+    - name: Upload results to Codecov
+      uses: codecov/codecov-action@v4
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -0,0 +1 @@
+coverage.txt

README.md

@@ -0,0 +1,5 @@
+# errgroup
+
+[![Go Reference](https://pkg.go.dev/badge/github.com/go-tstr/tstr.svg)](https://pkg.go.dev/github.com/go-tstr/tstr) [![codecov](https://codecov.io/github/go-tstr/tstr/graph/badge.svg?token=H3u7Ui9PfC)](https://codecov.io/github/go-tstr/tstr)
+
+# Better testing with TSTR!

tester.go

@@ -28,16 +28,17 @@ type TestingT interface {
 	Run(name string, fn func(*testing.T)) bool
 }
 
-// exit is allows monkey-patching os.Exit in tests.
+// exit allows monkey-patching os.Exit in tests.
 var exit = os.Exit
 
 // Run runs the test with the given options.
 // Options are applied in the order they are passed.
 // One of the options must provide the test function.
+//
 // Options that provide the test function:
-// - WithM
-// - WithFn
-// - WithTable
+//   - WithM
+//   - WithFn
+//   - WithTable
 func Run(opts ...Opt) error {
 	t := NewTester(opts...)
 	if err := t.Init(); err != nil {
@@ -49,7 +50,8 @@ func Run(opts ...Opt) error {
 // RunMain is a convinience wrapper around Run that can be used inside TestMain.
 // RunMain applies automatically WithM option which calls m.Run.
 // Also os.Exit is called with non-zero exit code if Run returns any error.
-// Example TestMain:
+//
+// Example:
 //
 //	func TestMain(m *testing.M) {
 //		tstr.RunMain(m, tstr.WithDeps(MyDependency()))