cleanup rules, remove error from return signature

mgechev · Dec 8, 2024 · d6f17ff · d6f17ff
1 parent ea832f4
commit d6f17ff
Show file tree

Hide file tree

Showing 87 changed files with 233 additions and 230 deletions.
diff --git a/lint/file.go b/lint/file.go
@@ -106,10 +106,8 @@ func (f *File) lint(rules []Rule, config Config, failures chan Failure) error {
 		if ruleConfig.MustExclude(f.Name) {
 			continue
 		}
-		currentFailures, err := currentRule.Apply(f, ruleConfig.Arguments)
-		if err != nil {
-			return err
-		}
+		currentFailures := currentRule.Apply(f, ruleConfig.Arguments)
+
 		for idx, failure := range currentFailures {
 			if failure.IsInternal() {
 				return errors.New(failure.Failure)

diff --git a/lint/rule.go b/lint/rule.go
@@ -14,7 +14,7 @@ type DisabledInterval struct {
 // Rule defines an abstract rule interface
 type Rule interface {
 	Name() string
-	Apply(*File, Arguments) ([]Failure, error)
+	Apply(*File, Arguments) ([]Failure)
 }
 
 // ToFailurePosition returns the failure position.

diff --git a/revivelib/core_internal_test.go b/revivelib/core_internal_test.go
@@ -43,8 +43,8 @@ func (*mockRule) Name() string {
 	return "mock-rule"
 }
 
-func (*mockRule) Apply(_ *lint.File, _ lint.Arguments) ([]lint.Failure, error) {
-	return nil, nil
+func (*mockRule) Apply(_ *lint.File, _ lint.Arguments) []lint.Failure {
+	return nil
 }
 
 func getMockRevive(t *testing.T) *Revive {

diff --git a/revivelib/core_test.go b/revivelib/core_test.go
@@ -78,8 +78,8 @@ func (r *mockRule) Name() string {
 	return "mock-rule"
 }
 
-func (r *mockRule) Apply(file *lint.File, arguments lint.Arguments) ([]lint.Failure, error) {
-	return nil, nil
+func (r *mockRule) Apply(file *lint.File, arguments lint.Arguments) []lint.Failure {
+	return nil
 }
 
 func getMockRevive(t *testing.T) *revivelib.Revive {

diff --git a/rule/argument_limit.go b/rule/argument_limit.go
@@ -33,12 +33,12 @@ func (r *ArgumentsLimitRule) configure(arguments lint.Arguments) error {
 }
 
 // Apply applies the rule to given file.
-func (r *ArgumentsLimitRule) Apply(file *lint.File, arguments lint.Arguments) ([]lint.Failure, error) {
+func (r *ArgumentsLimitRule) Apply(file *lint.File, arguments lint.Arguments) []lint.Failure {
 	var configureErr error
 	r.configureOnce.Do(func() { configureErr = r.configure(arguments) })
 
 	if configureErr != nil {
-		return nil, configureErr
+		return []lint.Failure{lint.NewInternalFailure(configureErr.Error())}
 	}
 
 	var failures []lint.Failure
@@ -65,7 +65,7 @@ func (r *ArgumentsLimitRule) Apply(file *lint.File, arguments lint.Arguments) ([
 		})
 	}
 
-	return failures, nil
+	return failures
 }
 
 // Name returns the rule name.

diff --git a/rule/atomic.go b/rule/atomic.go
@@ -12,7 +12,7 @@ import (
 type AtomicRule struct{}
 
 // Apply applies the rule to given file.
-func (*AtomicRule) Apply(file *lint.File, _ lint.Arguments) ([]lint.Failure, error) {
+func (*AtomicRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
 	var failures []lint.Failure
 	walker := atomic{
 		pkgTypesInfo: file.Pkg.TypesInfo(),
@@ -23,7 +23,7 @@ func (*AtomicRule) Apply(file *lint.File, _ lint.Arguments) ([]lint.Failure, err
 
 	ast.Walk(walker, file.AST)
 
-	return failures, nil
+	return failures
 }
 
 // Name returns the rule name.

diff --git a/rule/banned_characters.go b/rule/banned_characters.go
@@ -35,12 +35,12 @@ func (r *BannedCharsRule) configure(arguments lint.Arguments) error {
 }
 
 // Apply applied the rule to the given file.
-func (r *BannedCharsRule) Apply(file *lint.File, arguments lint.Arguments) ([]lint.Failure, error) {
+func (r *BannedCharsRule) Apply(file *lint.File, arguments lint.Arguments) []lint.Failure {
 	var configureErr error
 	r.configureOnce.Do(func() { configureErr = r.configure(arguments) })
 
 	if configureErr != nil {
-		return nil, configureErr
+		return []lint.Failure{lint.NewInternalFailure(configureErr.Error())}
 	}
 
 	var failures []lint.Failure
@@ -54,7 +54,7 @@ func (r *BannedCharsRule) Apply(file *lint.File, arguments lint.Arguments) ([]li
 	}
 
 	ast.Walk(w, file.AST)
-	return failures, nil
+	return failures
 }
 
 // Name returns the rule name

diff --git a/rule/bare_return.go b/rule/bare_return.go
@@ -10,7 +10,7 @@ import (
 type BareReturnRule struct{}
 
 // Apply applies the rule to given file.
-func (*BareReturnRule) Apply(file *lint.File, _ lint.Arguments) ([]lint.Failure, error) {
+func (*BareReturnRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
 	var failures []lint.Failure
 
 	onFailure := func(failure lint.Failure) {
@@ -19,7 +19,7 @@ func (*BareReturnRule) Apply(file *lint.File, _ lint.Arguments) ([]lint.Failure,
 
 	w := lintBareReturnRule{onFailure: onFailure}
 	ast.Walk(w, file.AST)
-	return failures, nil
+	return failures
 }
 
 // Name returns the rule name.

diff --git a/rule/blank_imports.go b/rule/blank_imports.go
@@ -16,9 +16,9 @@ func (*BlankImportsRule) Name() string {
 }
 
 // Apply applies the rule to given file.
-func (r *BlankImportsRule) Apply(file *lint.File, _ lint.Arguments) ([]lint.Failure, error) {
+func (r *BlankImportsRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
 	if file.Pkg.IsMain() || file.IsTest() {
-		return nil, nil
+		return nil
 	}
 
 	const (
@@ -59,7 +59,7 @@ func (r *BlankImportsRule) Apply(file *lint.File, _ lint.Arguments) ([]lint.Fail
 		}
 	}
 
-	return failures, nil
+	return failures
 }
 
 func (*BlankImportsRule) fileHasValidEmbedComment(fileAst *ast.File) bool {

diff --git a/rule/bool_literal_in_expr.go b/rule/bool_literal_in_expr.go
@@ -11,7 +11,7 @@ import (
 type BoolLiteralRule struct{}
 
 // Apply applies the rule to given file.
-func (*BoolLiteralRule) Apply(file *lint.File, _ lint.Arguments) ([]lint.Failure, error) {
+func (*BoolLiteralRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
 	var failures []lint.Failure
 
 	onFailure := func(failure lint.Failure) {
@@ -22,7 +22,7 @@ func (*BoolLiteralRule) Apply(file *lint.File, _ lint.Arguments) ([]lint.Failure
 	w := &lintBoolLiteral{astFile, onFailure}
 	ast.Walk(w, astFile)
 
-	return failures, nil
+	return failures
 }
 
 // Name returns the rule name.

diff --git a/rule/call_to_gc.go b/rule/call_to_gc.go
@@ -10,7 +10,7 @@ import (
 type CallToGCRule struct{}
 
 // Apply applies the rule to given file.
-func (*CallToGCRule) Apply(file *lint.File, _ lint.Arguments) ([]lint.Failure, error) {
+func (*CallToGCRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
 	var failures []lint.Failure
 	onFailure := func(failure lint.Failure) {
 		failures = append(failures, failure)
@@ -23,7 +23,7 @@ func (*CallToGCRule) Apply(file *lint.File, _ lint.Arguments) ([]lint.Failure, e
 	w := lintCallToGC{onFailure, gcTriggeringFunctions}
 	ast.Walk(w, file.AST)
 
-	return failures, nil
+	return failures
 }
 
 // Name returns the rule name.

diff --git a/rule/cognitive_complexity.go b/rule/cognitive_complexity.go
@@ -35,12 +35,12 @@ func (r *CognitiveComplexityRule) configure(arguments lint.Arguments) error {
 }
 
 // Apply applies the rule to given file.
-func (r *CognitiveComplexityRule) Apply(file *lint.File, arguments lint.Arguments) ([]lint.Failure, error) {
+func (r *CognitiveComplexityRule) Apply(file *lint.File, arguments lint.Arguments) []lint.Failure {
 	var configureErr error
 	r.configureOnce.Do(func() { configureErr = r.configure(arguments) })
 
 	if configureErr != nil {
-		return nil, configureErr
+		return []lint.Failure{lint.NewInternalFailure(configureErr.Error())}
 	}
 
 	var failures []lint.Failure
@@ -55,7 +55,7 @@ func (r *CognitiveComplexityRule) Apply(file *lint.File, arguments lint.Argument
 
 	linter.lintCognitiveComplexity()
 
-	return failures, nil
+	return failures
 }
 
 // Name returns the rule name.

diff --git a/rule/comment_spacings.go b/rule/comment_spacings.go
@@ -29,12 +29,12 @@ func (r *CommentSpacingsRule) configure(arguments lint.Arguments) error {
 }
 
 // Apply the rule.
-func (r *CommentSpacingsRule) Apply(file *lint.File, arguments lint.Arguments) ([]lint.Failure, error) {
+func (r *CommentSpacingsRule) Apply(file *lint.File, arguments lint.Arguments) []lint.Failure {
 	var configureErr error
 	r.configureOnce.Do(func() { configureErr = r.configure(arguments) })
 
 	if configureErr != nil {
-		return nil, configureErr
+		return []lint.Failure{lint.NewInternalFailure(configureErr.Error())}
 	}
 
 	var failures []lint.Failure
@@ -69,7 +69,7 @@ func (r *CommentSpacingsRule) Apply(file *lint.File, arguments lint.Arguments) (
 			})
 		}
 	}
-	return failures, nil
+	return failures
 }
 
 // Name yields this rule name.

diff --git a/rule/comments_density.go b/rule/comments_density.go
@@ -33,12 +33,12 @@ func (r *CommentsDensityRule) configure(arguments lint.Arguments) error {
 }
 
 // Apply applies the rule to given file.
-func (r *CommentsDensityRule) Apply(file *lint.File, arguments lint.Arguments) ([]lint.Failure, error) {
+func (r *CommentsDensityRule) Apply(file *lint.File, arguments lint.Arguments) []lint.Failure {
 	var configureErr error
 	r.configureOnce.Do(func() { configureErr = r.configure(arguments) })
 
 	if configureErr != nil {
-		return nil, configureErr
+		return []lint.Failure{lint.NewInternalFailure(configureErr.Error())}
 	}
 
 	commentsLines := countDocLines(file.AST.Comments)
@@ -53,10 +53,10 @@ func (r *CommentsDensityRule) Apply(file *lint.File, arguments lint.Arguments) (
 				Failure: fmt.Sprintf("the file has a comment density of %2.f%% (%d comment lines for %d code lines) but expected a minimum of %d%%",
 					density, commentsLines, statementsCount, r.minimumCommentsDensity),
 			},
-		}, nil
+		}
 	}
 
-	return nil, nil
+	return nil
 }
 
 // Name returns the rule name.

diff --git a/rule/confusing_naming.go b/rule/confusing_naming.go
@@ -47,7 +47,7 @@ var allPkgs = packages{pkgs: make([]pkgMethods, 1)}
 type ConfusingNamingRule struct{}
 
 // Apply applies the rule to given file.
-func (*ConfusingNamingRule) Apply(file *lint.File, _ lint.Arguments) ([]lint.Failure, error) {
+func (*ConfusingNamingRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
 	var failures []lint.Failure
 	fileAst := file.AST
 	pkgm := allPkgs.methodNames(file.Pkg)
@@ -61,7 +61,7 @@ func (*ConfusingNamingRule) Apply(file *lint.File, _ lint.Arguments) ([]lint.Fai
 
 	ast.Walk(&walker, fileAst)
 
-	return failures, nil
+	return failures
 }
 
 // Name returns the rule name.

diff --git a/rule/confusing_results.go b/rule/confusing_results.go
@@ -10,7 +10,7 @@ import (
 type ConfusingResultsRule struct{}
 
 // Apply applies the rule to given file.
-func (*ConfusingResultsRule) Apply(file *lint.File, _ lint.Arguments) ([]lint.Failure, error) {
+func (*ConfusingResultsRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
 	var failures []lint.Failure
 
 	for _, decl := range file.AST.Decls {
@@ -45,7 +45,7 @@ func (*ConfusingResultsRule) Apply(file *lint.File, _ lint.Arguments) ([]lint.Fa
 		}
 	}
 
-	return failures, nil
+	return failures
 }
 
 // Name returns the rule name.

diff --git a/rule/constant_logical_expr.go b/rule/constant_logical_expr.go
@@ -11,7 +11,7 @@ import (
 type ConstantLogicalExprRule struct{}
 
 // Apply applies the rule to given file.
-func (*ConstantLogicalExprRule) Apply(file *lint.File, _ lint.Arguments) ([]lint.Failure, error) {
+func (*ConstantLogicalExprRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
 	var failures []lint.Failure
 
 	onFailure := func(failure lint.Failure) {
@@ -21,7 +21,7 @@ func (*ConstantLogicalExprRule) Apply(file *lint.File, _ lint.Arguments) ([]lint
 	astFile := file.AST
 	w := &lintConstantLogicalExpr{astFile, onFailure}
 	ast.Walk(w, astFile)
-	return failures, nil
+	return failures
 }
 
 // Name returns the rule name.

diff --git a/rule/context_as_argument.go b/rule/context_as_argument.go
@@ -17,12 +17,12 @@ type ContextAsArgumentRule struct {
 }
 
 // Apply applies the rule to given file.
-func (r *ContextAsArgumentRule) Apply(file *lint.File, arguments lint.Arguments) ([]lint.Failure, error) {
+func (r *ContextAsArgumentRule) Apply(file *lint.File, arguments lint.Arguments) []lint.Failure {
 	var configureErr error
 	r.configureOnce.Do(func() { configureErr = r.configure(arguments) })
 
 	if configureErr != nil {
-		return nil, configureErr
+		return []lint.Failure{lint.NewInternalFailure(configureErr.Error())}
 	}
 
 	var failures []lint.Failure
@@ -56,7 +56,7 @@ func (r *ContextAsArgumentRule) Apply(file *lint.File, arguments lint.Arguments)
 		}
 	}
 
-	return failures, nil
+	return failures
 }
 
 // Name returns the rule name.

diff --git a/rule/context_keys_type.go b/rule/context_keys_type.go
@@ -12,7 +12,7 @@ import (
 type ContextKeysType struct{}
 
 // Apply applies the rule to given file.
-func (*ContextKeysType) Apply(file *lint.File, _ lint.Arguments) ([]lint.Failure, error) {
+func (*ContextKeysType) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
 	var failures []lint.Failure
 
 	fileAst := file.AST
@@ -27,7 +27,7 @@ func (*ContextKeysType) Apply(file *lint.File, _ lint.Arguments) ([]lint.Failure
 	file.Pkg.TypeCheck()
 	ast.Walk(walker, fileAst)
 
-	return failures, nil
+	return failures
 }
 
 // Name returns the rule name.

diff --git a/rule/cyclomatic.go b/rule/cyclomatic.go
@@ -35,12 +35,12 @@ func (r *CyclomaticRule) configure(arguments lint.Arguments) error {
 }
 
 // Apply applies the rule to given file.
-func (r *CyclomaticRule) Apply(file *lint.File, arguments lint.Arguments) ([]lint.Failure, error) {
+func (r *CyclomaticRule) Apply(file *lint.File, arguments lint.Arguments) []lint.Failure {
 	var configureErr error
 	r.configureOnce.Do(func() { configureErr = r.configure(arguments) })
 
 	if configureErr != nil {
-		return nil, configureErr
+		return []lint.Failure{lint.NewInternalFailure(configureErr.Error())}
 	}
 
 	var failures []lint.Failure
@@ -62,7 +62,7 @@ func (r *CyclomaticRule) Apply(file *lint.File, arguments lint.Arguments) ([]lin
 		}
 	}
 
-	return failures, nil
+	return failures
 }
 
 // Name returns the rule name.

diff --git a/rule/datarace.go b/rule/datarace.go
@@ -11,7 +11,7 @@ import (
 type DataRaceRule struct{}
 
 // Apply applies the rule to given file.
-func (r *DataRaceRule) Apply(file *lint.File, _ lint.Arguments) ([]lint.Failure, error) {
+func (r *DataRaceRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
 	isGo122 := file.Pkg.IsAtLeastGo122()
 	var failures []lint.Failure
 	for _, decl := range file.AST.Decls {
@@ -41,7 +41,7 @@ func (r *DataRaceRule) Apply(file *lint.File, _ lint.Arguments) ([]lint.Failure,
 		ast.Walk(fl, funcDecl.Body)
 	}
 
-	return failures, nil
+	return failures
 }
 
 // Name returns the rule name.