Lint cleanup (mgechev#679)

Signed-off-by: subham sarkar <[email protected]>
DeepSourceCorp · Aug 5, 2022 · 35b3364 · 35b3364
1 parent 7b8e012
commit 35b3364
Show file tree

Hide file tree

Showing 83 changed files with 203 additions and 233 deletions.
diff --git a/config/config.go b/config/config.go
@@ -122,7 +122,7 @@ func GetLintingRules(config *lint.Config, extraRules []lint.Rule) ([]lint.Rule,
 
 	var lintingRules []lint.Rule
 	for name, ruleConfig := range config.Rules {
-		rule, ok := rulesMap[name]
+		r, ok := rulesMap[name]
 		if !ok {
 			return nil, fmt.Errorf("cannot find rule: %s", name)
 		}
@@ -131,7 +131,7 @@ func GetLintingRules(config *lint.Config, extraRules []lint.Rule) ([]lint.Rule,
 			continue // skip disabled rules
 		}
 
-		lintingRules = append(lintingRules, rule)
+		lintingRules = append(lintingRules, r)
 	}
 
 	return lintingRules, nil
@@ -155,8 +155,8 @@ func normalizeConfig(config *lint.Config) {
 	}
 	if config.EnableAllRules {
 		// Add to the configuration all rules not yet present in it
-		for _, rule := range allRules {
-			ruleName := rule.Name()
+		for _, r := range allRules {
+			ruleName := r.Name()
 			_, alreadyInConf := config.Rules[ruleName]
 			if alreadyInConf {
 				continue
@@ -207,15 +207,15 @@ func GetConfig(configPath string) (*lint.Config, error) {
 // GetFormatter yields the formatter for lint failures
 func GetFormatter(formatterName string) (lint.Formatter, error) {
 	formatters := getFormatters()
-	formatter := formatters["default"]
+	fmtr := formatters["default"]
 	if formatterName != "" {
 		f, ok := formatters[formatterName]
 		if !ok {
 			return nil, fmt.Errorf("unknown formatter %v", formatterName)
 		}
-		formatter = f
+		fmtr = f
 	}
-	return formatter, nil
+	return fmtr, nil
 }
 
 func defaultConfig() *lint.Config {

diff --git a/formatter/checkstyle.go b/formatter/checkstyle.go
@@ -15,7 +15,7 @@ type Checkstyle struct {
 }
 
 // Name returns the name of the formatter
-func (f *Checkstyle) Name() string {
+func (*Checkstyle) Name() string {
 	return "checkstyle"
 }
 
@@ -29,7 +29,7 @@ type issue struct {
 }
 
 // Format formats the failures gotten from the lint.
-func (f *Checkstyle) Format(failures <-chan lint.Failure, config lint.Config) (string, error) {
+func (*Checkstyle) Format(failures <-chan lint.Failure, config lint.Config) (string, error) {
 	issues := map[string][]issue{}
 	for failure := range failures {
 		buf := new(bytes.Buffer)

diff --git a/formatter/default.go b/formatter/default.go
@@ -13,12 +13,12 @@ type Default struct {
 }
 
 // Name returns the name of the formatter
-func (f *Default) Name() string {
+func (*Default) Name() string {
 	return "default"
 }
 
 // Format formats the failures gotten from the lint.
-func (f *Default) Format(failures <-chan lint.Failure, _ lint.Config) (string, error) {
+func (*Default) Format(failures <-chan lint.Failure, _ lint.Config) (string, error) {
 	for failure := range failures {
 		fmt.Printf("%v: %s\n", failure.Position.Start, failure.Failure)
 	}

diff --git a/formatter/friendly.go b/formatter/friendly.go
@@ -10,16 +10,6 @@ import (
 	"github.com/olekukonko/tablewriter"
 )
 
-var newLines = map[rune]bool{
-	0x000A: true,
-	0x000B: true,
-	0x000C: true,
-	0x000D: true,
-	0x0085: true,
-	0x2028: true,
-	0x2029: true,
-}
-
 func getErrorEmoji() string {
 	return color.RedString("✘")
 }
@@ -35,7 +25,7 @@ type Friendly struct {
 }
 
 // Name returns the name of the formatter
-func (f *Friendly) Name() string {
+func (*Friendly) Name() string {
 	return "friendly"
 }
 
@@ -78,7 +68,7 @@ func (f *Friendly) printHeaderRow(failure lint.Failure, severity lint.Severity)
 	fmt.Print(f.table([][]string{{emoji, "https://revive.run/r#" + failure.RuleName, color.GreenString(failure.Failure)}}))
 }
 
-func (f *Friendly) printFilePosition(failure lint.Failure) {
+func (*Friendly) printFilePosition(failure lint.Failure) {
 	fmt.Printf("  %s:%d:%d", failure.GetFilename(), failure.Position.Start.Line, failure.Position.Start.Column)
 }
 
@@ -87,7 +77,7 @@ type statEntry struct {
 	failures int
 }
 
-func (f *Friendly) printSummary(errors, warnings int) {
+func (*Friendly) printSummary(errors, warnings int) {
 	emoji := getWarningEmoji()
 	if errors > 0 {
 		emoji = getErrorEmoji()
@@ -136,7 +126,7 @@ func (f *Friendly) printStatistics(header string, stats map[string]int) {
 	fmt.Println(f.table(formatted))
 }
 
-func (f *Friendly) table(rows [][]string) string {
+func (*Friendly) table(rows [][]string) string {
 	buf := new(bytes.Buffer)
 	table := tablewriter.NewWriter(buf)
 	table.SetBorder(false)

diff --git a/formatter/json.go b/formatter/json.go
@@ -13,7 +13,7 @@ type JSON struct {
 }
 
 // Name returns the name of the formatter
-func (f *JSON) Name() string {
+func (*JSON) Name() string {
 	return "json"
 }
 
@@ -24,7 +24,7 @@ type jsonObject struct {
 }
 
 // Format formats the failures gotten from the lint.
-func (f *JSON) Format(failures <-chan lint.Failure, config lint.Config) (string, error) {
+func (*JSON) Format(failures <-chan lint.Failure, config lint.Config) (string, error) {
 	var slice []jsonObject
 	for failure := range failures {
 		obj := jsonObject{}

diff --git a/formatter/ndjson.go b/formatter/ndjson.go
@@ -14,12 +14,12 @@ type NDJSON struct {
 }
 
 // Name returns the name of the formatter
-func (f *NDJSON) Name() string {
+func (*NDJSON) Name() string {
 	return "ndjson"
 }
 
 // Format formats the failures gotten from the lint.
-func (f *NDJSON) Format(failures <-chan lint.Failure, config lint.Config) (string, error) {
+func (*NDJSON) Format(failures <-chan lint.Failure, config lint.Config) (string, error) {
 	enc := json.NewEncoder(os.Stdout)
 	for failure := range failures {
 		obj := jsonObject{}

diff --git a/formatter/plain.go b/formatter/plain.go
@@ -13,12 +13,12 @@ type Plain struct {
 }
 
 // Name returns the name of the formatter
-func (f *Plain) Name() string {
+func (*Plain) Name() string {
 	return "plain"
 }
 
 // Format formats the failures gotten from the lint.
-func (f *Plain) Format(failures <-chan lint.Failure, _ lint.Config) (string, error) {
+func (*Plain) Format(failures <-chan lint.Failure, _ lint.Config) (string, error) {
 	for failure := range failures {
 		fmt.Printf("%v: %s %s\n", failure.Position.Start, failure.Failure, "https://revive.run/r#"+failure.RuleName)
 	}

diff --git a/formatter/sarif.go b/formatter/sarif.go
@@ -16,14 +16,14 @@ type Sarif struct {
 }
 
 // Name returns the name of the formatter
-func (f *Sarif) Name() string {
+func (*Sarif) Name() string {
 	return "sarif"
 }
 
 const reviveSite = "https://revive.run"
 
 // Format formats the failures gotten from the lint.
-func (f *Sarif) Format(failures <-chan lint.Failure, cfg lint.Config) (string, error) {
+func (*Sarif) Format(failures <-chan lint.Failure, cfg lint.Config) (string, error) {
 	sarifLog := newReviveRunLog(cfg)
 
 	for failure := range failures {

diff --git a/formatter/stylish.go b/formatter/stylish.go
@@ -16,7 +16,7 @@ type Stylish struct {
 }
 
 // Name returns the name of the formatter
-func (f *Stylish) Name() string {
+func (*Stylish) Name() string {
 	return "stylish"
 }
 
@@ -32,7 +32,7 @@ func formatFailure(failure lint.Failure, severity lint.Severity) []string {
 }
 
 // Format formats the failures gotten from the lint.
-func (f *Stylish) Format(failures <-chan lint.Failure, config lint.Config) (string, error) {
+func (*Stylish) Format(failures <-chan lint.Failure, config lint.Config) (string, error) {
 	var result [][]string
 	totalErrors := 0
 	total := 0

diff --git a/formatter/unix.go b/formatter/unix.go
@@ -14,12 +14,12 @@ type Unix struct {
 }
 
 // Name returns the name of the formatter
-func (f *Unix) Name() string {
+func (*Unix) Name() string {
 	return "unix"
 }
 
 // Format formats the failures gotten from the lint.
-func (f *Unix) Format(failures <-chan lint.Failure, _ lint.Config) (string, error) {
+func (*Unix) Format(failures <-chan lint.Failure, _ lint.Config) (string, error) {
 	for failure := range failures {
 		fmt.Printf("%v: [%s] %s\n", failure.Position.Start, failure.RuleName, failure.Failure)
 	}

diff --git a/lint/file.go b/lint/file.go
@@ -259,7 +259,7 @@ func (f *File) disabledIntervals(rules []Rule, mustSpecifyDisableReason bool, fa
 	return getEnabledDisabledIntervals()
 }
 
-func (f *File) filterFailures(failures []Failure, disabledIntervals disabledIntervalsMap) []Failure {
+func (File) filterFailures(failures []Failure, disabledIntervals disabledIntervalsMap) []Failure {
 	result := []Failure{}
 	for _, failure := range failures {
 		fStart := failure.Position.Start.Line

diff --git a/lint/linter.go b/lint/linter.go
@@ -140,7 +140,7 @@ func addInvalidFileFailure(filename, errStr string, failures chan Failure) {
 // errPosRegexp matches with an NewFile error message
 // i.e. :  corrupted.go:10:4: expected '}', found 'EOF
 // first group matches the line and the second group, the column
-var errPosRegexp = regexp.MustCompile(".*:(\\d*):(\\d*):.*$")
+var errPosRegexp = regexp.MustCompile(`.*:(\d*):(\d*):.*$`)
 
 // getPositionInvalidFile gets the position of the error in an invalid file
 func getPositionInvalidFile(filename, s string) FailurePosition {

diff --git a/revivelib/core.go b/revivelib/core.go
@@ -28,7 +28,7 @@ func New(
 	maxOpenFiles int,
 	extraRules ...ExtraRule,
 ) (*Revive, error) {
-	log, err := logging.GetLogger()
+	logger, err := logging.GetLogger()
 	if err != nil {
 		return nil, errors.Wrap(err, "initializing revive - getting logger")
 	}
@@ -55,10 +55,10 @@ func New(
 		return nil, errors.Wrap(err, "initializing revive - gettint lint rules")
 	}
 
-	log.Println("Config loaded")
+	logger.Println("Config loaded")
 
 	return &Revive{
-		logger:       log,
+		logger:       logger,
 		config:       conf,
 		lintingRules: lintingRules,
 		maxOpenFiles: maxOpenFiles,

diff --git a/revivelib/core_internal_test.go b/revivelib/core_internal_test.go
@@ -39,11 +39,11 @@ func TestReviveCreateInstance(t *testing.T) {
 type mockRule struct {
 }
 
-func (r *mockRule) Name() string {
+func (*mockRule) Name() string {
 	return "mock-rule"
 }
 
-func (r *mockRule) Apply(file *lint.File, arguments lint.Arguments) []lint.Failure {
+func (*mockRule) Apply(file *lint.File, arguments lint.Arguments) []lint.Failure {
 	return nil
 }
 

diff --git a/rule/add-constant.go b/rule/add-constant.go
@@ -55,7 +55,7 @@ func (r *AddConstantRule) Apply(file *lint.File, arguments lint.Arguments) []lin
 }
 
 // Name returns the rule name.
-func (r *AddConstantRule) Name() string {
+func (*AddConstantRule) Name() string {
 	return "add-constant"
 }
 

diff --git a/rule/argument-limit.go b/rule/argument-limit.go
@@ -48,7 +48,7 @@ func (r *ArgumentsLimitRule) Apply(file *lint.File, arguments lint.Arguments) []
 }
 
 // Name returns the rule name.
-func (r *ArgumentsLimitRule) Name() string {
+func (*ArgumentsLimitRule) Name() string {
 	return "argument-limit"
 }
 

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 (r *AtomicRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
+func (*AtomicRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
 	var failures []lint.Failure
 	walker := atomic{
 		pkgTypesInfo: file.Pkg.TypesInfo(),
@@ -27,7 +27,7 @@ func (r *AtomicRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
 }
 
 // Name returns the rule name.
-func (r *AtomicRule) Name() string {
+func (*AtomicRule) Name() string {
 	return "atomic"
 }
 

diff --git a/rule/banned-characters.go b/rule/banned-characters.go
@@ -45,7 +45,7 @@ func (r *BannedCharsRule) Apply(file *lint.File, arguments lint.Arguments) []lin
 }
 
 // Name returns the rule name
-func (r *BannedCharsRule) Name() string {
+func (*BannedCharsRule) Name() string {
 	return bannedCharsRuleName
 }
 

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 (r *BareReturnRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
+func (*BareReturnRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
 	var failures []lint.Failure
 
 	onFailure := func(failure lint.Failure) {
@@ -23,7 +23,7 @@ func (r *BareReturnRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure
 }
 
 // Name returns the rule name.
-func (r *BareReturnRule) Name() string {
+func (*BareReturnRule) Name() string {
 	return "bare-return"
 }
 

diff --git a/rule/blank-imports.go b/rule/blank-imports.go
@@ -11,7 +11,7 @@ import (
 type BlankImportsRule struct{}
 
 // Name returns the rule name.
-func (r *BlankImportsRule) Name() string {
+func (*BlankImportsRule) Name() string {
 	return "blank-imports"
 }
 
@@ -62,7 +62,7 @@ func (r *BlankImportsRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failu
 	return failures
 }
 
-func (r *BlankImportsRule) fileHasValidEmbedComment(fileAst *ast.File) bool {
+func (*BlankImportsRule) fileHasValidEmbedComment(fileAst *ast.File) bool {
 	for _, commentGroup := range fileAst.Comments {
 		for _, comment := range commentGroup.List {
 			if strings.HasPrefix(comment.Text, "//go:embed ") {

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 (r *BoolLiteralRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
+func (*BoolLiteralRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
 	var failures []lint.Failure
 
 	onFailure := func(failure lint.Failure) {
@@ -26,7 +26,7 @@ func (r *BoolLiteralRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failur
 }
 
 // Name returns the rule name.
-func (r *BoolLiteralRule) Name() string {
+func (*BoolLiteralRule) Name() string {
 	return "bool-literal-in-expr"
 }