Merge pull request #3960 from mateusoliveira43/fix/enforce-comment-sp…

…aces ✨ Add revive golangci linter with comment-spacings rule
kubernetes-sigs · May 27, 2024 · 6d8b808 · 6d8b808
2 parents 32bc517 + 6006064
commit 6d8b808
Show file tree

Hide file tree

Showing 11 changed files with 51 additions and 2 deletions.
diff --git a/.golangci.yml b/.golangci.yml
@@ -61,6 +61,7 @@ linters-settings:
       #
       - name: bool-literal-in-expr
       - name: constant-logical-expr
+      - name: comment-spacings
 
 linters:
   disable-all: true

diff --git a/docs/book/src/cronjob-tutorial/testdata/project/.golangci.yml b/docs/book/src/cronjob-tutorial/testdata/project/.golangci.yml
@@ -34,8 +34,14 @@ linters:
     - misspell
     - nakedret
     - prealloc
+    - revive
     - staticcheck
     - typecheck
     - unconvert
     - unparam
     - unused
+
+linters-settings:
+  revive:
+    rules:
+      - name: comment-spacings
diff --git a/docs/book/src/getting-started/testdata/project/.golangci.yml b/docs/book/src/getting-started/testdata/project/.golangci.yml
@@ -34,8 +34,14 @@ linters:
     - misspell
     - nakedret
     - prealloc
+    - revive
     - staticcheck
     - typecheck
     - unconvert
     - unparam
     - unused
+
+linters-settings:
+  revive:
+    rules:
+      - name: comment-spacings
diff --git a/pkg/cli/alpha.go b/pkg/cli/alpha.go
@@ -35,7 +35,7 @@ var alphaCommands = []*cobra.Command{
 
 func newAlphaCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		//TODO: If we need to create alpha commands please add a new file for each command
+		// TODO: If we need to create alpha commands please add a new file for each command
 	}
 	return cmd
 }

diff --git a/pkg/plugins/golang/v4/scaffolds/internal/templates/golangci.go b/pkg/plugins/golang/v4/scaffolds/internal/templates/golangci.go
@@ -78,9 +78,15 @@ linters:
     - misspell
     - nakedret
     - prealloc
+    - revive
     - staticcheck
     - typecheck
     - unconvert
     - unparam
     - unused
+
+linters-settings:
+  revive:
+    rules:
+      - name: comment-spacings
 `
diff --git a/pkg/rescaffold/migrate.go b/pkg/rescaffold/migrate.go
@@ -330,7 +330,7 @@ func copyFile(src, des string) error {
 	if err != nil {
 		return fmt.Errorf("Source file path: %s does not exist. %v", src, err)
 	}
-	//Copy all the contents to the desitination file
+	// Copy all the contents to the desitination file
 	// nolint:gosec
 	return os.WriteFile(des, bytesRead, 0755)
 }

diff --git a/testdata/project-v4-multigroup-with-deploy-image/.golangci.yml b/testdata/project-v4-multigroup-with-deploy-image/.golangci.yml
@@ -34,8 +34,14 @@ linters:
     - misspell
     - nakedret
     - prealloc
+    - revive
     - staticcheck
     - typecheck
     - unconvert
     - unparam
     - unused
+
+linters-settings:
+  revive:
+    rules:
+      - name: comment-spacings
diff --git a/testdata/project-v4-multigroup/.golangci.yml b/testdata/project-v4-multigroup/.golangci.yml
@@ -34,8 +34,14 @@ linters:
     - misspell
     - nakedret
     - prealloc
+    - revive
     - staticcheck
     - typecheck
     - unconvert
     - unparam
     - unused
+
+linters-settings:
+  revive:
+    rules:
+      - name: comment-spacings
diff --git a/testdata/project-v4-with-deploy-image/.golangci.yml b/testdata/project-v4-with-deploy-image/.golangci.yml
@@ -34,8 +34,14 @@ linters:
     - misspell
     - nakedret
     - prealloc
+    - revive
     - staticcheck
     - typecheck
     - unconvert
     - unparam
     - unused
+
+linters-settings:
+  revive:
+    rules:
+      - name: comment-spacings
diff --git a/testdata/project-v4-with-grafana/.golangci.yml b/testdata/project-v4-with-grafana/.golangci.yml
@@ -34,8 +34,14 @@ linters:
     - misspell
     - nakedret
     - prealloc
+    - revive
     - staticcheck
     - typecheck
     - unconvert
     - unparam
     - unused
+
+linters-settings:
+  revive:
+    rules:
+      - name: comment-spacings
diff --git a/testdata/project-v4/.golangci.yml b/testdata/project-v4/.golangci.yml
@@ -34,8 +34,14 @@ linters:
     - misspell
     - nakedret
     - prealloc
+    - revive
     - staticcheck
     - typecheck
     - unconvert
     - unparam
     - unused
+
+linters-settings:
+  revive:
+    rules:
+      - name: comment-spacings