Refactoring and renaming

README.md

@@ -111,22 +111,22 @@ List of all available rules. The rules ported from `golint` are left unchanged a
 | Name                  | Config | Description                                                      | `golint` |
 | --------------------- | :----: | :--------------------------------------------------------------- | :------: |
 | `blank-imports`       |  n/a   | Disallows blank imports                                          |   yes    |
-| `context-arguments`   |  n/a   | `context.Context` should be the first argument of a function.    |   yes    |
-| `context-key-type`    |  n/a   | Disallows the usage of basic types in `context.WithValue`.       |   yes    |
+| `context-as-argument` |  n/a   | `context.Context` should be the first argument of a function.    |   yes    |
+| `context-keys-type`   |  n/a   | Disallows the usage of basic types in `context.WithValue`.       |   yes    |
 | `dot-imports`         |  n/a   | Forbids `.` imports.                                             |   yes    |
 | `error-return`        |  n/a   | The error return parameter should be last.                       |   yes    |
 | `error-strings`       |  n/a   | Conventions around error strings.                                |   yes    |
-| `errors`              |  n/a   | Naming of error variables.                                       |   yes    |
+| `error-naming`        |  n/a   | Naming of error variables.                                       |   yes    |
 | `exported`            |  n/a   | Naming and commenting conventions on exported symbols.           |   yes    |
 | `if-return`           |  n/a   | Redundant if when returning an error.                            |   yes    |
 | `increment-decrement` |  n/a   | Use `i++` and `i--` instead of `i += 1` and `i -= 1`.            |   yes    |
-| `names`               |  n/a   | Naming rules.                                                    |   yes    |
+| `var-naming`          |  n/a   | Naming rules.                                                    |   yes    |
+| `var-declaration`     |  n/a   | Reduces redundancies around variable declaration.                |   yes    |
 | `package-comments`    |  n/a   | Package commenting conventions.                                  |   yes    |
 | `range`               |  n/a   | Prevents redundant variables when iterating over a collection.   |   yes    |
-| `receiver-name`       |  n/a   | Conventions around the naming of receivers.                      |   yes    |
-| `time-name`           |  n/a   | Conventions around the naming of time variables.                 |   yes    |
-| `unexpected-return`   |  n/a   | Warns when a public return is from unexported type.              |   yes    |
-| `unexpected-return`   |  n/a   | Conventions around variable declarations.                        |   yes    |
+| `receiver-naming`     |  n/a   | Conventions around the naming of receivers.                      |   yes    |
+| `time-naming`         |  n/a   | Conventions around the naming of time variables.                 |   yes    |
+| `unexported-return`   |  n/a   | Warns when a public return is from unexported type.              |   yes    |
 | `indent-error-flow`   |  n/a   | Prevents redundant else statements.                              |   yes    |
 | `errorf`              |  n/a   | Should replace `error.New(fmt.Sprintf())` with `error.Errorf()`  |   yes    |
 | `argument-limit`      |  int   | Specifies the maximum number of arguments a function can receive |    no    |

config.go

