grouper: improve docs

Author: leonklingele

.golangci.example.yml

@@ -560,18 +560,33 @@ linters-settings:
     disable-all: false
 
   grouper:
-    # const
-    const-require-single-const: false
-    const-require-grouping: false
-    # import
-    import-require-single-import: false
-    import-require-grouping: false
-    # type
-    type-require-single-type: false
-    type-require-grouping: false
-    # var
-    var-require-single-var: false
-    var-require-grouping: false
+    # Require the use of a single global 'const' declaration only.
+    # Default: false
+    const-require-single-const: true
+    # Require the use of grouped global 'const' declarations.
+    # Default: false
+    const-require-grouping: true
+
+    # Require the use of a single 'import' declaration only.
+    # Default: false
+    import-require-single-import: true
+    # Require the use of grouped 'import' declarations.
+    # Default: false
+    import-require-grouping: true
+
+    # Require the use of a single global 'type' declaration only.
+    # Default: false
+    type-require-single-type: true
+    # Require the use of grouped global 'type' declarations.
+    # Default: false
+    type-require-grouping: true
+
+    # Require the use of a single global 'var' declaration only.
+    # Default: false
+    var-require-single-var: true
+    # Require the use of grouped global 'var' declarations.
+    # Default: false
+    var-require-grouping: true
 
   ifshort:
     # Maximum length of variable declaration measured in number of lines, after which linter won't suggest using short syntax.

pkg/config/linters_settings.go

@@ -378,16 +378,16 @@ func (cfg GovetSettings) Validate() error {
 }
 
 type GrouperSettings struct {
-	// const
+	// const analyzer options
 	ConstRequireSingleConst bool `mapstructure:"const-require-single-const"`
 	ConstRequireGrouping    bool `mapstructure:"const-require-grouping"`
-	// import
+	// import analyzer options
 	ImportRequireSingleImport bool `mapstructure:"import-require-single-import"`
 	ImportRequireGrouping     bool `mapstructure:"import-require-grouping"`
-	// type
+	// type analyzer options
 	TypeRequireSingleType bool `mapstructure:"type-require-single-type"`
 	TypeRequireGrouping   bool `mapstructure:"type-require-grouping"`
-	// var
+	// var analyzer options
 	VarRequireSingleVar bool `mapstructure:"var-require-single-var"`
 	VarRequireGrouping  bool `mapstructure:"var-require-grouping"`
 }

pkg/golinters/grouper.go

@@ -13,16 +13,16 @@ func NewGrouper(settings *config.GrouperSettings) *goanalysis.Linter {
 	linterCfg := map[string]map[string]interface{}{}
 	if settings != nil {
 		linterCfg["grouper"] = map[string]interface{}{
-			// const
+			// const analyzer options
 			"const-require-single-const": settings.ConstRequireSingleConst,
 			"const-require-grouping":     settings.ConstRequireGrouping,
-			// import
+			// import analyzer options
 			"import-require-single-import": settings.ImportRequireSingleImport,
 			"import-require-grouping":      settings.ImportRequireGrouping,
-			// type
+			// type analyzer options
 			"type-require-single-type": settings.TypeRequireSingleType,
 			"type-require-grouping":    settings.TypeRequireGrouping,
-			// var
+			// var analyzer options
 			"var-require-single-var": settings.VarRequireSingleVar,
 			"var-require-grouping":   settings.VarRequireGrouping,
 		}