aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/uudashr
diff options
context:
space:
mode:
authorTaras Madan <tarasmadan@google.com>2024-11-11 11:41:38 +0100
committerTaras Madan <tarasmadan@google.com>2024-11-11 11:10:48 +0000
commit27e76fae2ee2d84dc7db63af1d9ed7358ba35b7a (patch)
treeed19c0e35e272b3c4cc5a2f2c595e035b2428337 /vendor/github.com/uudashr
parent621e84e063b0e15b23e17780338627c509e1b9e8 (diff)
vendor: update
Diffstat (limited to 'vendor/github.com/uudashr')
-rw-r--r--vendor/github.com/uudashr/iface/LICENSE201
-rw-r--r--vendor/github.com/uudashr/iface/identical/doc.go3
-rw-r--r--vendor/github.com/uudashr/iface/identical/identical.go138
-rw-r--r--vendor/github.com/uudashr/iface/internal/directive/directive.go76
-rw-r--r--vendor/github.com/uudashr/iface/opaque/doc.go3
-rw-r--r--vendor/github.com/uudashr/iface/opaque/opaque.go321
-rw-r--r--vendor/github.com/uudashr/iface/unused/doc.go3
-rw-r--r--vendor/github.com/uudashr/iface/unused/unused.go138
8 files changed, 883 insertions, 0 deletions
diff --git a/vendor/github.com/uudashr/iface/LICENSE b/vendor/github.com/uudashr/iface/LICENSE
new file mode 100644
index 000000000..261eeb9e9
--- /dev/null
+++ b/vendor/github.com/uudashr/iface/LICENSE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/vendor/github.com/uudashr/iface/identical/doc.go b/vendor/github.com/uudashr/iface/identical/doc.go
new file mode 100644
index 000000000..5b848a913
--- /dev/null
+++ b/vendor/github.com/uudashr/iface/identical/doc.go
@@ -0,0 +1,3 @@
+// Package identical defines an Analyzer that identifies interfaces in the same
+// package with identical methods or constraints.
+package identical
diff --git a/vendor/github.com/uudashr/iface/identical/identical.go b/vendor/github.com/uudashr/iface/identical/identical.go
new file mode 100644
index 000000000..bd573cfc4
--- /dev/null
+++ b/vendor/github.com/uudashr/iface/identical/identical.go
@@ -0,0 +1,138 @@
+package identical
+
+import (
+ "fmt"
+ "go/ast"
+ "go/token"
+ "go/types"
+ "reflect"
+
+ "github.com/uudashr/iface/internal/directive"
+ "golang.org/x/tools/go/analysis"
+ "golang.org/x/tools/go/analysis/passes/inspect"
+ "golang.org/x/tools/go/ast/inspector"
+)
+
+// Analyzer is the duplicate interface analyzer.
+var Analyzer = newAnalyzer()
+
+func newAnalyzer() *analysis.Analyzer {
+ r := runner{}
+
+ analyzer := &analysis.Analyzer{
+ Name: "identical",
+ Doc: "Identifies interfaces in the same package that have identical method sets",
+ URL: "https://pkg.go.dev/github.com/uudashr/iface/duplicate",
+ Requires: []*analysis.Analyzer{inspect.Analyzer},
+ Run: r.run,
+ }
+
+ analyzer.Flags.BoolVar(&r.debug, "debug", false, "enable debug mode")
+
+ return analyzer
+}
+
+type runner struct {
+ debug bool
+}
+
+func (r *runner) run(pass *analysis.Pass) (interface{}, error) {
+ inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
+
+ // Collect interface type declarations
+ ifaceDecls := make(map[string]token.Pos)
+ ifaceTypes := make(map[string]*types.Interface)
+
+ nodeFilter := []ast.Node{
+ (*ast.GenDecl)(nil),
+ }
+
+ inspect.Preorder(nodeFilter, func(n ast.Node) {
+ decl, ok := n.(*ast.GenDecl)
+ if !ok {
+ return
+ }
+
+ if r.debug {
+ fmt.Printf("GenDecl: %v specs=%d\n", decl.Tok, len(decl.Specs))
+ }
+
+ if decl.Tok != token.TYPE {
+ return
+ }
+
+ for i, spec := range decl.Specs {
+ if r.debug {
+ fmt.Printf(" spec[%d]: %v %v\n", i, spec, reflect.TypeOf(spec))
+ }
+
+ ts, ok := spec.(*ast.TypeSpec)
+ if !ok {
+ return
+ }
+
+ ifaceType, ok := ts.Type.(*ast.InterfaceType)
+ if !ok {
+ return
+ }
+
+ if r.debug {
+ fmt.Println("Interface declaration:", ts.Name.Name, ts.Pos(), len(ifaceType.Methods.List))
+
+ for i, field := range ifaceType.Methods.List {
+ switch ft := field.Type.(type) {
+ case *ast.FuncType:
+ fmt.Printf(" [%d] Field: func %s %v %v\n", i, field.Names[0].Name, reflect.TypeOf(field.Type), field.Pos())
+ case *ast.Ident:
+ fmt.Printf(" [%d] Field: iface %s %v %v\n", i, ft.Name, reflect.TypeOf(field.Type), field.Pos())
+ default:
+ fmt.Printf(" [%d] Field: unknown %v\n", i, reflect.TypeOf(ft))
+ }
+ }
+ }
+
+ dir := directive.ParseIgnore(decl.Doc)
+ if dir != nil && dir.ShouldIgnore(pass.Analyzer.Name) {
+ // skip due to ignore directive
+ continue
+ }
+
+ ifaceDecls[ts.Name.Name] = ts.Pos()
+
+ obj := pass.TypesInfo.Defs[ts.Name]
+ if obj == nil {
+ return
+ }
+
+ iface, ok := obj.Type().Underlying().(*types.Interface)
+ if !ok {
+ return
+ }
+
+ ifaceTypes[ts.Name.Name] = iface
+ }
+ })
+
+Loop:
+ for name, typ := range ifaceTypes {
+ for otherName, otherTyp := range ifaceTypes {
+ if name == otherName {
+ continue
+ }
+
+ if !types.Identical(typ, otherTyp) {
+ continue
+ }
+
+ if r.debug {
+ fmt.Println("Identical interface:", name, "and", otherName)
+ }
+
+ pass.Reportf(ifaceDecls[name], "interface %s contains identical methods or type constraints from another interface, causing redundancy", name)
+
+ continue Loop
+ }
+ }
+
+ return nil, nil
+}
diff --git a/vendor/github.com/uudashr/iface/internal/directive/directive.go b/vendor/github.com/uudashr/iface/internal/directive/directive.go
new file mode 100644
index 000000000..05c62928e
--- /dev/null
+++ b/vendor/github.com/uudashr/iface/internal/directive/directive.go
@@ -0,0 +1,76 @@
+package directive
+
+import (
+ "go/ast"
+ "slices"
+ "strings"
+)
+
+// Ignore represent a special instruction embebded in the source code.
+//
+// The directive can be as simple as
+//
+// //iface:ignore
+//
+// or consist of name
+//
+// //iface:ignore=unused
+//
+// or multiple names
+//
+// //iface:ignore=unused,identical
+type Ignore struct {
+ Names []string
+}
+
+// ParseIgnore parse the directive from the comments.
+func ParseIgnore(doc *ast.CommentGroup) *Ignore {
+ if doc == nil {
+ return nil
+ }
+
+ for _, comment := range doc.List {
+ text := strings.TrimSpace(comment.Text)
+ if text == "//iface:ignore" {
+ return &Ignore{}
+ }
+
+ // parse the Names if exists
+ if val, found := strings.CutPrefix(text, "//iface:ignore="); found {
+ val = strings.TrimSpace(val)
+ if val == "" {
+ return &Ignore{}
+ }
+
+ names := strings.Split(val, ",")
+ if len(names) == 0 {
+ continue
+ }
+
+ for i, name := range names {
+ names[i] = strings.TrimSpace(name)
+ }
+
+ if len(names) > 0 {
+ return &Ignore{Names: names}
+ }
+
+ return &Ignore{}
+ }
+ }
+
+ return nil
+}
+
+func (i *Ignore) hasName(name string) bool {
+ return slices.Contains(i.Names, name)
+}
+
+// ShouldIgnore return true if the name should be ignored.
+func (i *Ignore) ShouldIgnore(name string) bool {
+ if len(i.Names) == 0 {
+ return true
+ }
+
+ return i.hasName(name)
+}
diff --git a/vendor/github.com/uudashr/iface/opaque/doc.go b/vendor/github.com/uudashr/iface/opaque/doc.go
new file mode 100644
index 000000000..1e5a53897
--- /dev/null
+++ b/vendor/github.com/uudashr/iface/opaque/doc.go
@@ -0,0 +1,3 @@
+// Package opaque defines an Analyzer to that detects interfaces that are used
+// to abstract a single concrete implementation only.
+package opaque
diff --git a/vendor/github.com/uudashr/iface/opaque/opaque.go b/vendor/github.com/uudashr/iface/opaque/opaque.go
new file mode 100644
index 000000000..fda0f001b
--- /dev/null
+++ b/vendor/github.com/uudashr/iface/opaque/opaque.go
@@ -0,0 +1,321 @@
+package opaque
+
+import (
+ "fmt"
+ "go/ast"
+ "go/types"
+ "reflect"
+ "strings"
+
+ "github.com/uudashr/iface/internal/directive"
+ "golang.org/x/tools/go/analysis"
+ "golang.org/x/tools/go/analysis/passes/inspect"
+ "golang.org/x/tools/go/ast/inspector"
+)
+
+// Analyzer is the opaque interface analyzer.
+var Analyzer = newAnalyzer()
+
+func newAnalyzer() *analysis.Analyzer {
+ r := runner{}
+
+ analyzer := &analysis.Analyzer{
+ Name: "opaque",
+ Doc: "Identifies functions that return interfaces, but the actual returned value is always a single concrete implementation.",
+ URL: "https://pkg.go.dev/github.com/uudashr/iface/opaque",
+ Requires: []*analysis.Analyzer{inspect.Analyzer},
+ Run: r.run,
+ }
+
+ analyzer.Flags.BoolVar(&r.debug, "debug", false, "enable debug mode")
+
+ return analyzer
+}
+
+type runner struct {
+ debug bool
+}
+
+func (r *runner) run(pass *analysis.Pass) (interface{}, error) {
+ inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
+
+ // Find function declarations that return an interface
+
+ nodeFilter := []ast.Node{
+ (*ast.FuncDecl)(nil),
+ }
+
+ inspect.Preorder(nodeFilter, func(n ast.Node) {
+ funcDecl := n.(*ast.FuncDecl)
+
+ if funcDecl.Recv != nil {
+ // skip methods
+ return
+ }
+
+ if funcDecl.Type.Results == nil {
+ // skip functions without return values
+ return
+ }
+
+ if r.debug {
+ fmt.Printf("Function declaration %s\n", funcDecl.Name.Name)
+ fmt.Printf(" Results len=%d\n", len(funcDecl.Type.Results.List))
+ }
+
+ dir := directive.ParseIgnore(funcDecl.Doc)
+ if dir != nil && dir.ShouldIgnore(pass.Analyzer.Name) {
+ // skip ignored function
+ return
+ }
+
+ // Pre-check, only function that has interface return type will be processed
+ var hasInterfaceReturnType bool
+
+ var outCount int
+
+ for i, result := range funcDecl.Type.Results.List {
+ outInc := 1
+ if namesLen := len(result.Names); namesLen > 0 {
+ outInc = namesLen
+ }
+
+ outCount += outInc
+
+ resType := result.Type
+ typ := pass.TypesInfo.TypeOf(resType)
+
+ if r.debug {
+ fmt.Printf(" [%d] len=%d %v %v %v | %v %v interface=%t\n", i, len(result.Names), result.Names, resType, reflect.TypeOf(resType), typ, reflect.TypeOf(typ), types.IsInterface(typ))
+ }
+
+ if types.IsInterface(typ) && !hasInterfaceReturnType {
+ hasInterfaceReturnType = true
+ }
+ }
+
+ if r.debug {
+ fmt.Printf(" hasInterface=%t outCount=%d\n", hasInterfaceReturnType, outCount)
+ }
+
+ if !hasInterfaceReturnType {
+ // skip, since it has no interface return type
+ return
+ }
+
+ // Collect types on every return statement
+ retStmtTypes := make([]map[types.Type]struct{}, outCount)
+ for i := range retStmtTypes {
+ retStmtTypes[i] = make(map[types.Type]struct{})
+ }
+
+ ast.Inspect(funcDecl.Body, func(n ast.Node) bool {
+ switch n := n.(type) {
+ case *ast.FuncLit:
+ // ignore nested functions
+ return false
+ case *ast.ReturnStmt:
+ if r.debug {
+ fmt.Printf(" Return statements %v len=%d\n", n.Results, len(n.Results))
+ }
+
+ for i, result := range n.Results {
+ if r.debug {
+ fmt.Printf(" [%d] %v %v\n", i, result, reflect.TypeOf(result))
+ }
+
+ switch res := result.(type) {
+ case *ast.CallExpr:
+ if r.debug {
+ fmt.Printf(" CallExpr Fun: %v %v\n", res.Fun, reflect.TypeOf(res.Fun))
+ }
+
+ typ := pass.TypesInfo.TypeOf(res)
+ switch typ := typ.(type) {
+ case *types.Tuple:
+ for i := 0; i < typ.Len(); i++ {
+ v := typ.At(i)
+ vTyp := v.Type()
+ retStmtTypes[i][vTyp] = struct{}{}
+
+ if r.debug {
+ fmt.Printf(" Tuple [%d]: %v %v | %v %v interface=%t\n", i, v, reflect.TypeOf(v), vTyp, reflect.TypeOf(vTyp), types.IsInterface(vTyp))
+ }
+ }
+ default:
+ retStmtTypes[i][typ] = struct{}{}
+ }
+
+ case *ast.Ident:
+ if r.debug {
+ fmt.Printf(" Ident: %v %v\n", res, reflect.TypeOf(res))
+ }
+
+ typ := pass.TypesInfo.TypeOf(res)
+
+ if r.debug {
+ fmt.Printf(" Ident type: %v %v interface=%t\n", typ, reflect.TypeOf(typ), types.IsInterface(typ))
+ }
+
+ retStmtTypes[i][typ] = struct{}{}
+ case *ast.UnaryExpr:
+ if r.debug {
+ fmt.Printf(" UnaryExpr X: %v \n", res.X)
+ }
+
+ typ := pass.TypesInfo.TypeOf(res)
+
+ if r.debug {
+ fmt.Printf(" UnaryExpr type: %v %v interface=%t\n", typ, reflect.TypeOf(typ), types.IsInterface(typ))
+ }
+
+ retStmtTypes[i][typ] = struct{}{}
+ default:
+ if r.debug {
+ fmt.Printf(" Unknown: %v %v\n", res, reflect.TypeOf(res))
+ }
+
+ typ := pass.TypesInfo.TypeOf(res)
+ retStmtTypes[i][typ] = struct{}{}
+ }
+ }
+
+ return false
+ default:
+ return true
+ }
+ })
+
+ // Compare func return types with the return statement types
+ var nextIdx int
+
+ for _, result := range funcDecl.Type.Results.List {
+ resType := result.Type
+ typ := pass.TypesInfo.TypeOf(resType)
+
+ consumeCount := 1
+ if len(result.Names) > 0 {
+ consumeCount = len(result.Names)
+ }
+
+ currentIdx := nextIdx
+ nextIdx += consumeCount
+
+ // Check return type
+ if !types.IsInterface(typ) {
+ // it is a concrete type
+ continue
+ }
+
+ if typ.String() == "error" {
+ // very common case to have return type error
+ continue
+ }
+
+ if !fromSamePackage(pass, typ) {
+ // ignore interface from other package
+ continue
+ }
+
+ // Check statement type
+ stmtTyps := retStmtTypes[currentIdx]
+
+ stmtTypsSize := len(stmtTyps)
+ if stmtTypsSize > 1 {
+ // it has multiple implementation
+ continue
+ }
+
+ if stmtTypsSize == 0 {
+ // function use named return value, while return statement is empty
+ continue
+ }
+
+ var stmtTyp types.Type
+ for t := range stmtTyps {
+ // expect only one, we don't have to break it
+ stmtTyp = t
+ }
+
+ if types.IsInterface(stmtTyp) {
+ // not concrete type, skip
+ continue
+ }
+
+ if r.debug {
+ fmt.Printf("stmtType: %v %v | %v %v\n", stmtTyp, reflect.TypeOf(stmtTyp), stmtTyp.Underlying(), reflect.TypeOf(stmtTyp.Underlying()))
+ }
+
+ switch stmtTyp := stmtTyp.(type) {
+ case *types.Basic:
+ if stmtTyp.Kind() == types.UntypedNil {
+ // ignore nil
+ continue
+ }
+ case *types.Named:
+ if _, ok := stmtTyp.Underlying().(*types.Signature); ok {
+ // skip function type
+ continue
+ }
+ }
+
+ retTypeName := typ.String()
+ if fromSamePackage(pass, typ) {
+ retTypeName = removePkgPrefix(retTypeName)
+ }
+
+ stmtTypName := stmtTyp.String()
+ if fromSamePackage(pass, stmtTyp) {
+ stmtTypName = removePkgPrefix(stmtTypName)
+ }
+
+ pass.Reportf(result.Pos(),
+ "%s function return %s interface at the %s result, abstract a single concrete implementation of %s",
+ funcDecl.Name.Name,
+ retTypeName,
+ positionStr(currentIdx),
+ stmtTypName)
+ }
+ })
+
+ return nil, nil
+}
+
+func positionStr(idx int) string {
+ switch idx {
+ case 0:
+ return "1st"
+ case 1:
+ return "2nd"
+ case 2:
+ return "3rd"
+ default:
+ return fmt.Sprintf("%dth", idx+1)
+ }
+}
+
+func fromSamePackage(pass *analysis.Pass, typ types.Type) bool {
+ switch typ := typ.(type) {
+ case *types.Named:
+ currentPkg := pass.Pkg
+ ifacePkg := typ.Obj().Pkg()
+
+ return currentPkg == ifacePkg
+ case *types.Pointer:
+ return fromSamePackage(pass, typ.Elem())
+ default:
+ return false
+ }
+}
+
+func removePkgPrefix(typeStr string) string {
+ if typeStr[0] == '*' {
+ return "*" + removePkgPrefix(typeStr[1:])
+ }
+
+ if lastDot := strings.LastIndex(typeStr, "."); lastDot != -1 {
+ return typeStr[lastDot+1:]
+ }
+
+ return typeStr
+}
diff --git a/vendor/github.com/uudashr/iface/unused/doc.go b/vendor/github.com/uudashr/iface/unused/doc.go
new file mode 100644
index 000000000..d5b6f24bb
--- /dev/null
+++ b/vendor/github.com/uudashr/iface/unused/doc.go
@@ -0,0 +1,3 @@
+// Package unused defines an Analyzer that indetifies interfaces that are not
+// used anywhere in the same package where the interface is defined.
+package unused
diff --git a/vendor/github.com/uudashr/iface/unused/unused.go b/vendor/github.com/uudashr/iface/unused/unused.go
new file mode 100644
index 000000000..c2efbf52c
--- /dev/null
+++ b/vendor/github.com/uudashr/iface/unused/unused.go
@@ -0,0 +1,138 @@
+package unused
+
+import (
+ "fmt"
+ "go/ast"
+ "go/token"
+ "reflect"
+ "slices"
+ "strings"
+
+ "github.com/uudashr/iface/internal/directive"
+ "golang.org/x/tools/go/analysis"
+ "golang.org/x/tools/go/analysis/passes/inspect"
+ "golang.org/x/tools/go/ast/inspector"
+)
+
+// Analyzer is the unused interface analyzer.
+var Analyzer = newAnalyzer()
+
+func newAnalyzer() *analysis.Analyzer {
+ r := runner{}
+
+ analyzer := &analysis.Analyzer{
+ Name: "unused",
+ Doc: "Identifies interfaces that are not used anywhere in the same package where the interface is defined",
+ URL: "https://pkg.go.dev/github.com/uudashr/iface/unused",
+ Requires: []*analysis.Analyzer{inspect.Analyzer},
+ Run: r.run,
+ }
+
+ analyzer.Flags.BoolVar(&r.debug, "debug", false, "enable debug mode")
+ analyzer.Flags.StringVar(&r.exclude, "exclude", "", "comma-separated list of packages to exclude from the check")
+
+ return analyzer
+}
+
+type runner struct {
+ debug bool
+ exclude string
+}
+
+func (r *runner) run(pass *analysis.Pass) (interface{}, error) {
+ excludes := strings.Split(r.exclude, ",")
+ if slices.Contains(excludes, pass.Pkg.Path()) {
+ return nil, nil
+ }
+
+ inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
+
+ // Collect all interface type declarations
+ ifaceDecls := make(map[string]token.Pos)
+
+ nodeFilter := []ast.Node{
+ (*ast.GenDecl)(nil),
+ }
+
+ inspect.Preorder(nodeFilter, func(n ast.Node) {
+ decl, ok := n.(*ast.GenDecl)
+ if !ok {
+ return
+ }
+
+ if r.debug {
+ fmt.Printf("GenDecl: %v specs=%d\n", decl.Tok, len(decl.Specs))
+ }
+
+ if decl.Tok != token.TYPE {
+ return
+ }
+
+ for i, spec := range decl.Specs {
+ if r.debug {
+ fmt.Printf(" spec[%d]: %v %v\n", i, spec, reflect.TypeOf(spec))
+ }
+
+ ts, ok := spec.(*ast.TypeSpec)
+ if !ok {
+ continue
+ }
+
+ _, ok = ts.Type.(*ast.InterfaceType)
+ if !ok {
+ return
+ }
+
+ if r.debug {
+ fmt.Println(" Interface type declaration:", ts.Name.Name, ts.Pos())
+ }
+
+ dir := directive.ParseIgnore(decl.Doc)
+ if dir != nil && dir.ShouldIgnore(pass.Analyzer.Name) {
+ // skip due to ignore directive
+ continue
+ }
+
+ ifaceDecls[ts.Name.Name] = ts.Pos()
+ }
+ })
+
+ if r.debug {
+ var ifaceNames []string
+ for name := range ifaceDecls {
+ ifaceNames = append(ifaceNames, name)
+ }
+
+ fmt.Println("Declared interfaces:", ifaceNames)
+ }
+
+ // Inspect whether the interface is used within the package
+ nodeFilter = []ast.Node{
+ (*ast.Ident)(nil),
+ }
+
+ inspect.Preorder(nodeFilter, func(n ast.Node) {
+ ident, ok := n.(*ast.Ident)
+ if !ok {
+ return
+ }
+
+ pos := ifaceDecls[ident.Name]
+ if pos == ident.Pos() {
+ // The identifier is the interface type declaration
+ return
+ }
+
+ delete(ifaceDecls, ident.Name)
+ })
+
+ if r.debug {
+ fmt.Printf("Package %s %s\n", pass.Pkg.Path(), pass.Pkg.Name())
+ }
+
+ for name, pos := range ifaceDecls {
+ pass.Reportf(pos, "interface %s is declared but not used within the package", name)
+ }
+
+ return nil, nil
+}