@@ -27,25 +27,26 @@ var defaultRules = []lint.Rule{
 	&rule.DotImportsRule{},
 	&rule.BlankImportsRule{},
 	&rule.ExportedRule{},
-	&rule.NamesRule{},
+	&rule.VarNamingRule{},
 	&rule.IndentErrorFlowRule{},
 	&rule.IfReturnRule{},
 	&rule.RangeRule{},
 	&rule.ErrorfRule{},
-	&rule.ErrorsRule{},
+	&rule.ErrorNamingRule{},
 	&rule.ErrorStringsRule{},
-	&rule.ReceiverNameRule{},
+	&rule.ReceiverNamingRule{},
 	&rule.IncrementDecrementRule{},
 	&rule.ErrorReturnRule{},
 	&rule.UnexportedReturnRule{},
-	&rule.TimeNamesRule{},
-	&rule.ContextKeyTypeRule{},
-	&rule.ContextArgumentsRule{},
+	&rule.TimeNamingRule{},
+	&rule.ContextKeysType{},
+	&rule.ContextAsArgumentRule{},
 }
 
 var allRules = append([]lint.Rule{
 	&rule.ArgumentsLimitRule{},
 	&rule.CyclomaticRule{},
+	&rule.FileHeaderRule{},
 }, defaultRules...)
 
 var allFormatters = []lint.Formatter{

config.toml

@@ -2,23 +2,22 @@ ignoreGeneratedHeader = true
 severity = "warning"
 confidence = 0.8
 
-[rule.package-comments]
-[rule.else]
-[rule.names]
-  severity = "error"
-[rule.var-declaration]
-[rule.unexported-return]
-[rule.time-names]
-[rule.receiver-names]
-[rule.range]
-[rule.increment-decrement]
-[rule.if-return]
-[rule.exported]
-[rule.errors]
-[rule.errorf]
-[rule.error-strings]
-[rule.error-return]
+[rule.blank-imports]
+[rule.context-as-argument]
+[rule.context-keys-type]
 [rule.dot-imports]
-[rule.context-key-types]
-[rule.context-arguments]
-[rule.blank-imports]
+[rule.error-return]
+[rule.error-strings]
+[rule.error-naming]
+[rule.exported]
+[rule.if-return]
+[rule.increment-decrement]
+[rule.var-naming]
+[rule.var-declaration]
+[rule.package-comments]
+[rule.range]
+[rule.receiver-naming]
+[rule.time-naming]
+[rule.unexported-return]
+[rule.indent-error-flow]
+[rule.errorf]

defaults.toml

@@ -4,22 +4,22 @@ confidence = 0.8
 errorCode = 0
 warningCode = 0
 
-[rule.package-comments]
-[rule.else]
-[rule.names]
-[rule.var-declaration]
-[rule.unexported-return]
-[rule.time-names]
-[rule.receiver-names]
-[rule.range]
-[rule.increment-decrement]
-[rule.if-return]
-[rule.exported]
-[rule.errors]
-[rule.errorf]
-[rule.error-strings]
-[rule.error-return]
+[rule.blank-imports]
+[rule.context-as-argument]
+[rule.context-keys-type]
 [rule.dot-imports]
-[rule.context-key-types]
-[rule.context-arguments]
-[rule.blank-imports]
+[rule.error-return]
+[rule.error-strings]
+[rule.error-naming]
+[rule.exported]
+[rule.if-return]
+[rule.increment-decrement]
+[rule.var-naming]
+[rule.var-declaration]
+[rule.package-comments]
+[rule.range]
+[rule.receiver-naming]
+[rule.time-naming]
+[rule.unexported-return]
+[rule.indent-error-flow]
+[rule.errorf]

rule/context-as-argument.go

@@ -6,11 +6,11 @@ import (
 	"github.com/mgechev/revive/lint"
 )
 
-// ContextArgumentsRule lints given else constructs.
-type ContextArgumentsRule struct{}
+// ContextAsArgumentRule lints given else constructs.
+type ContextAsArgumentRule struct{}
 
 // Apply applies the rule to given file.
-func (r *ContextArgumentsRule) Apply(file *lint.File, arguments lint.Arguments) []lint.Failure {
+func (r *ContextAsArgumentRule) Apply(file *lint.File, arguments lint.Arguments) []lint.Failure {
 	var failures []lint.Failure
 
 	fileAst := file.AST
@@ -28,8 +28,8 @@ func (r *ContextArgumentsRule) Apply(file *lint.File, arguments lint.Arguments)
 }
 
 // Name returns the rule name.
-func (r *ContextArgumentsRule) Name() string {
-	return "context-arguments"
+func (r *ContextAsArgumentRule) Name() string {
+	return "context-as-argument"
 }
 
 type lintContextArguments struct {

rule/context-keys-type.go

@@ -8,11 +8,11 @@ import (
 	"github.com/mgechev/revive/lint"
 )
 
-// ContextKeyTypeRule lints given else constructs.
-type ContextKeyTypeRule struct{}
+// ContextKeysType lints given else constructs.
+type ContextKeysType struct{}
 
 // Apply applies the rule to given file.
-func (r *ContextKeyTypeRule) Apply(file *lint.File, arguments lint.Arguments) []lint.Failure {
+func (r *ContextKeysType) Apply(file *lint.File, arguments lint.Arguments) []lint.Failure {
 	var failures []lint.Failure
 
 	fileAst := file.AST
@@ -30,8 +30,8 @@ func (r *ContextKeyTypeRule) Apply(file *lint.File, arguments lint.Arguments) []
 }
 
 // Name returns the rule name.
-func (r *ContextKeyTypeRule) Name() string {
-	return "context-key-types"
+func (r *ContextKeysType) Name() string {
+	return "context-keys-type"
 }
 
 type lintContextKeyTypes struct {

rule/error-naming.go

@@ -9,11 +9,11 @@ import (
 	"github.com/mgechev/revive/lint"
 )
 
-// ErrorsRule lints given else constructs.
-type ErrorsRule struct{}
+// ErrorNamingRule lints given else constructs.
+type ErrorNamingRule struct{}
 
 // Apply applies the rule to given file.
-func (r *ErrorsRule) Apply(file *lint.File, arguments lint.Arguments) []lint.Failure {
+func (r *ErrorNamingRule) Apply(file *lint.File, arguments lint.Arguments) []lint.Failure {
 	var failures []lint.Failure
 
 	fileAst := file.AST
@@ -31,8 +31,8 @@ func (r *ErrorsRule) Apply(file *lint.File, arguments lint.Arguments) []lint.Fai
 }
 
 // Name returns the rule name.
-func (r *ErrorsRule) Name() string {
-	return "errors"
+func (r *ErrorNamingRule) Name() string {
+	return "error-naming"
 }
 
 type lintErrors struct {

rule/receiver-naming.go

@@ -7,11 +7,11 @@ import (
 	"github.com/mgechev/revive/lint"
 )
 
-// ReceiverNameRule lints given else constructs.
-type ReceiverNameRule struct{}
+// ReceiverNamingRule lints given else constructs.
+type ReceiverNamingRule struct{}
 
 // Apply applies the rule to given file.
-func (r *ReceiverNameRule) Apply(file *lint.File, arguments lint.Arguments) []lint.Failure {
+func (r *ReceiverNamingRule) Apply(file *lint.File, arguments lint.Arguments) []lint.Failure {
 	var failures []lint.Failure
 
 	fileAst := file.AST
@@ -28,8 +28,8 @@ func (r *ReceiverNameRule) Apply(file *lint.File, arguments lint.Arguments) []li
 }
 
 // Name returns the rule name.
-func (r *ReceiverNameRule) Name() string {
-	return "receiver-names"
+func (r *ReceiverNamingRule) Name() string {
+	return "receiver-naming"
 }
 
 type lintReceiverName struct {

rule/time-naming.go

@@ -9,11 +9,11 @@ import (
 	"github.com/mgechev/revive/lint"
 )
 
-// TimeNamesRule lints given else constructs.
-type TimeNamesRule struct{}
+// TimeNamingRule lints given else constructs.
+type TimeNamingRule struct{}
 
 // Apply applies the rule to given file.
-func (r *TimeNamesRule) Apply(file *lint.File, arguments lint.Arguments) []lint.Failure {
+func (r *TimeNamingRule) Apply(file *lint.File, arguments lint.Arguments) []lint.Failure {
 	var failures []lint.Failure
 
 	onFailure := func(failure lint.Failure) {
@@ -26,8 +26,8 @@ func (r *TimeNamesRule) Apply(file *lint.File, arguments lint.Arguments) []lint.
 }
 
 // Name returns the rule name.
-func (r *TimeNamesRule) Name() string {
-	return "time-names"
+func (r *TimeNamingRule) Name() string {
+	return "time-naming"
 }
 
 type lintTimeNames struct {

rule/var-naming.go

@@ -9,11 +9,11 @@ import (
 	"github.com/mgechev/revive/lint"
 )
 
-// NamesRule lints given else constructs.
-type NamesRule struct{}
+// VarNamingRule lints given else constructs.
+type VarNamingRule struct{}
 
 // Apply applies the rule to given file.
-func (r *NamesRule) Apply(file *lint.File, arguments lint.Arguments) []lint.Failure {
+func (r *VarNamingRule) Apply(file *lint.File, arguments lint.Arguments) []lint.Failure {
 	var failures []lint.Failure
 
 	if isTest(file) {
@@ -46,8 +46,8 @@ func (r *NamesRule) Apply(file *lint.File, arguments lint.Arguments) []lint.Fail
 }
 
 // Name returns the rule name.
-func (r *NamesRule) Name() string {
-	return "names"
+func (r *VarNamingRule) Name() string {
+	return "var-naming"
 }
 
 func checkList(fl *ast.FieldList, thing string, w *lintNames) {

test/golint_test.go

@@ -20,20 +20,20 @@ var rules = []lint.Rule{
 	&rule.DotImportsRule{},
 	&rule.BlankImportsRule{},
 	&rule.ExportedRule{},
-	&rule.NamesRule{},
+	&rule.VarNamingRule{},
 	&rule.IndentErrorFlowRule{},
 	&rule.IfReturnRule{},
 	&rule.RangeRule{},
 	&rule.ErrorfRule{},
-	&rule.ErrorsRule{},
+	&rule.ErrorNamingRule{},
 	&rule.ErrorStringsRule{},
-	&rule.ReceiverNameRule{},
+	&rule.ReceiverNamingRule{},
 	&rule.IncrementDecrementRule{},
 	&rule.ErrorReturnRule{},
 	&rule.UnexportedReturnRule{},
-	&rule.TimeNamesRule{},
-	&rule.ContextKeyTypeRule{},
-	&rule.ContextArgumentsRule{},
+	&rule.TimeNamingRule{},
+	&rule.ContextKeysType{},
+	&rule.ContextAsArgumentRule{},
 }
 
 func TestAll(t *testing.T) {