123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475 |
- package rule
-
- import (
- "go/ast"
- "strings"
-
- "github.com/mgechev/revive/lint"
- )
-
- // BlankImportsRule lints given else constructs.
- type BlankImportsRule struct{}
-
- // Name returns the rule name.
- func (r *BlankImportsRule) Name() string {
- return "blank-imports"
- }
-
- // Apply applies the rule to given file.
- func (r *BlankImportsRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
- if file.Pkg.IsMain() || file.IsTest() {
- return nil
- }
-
- const (
- message = "a blank import should be only in a main or test package, or have a comment justifying it"
- category = "imports"
-
- embedImportPath = `"embed"`
- )
-
- var failures []lint.Failure
-
- // The first element of each contiguous group of blank imports should have
- // an explanatory comment of some kind.
- for i, imp := range file.AST.Imports {
- pos := file.ToPosition(imp.Pos())
-
- if !isBlank(imp.Name) {
- continue // Ignore non-blank imports.
- }
-
- if i > 0 {
- prev := file.AST.Imports[i-1]
- prevPos := file.ToPosition(prev.Pos())
-
- isSubsequentBlancInAGroup := isBlank(prev.Name) && prevPos.Line+1 == pos.Line && prev.Path.Value != embedImportPath
- if isSubsequentBlancInAGroup {
- continue
- }
- }
-
- if imp.Path.Value == embedImportPath && r.fileHasValidEmbedComment(file.AST) {
- continue
- }
-
- // This is the first blank import of a group.
- if imp.Doc == nil && imp.Comment == nil {
- failures = append(failures, lint.Failure{Failure: message, Category: category, Node: imp, Confidence: 1})
- }
- }
-
- return failures
- }
-
- func (r *BlankImportsRule) fileHasValidEmbedComment(fileAst *ast.File) bool {
- for _, commentGroup := range fileAst.Comments {
- for _, comment := range commentGroup.List {
- if strings.HasPrefix(comment.Text, "//go:embed ") {
- return true
- }
- }
- }
-
- return false
- }
|