fix: enforce comment spaces

Mateus Oliveira · Mateus Oliveira · commit 600606405cc4 · 2024-05-27T13:53:48.000-03:00
Signed-off-by: Mateus Oliveira &lt;msouzaol@redhat.com&gt;
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

Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,7 @@ linters-settings:`
`61`	`61`	`#`
`62`	`62`	`- name: bool-literal-in-expr`
`63`	`63`	`- name: constant-logical-expr`
	`64`	`+ - name: comment-spacings`
`64`	`65`
`65`	`66`	`linters:`
`66`	`67`	`disable-all: true`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ var alphaCommands = []*cobra.Command{`
`35`	`35`
`36`	`36`	`func newAlphaCommand() *cobra.Command {`
`37`	`37`	`cmd := &cobra.Command{`
`38`		`- //TODO: If we need to create alpha commands please add a new file for each command`
	`38`	`+ // TODO: If we need to create alpha commands please add a new file for each command`
`39`	`39`	`}`
`40`	`40`	`return cmd`
`41`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -330,7 +330,7 @@ func copyFile(src, des string) error {`
`330`	`330`	`if err != nil {`
`331`	`331`	`return fmt.Errorf("Source file path: %s does not exist. %v", src, err)`
`332`	`332`	`}`
`333`		`- //Copy all the contents to the desitination file`
	`333`	`+ // Copy all the contents to the desitination file`
`334`	`334`	`// nolint:gosec`
`335`	`335`	`return os.WriteFile(des, bytesRead, 0755)`
`336`	`336`	`}`