lint: Add testableexamples linter to have examples correctly tested.

keboola · Jun 4, 2024 · f2cf032 · f2cf032
1 parent 14f9030
commit f2cf032
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/build/ci/golangci.yml b/build/ci/golangci.yml
@@ -135,6 +135,7 @@ linters:
     - staticcheck
     - stylecheck
     - tagliatelle
+    - testableexamples
     - thelper
     - tparallel
     - paralleltest

diff --git a/internal/pkg/utils/errors/example_test.go b/internal/pkg/utils/errors/example_test.go
@@ -2,6 +2,7 @@ package errors_test
 
 import (
 	"fmt"
+	"regexp"
 
 	"github.com/keboola/keboola-as-code/internal/pkg/utils/errors"
 )
@@ -38,7 +39,10 @@ func ExampleWrap() {
 func ExampleWithStack() {
 	originalErr := errors.New("original error")
 	err := errors.WithStack(originalErr)
-	fmt.Println(errors.Format(err, errors.FormatWithStack()))
+	re := regexp.MustCompile("\\[.*/internal")
+	fmt.Println(string(re.ReplaceAll([]byte(errors.Format(err, errors.FormatWithStack())), []byte("["))))
+	// output:
+	// original error [/pkg/utils/errors/example_test.go:40]
 }
 
 func ExampleFormatWithStack() {
@@ -48,7 +52,15 @@ func ExampleFormatWithStack() {
 	fmt.Println(errors.Format(wrappedErr))
 	fmt.Println()
 	fmt.Println("FormatWithStack:")
-	fmt.Println(errors.Format(wrappedErr, errors.FormatWithStack()))
+	re := regexp.MustCompile("\\[.*/internal")
+	fmt.Println(string(re.ReplaceAll([]byte(errors.Format(wrappedErr, errors.FormatWithStack())), []byte("["))))
+	// output:
+	// Standard output:
+	// new error message
+	//
+	// FormatWithStack:
+	// new error message [/pkg/utils/errors/example_test.go:50] (*errors.wrappedError):
+	// - original error [/pkg/utils/errors/example_test.go:49]
 }
 
 func ExampleFormatWithUnwrap() {