Merge pull request #403 from sapcc/add_revive_option

add option to enable revive in golangci_lint

Author: majewsky

.golangci.yaml

@@ -172,13 +172,13 @@ linters:
   exclusions:
     generated: lax
     presets:
-      - comments
       - common-false-positives
       - legacy
       - std-error-handling
     rules:
       - linters:
           - bodyclose
+          - revive
         path: _test\.go
       # It is idiomatic Go to reuse the name 'err' with ':=' for subsequent errors.
       # Ref: https://go.dev/doc/effective_go#redeclaration

README.md

@@ -252,6 +252,11 @@ golangciLint:
   skipDirs:
     - easypg/migrate/*
   timeout: 3m
+  reviveRules:
+    - name: exported
+      arguments:
+        - checkPrivateReceivers
+        - disableChecksOnConstants
 ```
 
 The `make check` and `make static-check` targets use [`golangci-lint`](https://golangci-lint.run) to lint your code.
@@ -267,6 +272,12 @@ for function signatures that `errcheck` accepts.
 
 `timeout` changes the `run.timeout` option. This should only be necessary to bump when in big projects like ones that use Kubernetes.
 
+`reviveRules` can be specified to activate the [revive](https://github.com/mgechev/revive) linter with only the mentioned rules.
+A rule must have a `name` and can optionally have `arguments`, which specify how the rule behaves.
+In the snippet above, the [exported](https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#exported)-rule is configured.
+It enforces comments on exported functions and types.
+If no `reviveRules` are specified, `revive` is not configured to be used.
+
 Take a look at `go-makefile-maker`'s own [`golangci-lint` config file](./.golangci.yaml) for an up-to-date example of what the generated config would look like.
 
 ### `goReleaser`

internal/core/config.go

@@ -105,12 +105,18 @@ type GolangConfiguration struct {
 	SetGoModVersion      bool                  `yaml:"setGoModVersion"`
 }
 
+type ReviveRule struct {
+	Name      string   `yaml:"name"`
+	Arguments []string `yaml:"arguments"`
+}
+
 // GolangciLintConfiguration appears in type Configuration.
 type GolangciLintConfiguration struct {
 	CreateConfig     bool          `yaml:"createConfig"`
 	ErrcheckExcludes []string      `yaml:"errcheckExcludes"`
 	SkipDirs         []string      `yaml:"skipDirs"`
 	Timeout          time.Duration `yaml:"timeout"`
+	ReviveRules      []ReviveRule  `yaml:"reviveRules"`
 }
 
 type GoReleaserConfiguration struct {

internal/golangcilint/golangci.yaml.tmpl

@@ -64,6 +64,9 @@ linters:
     - perfsprint
     - predeclared
     - rowserrcheck
+    {{- if .ReviveRules }}
+    - revive
+    {{- end }}
     - sqlclosecheck
     - staticcheck
     - unconvert
@@ -161,6 +164,19 @@ linters:
     perfsprint:
       # modernize generates nicer fix code
       concat-loop: false
+    {{- if .ReviveRules }}
+    revive:
+      rules:
+        {{- range .ReviveRules }}
+        - name: {{ .Name }}
+          {{- if .Arguments }}
+          arguments:
+            {{- range .Arguments }}
+            - {{ . }}
+            {{- end }}
+          {{- end }}
+        {{- end }}
+    {{- end }}
     staticcheck:
       dot-import-whitelist:
         - github.com/majewsky/gg/option
@@ -185,13 +201,13 @@ linters:
   exclusions:
     generated: lax
     presets:
-      - comments
       - common-false-positives
       - legacy
       - std-error-handling
     rules:
       - linters:
           - bodyclose
+          - revive
         path: _test\.go
       # It is idiomatic Go to reuse the name 'err' with ':=' for subsequent errors.
       # Ref: https://go.dev/doc/effective_go#redeclaration

internal/golangcilint/golangci_lint.go

@@ -35,5 +35,6 @@ func RenderConfig(cfg core.Configuration, sr golang.ScanResult) {
 		"ErrcheckExcludes":    cfg.GolangciLint.ErrcheckExcludes,
 		"SkipDirs":            cfg.GolangciLint.SkipDirs,
 		"Timeout":             timeout,
+		"ReviveRules":         cfg.GolangciLint.ReviveRules,
 	}))
 }