aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/maratori/testableexamples
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/maratori/testableexamples')
-rw-r--r--vendor/github.com/maratori/testableexamples/LICENSE21
-rw-r--r--vendor/github.com/maratori/testableexamples/pkg/testableexamples/testableexamples.go34
2 files changed, 55 insertions, 0 deletions
diff --git a/vendor/github.com/maratori/testableexamples/LICENSE b/vendor/github.com/maratori/testableexamples/LICENSE
new file mode 100644
index 000000000..e8b68be3e
--- /dev/null
+++ b/vendor/github.com/maratori/testableexamples/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Marat Reymers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
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
+ },
+ }
+}