🌱 fix: remove unused nolint comments (#4468)

fix: remove unused nolint comments

Signed-off-by: Mateus Oliveira <[email protected]>

Author: Mateus Oliveira

.golangci.yml

@@ -22,6 +22,8 @@ linters-settings:
     disable:
       - fieldalignment
       - shadow
+  nolintlint:
+    allow-unused: false
   revive:
     rules:
       # The following rules are recommended https://github.com/mgechev/revive#recommended-configuration
@@ -78,6 +80,7 @@ linters:
     - ineffassign
     - lll
     - misspell
+    - nolintlint
     - nakedret
     - prealloc
     - revive

cmd/main.go

@@ -25,8 +25,6 @@ import (
 	"sigs.k8s.io/kubebuilder/v4/pkg/plugin"
 	kustomizecommonv2 "sigs.k8s.io/kubebuilder/v4/pkg/plugins/common/kustomize/v2"
 	"sigs.k8s.io/kubebuilder/v4/pkg/plugins/golang"
-
-	//nolint:staticcheck
 	deployimagev1alpha1 "sigs.k8s.io/kubebuilder/v4/pkg/plugins/golang/deploy-image/v1alpha1"
 	golangv4 "sigs.k8s.io/kubebuilder/v4/pkg/plugins/golang/v4"
 	grafanav1alpha1 "sigs.k8s.io/kubebuilder/v4/pkg/plugins/optional/grafana/v1alpha"

pkg/cli/api.go

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package cli //nolint:dupl
+package cli
 
 import (
 	"fmt"

pkg/cli/cli_test.go

@@ -60,7 +60,6 @@ func setBoolFlag(flag string) {
 	os.Args = append(os.Args, "subcommand", "--"+flag)
 }
 
-// nolint:unparam
 func setProjectVersionFlag(value string) {
 	setFlag(projectVersionFlag, value)
 }

pkg/cli/cmd_helpers.go

@@ -285,7 +285,7 @@ func (factory *executionHooksFactory) preRunEFunc(
 		}
 
 		// Pre-scaffold hook.
-		// nolint:revive
+		//nolint:revive
 		if err := factory.forEach(func(subcommand plugin.Subcommand) error {
 			if subcommand, hasPreScaffold := subcommand.(plugin.HasPreScaffold); hasPreScaffold {
 				return subcommand.PreScaffold(factory.fs)
@@ -303,7 +303,7 @@ func (factory *executionHooksFactory) preRunEFunc(
 func (factory *executionHooksFactory) runEFunc() func(*cobra.Command, []string) error {
 	return func(*cobra.Command, []string) error {
 		// Scaffold hook.
-		// nolint:revive
+		//nolint:revive
 		if err := factory.forEach(func(subcommand plugin.Subcommand) error {
 			return subcommand.Scaffold(factory.fs)
 		}, "unable to scaffold with"); err != nil {
@@ -323,7 +323,7 @@ func (factory *executionHooksFactory) postRunEFunc() func(*cobra.Command, []stri
 		}
 
 		// Post-scaffold hook.
-		// nolint:revive
+		//nolint:revive
 		if err := factory.forEach(func(subcommand plugin.Subcommand) error {
 			if subcommand, hasPostScaffold := subcommand.(plugin.HasPostScaffold); hasPostScaffold {
 				return subcommand.PostScaffold()

pkg/cli/edit.go

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package cli //nolint:dupl
+package cli
 
 import (
 	"fmt"

pkg/cli/webhook.go

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package cli //nolint:dupl
+package cli
 
 import (
 	"fmt"

pkg/model/resource/resource_test.go

@@ -21,7 +21,6 @@ import (
 	. "github.com/onsi/gomega"
 )
 
-//nolint:dupl
 var _ = Describe("Resource", func() {
 	const (
 		group   = "group"

pkg/plugin/util/util.go

@@ -64,8 +64,7 @@ func GetNonEmptyLines(output string) []string {
 
 // InsertCode searches target content in the file and insert `toInsert` after the target.
 func InsertCode(filename, target, code string) error {
-	// false positive
-	// nolint:gosec
+	//nolint:gosec // false positive
 	contents, err := os.ReadFile(filename)
 	if err != nil {
 		return err
@@ -75,15 +74,13 @@ func InsertCode(filename, target, code string) error {
 		return fmt.Errorf("string %s not found in %s", target, string(contents))
 	}
 	out := string(contents[:idx+len(target)]) + code + string(contents[idx+len(target):])
-	// false positive
-	// nolint:gosec
+	//nolint:gosec // false positive
 	return os.WriteFile(filename, []byte(out), 0644)
 }
 
 // InsertCodeIfNotExist insert code if it does not already exists
 func InsertCodeIfNotExist(filename, target, code string) error {
-	// false positive
-	// nolint:gosec
+	//nolint:gosec // false positive
 	contents, err := os.ReadFile(filename)
 	if err != nil {
 		return err
@@ -130,8 +127,7 @@ func AppendCodeAtTheEnd(filename, code string) error {
 // UncommentCode searches for target in the file and remove the comment prefix
 // of the target content. The target content may span multiple lines.
 func UncommentCode(filename, target, prefix string) error {
-	// false positive
-	// nolint:gosec
+	//nolint:gosec // false positive
 	content, err := os.ReadFile(filename)
 	if err != nil {
 		return err
@@ -171,8 +167,7 @@ func UncommentCode(filename, target, prefix string) error {
 	if err != nil {
 		return err
 	}
-	// false positive
-	// nolint:gosec
+	//nolint:gosec // false positive
 	return os.WriteFile(filename, out.Bytes(), 0644)
 }
 
@@ -232,8 +227,7 @@ func ReplaceInFile(path, oldValue, newValue string) error {
 	if err != nil {
 		return err
 	}
-	// false positive
-	// nolint:gosec
+	//nolint:gosec // false positive
 	b, err := os.ReadFile(path)
 	if err != nil {
 		return err
@@ -260,8 +254,7 @@ func ReplaceRegexInFile(path, match, replace string) error {
 	if err != nil {
 		return err
 	}
-	// false positive
-	// nolint:gosec
+	//nolint:gosec // false positive
 	b, err := os.ReadFile(path)
 	if err != nil {
 		return err
@@ -279,7 +272,7 @@ func ReplaceRegexInFile(path, match, replace string) error {
 
 // HasFileContentWith check if given `text` can be found in file
 func HasFileContentWith(path, text string) (bool, error) {
-	// nolint:gosec
+	//nolint:gosec
 	contents, err := os.ReadFile(path)
 	if err != nil {
 		return false, err

pkg/plugins/common/kustomize/v2/scaffolds/api.go

@@ -91,7 +91,7 @@ func (s *apiScaffolder) Scaffold() error {
 			}
 		}
 
-		// nolint:goconst
+		//nolint:goconst
 		kustomizeFilePath := "config/default/kustomization.yaml"
 		err := pluginutil.UncommentCode(kustomizeFilePath, "#- ../crd", `#`)
 		if err != nil {