aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/maratori/testableexamples/pkg
diff options
context:
space:
mode:
authorTaras Madan <tarasmadan@google.com>2023-02-22 22:16:50 +0100
committerTaras Madan <tarasmadan@google.com>2023-02-24 12:47:23 +0100
commit4165372ec8fd142475a4e35fd0cf4f8042132208 (patch)
tree21cd62211b4dd80bee469054c5b65db77342333c /vendor/github.com/maratori/testableexamples/pkg
parent2b3ed821a493b8936c8bacfa6f8b4f1c90a00855 (diff)
dependencies: update
set go min requirements to 1.19 update dependencies update vendor
Diffstat (limited to 'vendor/github.com/maratori/testableexamples/pkg')
-rw-r--r--vendor/github.com/maratori/testableexamples/pkg/testableexamples/testableexamples.go34
1 files changed, 34 insertions, 0 deletions
diff --git a/vendor/github.com/maratori/testableexamples/pkg/testableexamples/testableexamples.go b/vendor/github.com/maratori/testableexamples/pkg/testableexamples/testableexamples.go
new file mode 100644
index 000000000..26d22c703
--- /dev/null
+++ b/vendor/github.com/maratori/testableexamples/pkg/testableexamples/testableexamples.go
@@ -0,0 +1,34 @@
+package testableexamples
+
+import (
+ "go/ast"
+ "go/doc"
+ "strings"
+
+ "golang.org/x/tools/go/analysis"
+)
+
+// NewAnalyzer returns Analyzer that checks if examples are testable.
+func NewAnalyzer() *analysis.Analyzer {
+ return &analysis.Analyzer{
+ Name: "testableexamples",
+ Doc: "linter checks if examples are testable (have an expected output)",
+ Run: func(pass *analysis.Pass) (interface{}, error) {
+ testFiles := make([]*ast.File, 0, len(pass.Files))
+ for _, file := range pass.Files {
+ fileName := pass.Fset.File(file.Pos()).Name()
+ if strings.HasSuffix(fileName, "_test.go") {
+ testFiles = append(testFiles, file)
+ }
+ }
+
+ for _, example := range doc.Examples(testFiles...) {
+ if example.Output == "" && !example.EmptyOutput {
+ pass.Reportf(example.Code.Pos(), "missing output for example, go test can't validate it")
+ }
+ }
+
+ return nil, nil
+ },
+ }
+}