updated the comments and golang ci lint

Signed-off-by: Gergely Brautigam <182850+Skarlso@users.noreply.github.com>

Author: Skarlso

.golangci.yaml

@@ -1,12 +1,14 @@
+version: "2"
+
 run:
-  go: "1.23"
+  go: "1.24"
   timeout: 10m
   tests: false
   allow-parallel-runners: true
   issues-exit-code: 2
 
 linters:
-  enable-all: true
+  default: all
   disable:
     - bodyclose
     - containedctx     # Struct should not contain context, action does.
@@ -15,18 +17,13 @@ linters:
     - depguard
     - dogsled
     - dupl             # Check code duplications.
-    - execinquery
     - exhaustive       # Doesn't really make sense.
     - exhaustruct      # Doesn't really make sense.
-    - exportloopref
     - forcetypeassert  # Priority: that can lead to serious crashes.
     - funlen           # Break long functions.
-    - gci
     - gochecknoglobals
     - gochecknoinits   # Init functions cause an import to have side effects,
     - err113
-    - goimports        # acts weirdly, dci handles imports anyway
-    - gomnd            # Give constant values a name with constants.
     - interfacebloat
     - ireturn          # Accept interface, return concrate.
     - lll
@@ -45,75 +42,35 @@ linters:
     - wrapcheck
     - wsl
 
-linters-settings:
-  gci:
-    sections:
-      - standard
-      - blank
-      - dot
-      - default
-      - prefix(github.com/open-component-model/ocm)
-    custom-order: true
-  funlen:
-    lines: 110
-    statements: 60
-  cyclop:
-    max-complexity: 60
-    skip-tests: true
-  gocognit:
-    min-complexity: 60
-  nolintlint:
-    allow-unused: false
-    require-explanation: true
-    require-specific: false
-  varnamelen:
-    ignore-names:
-    - err
-    - wg
-    - id
-  lll:
-    line-length: 120
-  gosec:
-    exclude-generated: true
+  settings:
+    funlen:
+      lines: 110
+      statements: 60
+    cyclop:
+      max-complexity: 60
+    gocognit:
+      min-complexity: 60
+    nolintlint:
+      allow-unused: false
+      require-explanation: true
+      require-specific: false
+    varnamelen:
+      ignore-names:
+      - err
+      - wg
+      - id
+    revive:
+      rules:
+        - name: package-comments
+          disabled: true
+        - name: exported
+          disabled: true
+
+    lll:
+      line-length: 120
 
-issues:
-  exclude-files:
-    - v1beta1/types_jsonschema.go
-    - v1beta1/marshal.go
-    - v1beta1/marshal_test.go
-  exclude:
-    - composites
-  exclude-rules:
-    - path: cmds/
-      linters:
-      - forbidigo
-    - source: "https://"
-      linters:
-      - lll
-    - text: "shadow: declaration of \"err\""
-      linters:
-        - govet
-    - text: "shadow: declaration of \"ok\""
-      linters:
-        - govet
-    - path: _test\.go
-      linters:
-      - gocyclo
-      - errcheck
-      - gosec
-      - dupl
-      - funlen
-      - scopelint
-    - text: "Spec.DeepCopyInto undefined"
-      linters:
-      - typecheck
-    - text: "G601: Implicit memory aliasing in for loop"
-      # Ignored cos why not, that was the request.
-      linters:
-      - gosec
-    - source: "// .* #\\d+"
-      linters:
-      - godox
-    - path: ignore/.*\.go
-      linters:
-      - dupword
+  exclusions:
+    paths:
+      - v1beta1/types_jsonschema.go
+      - v1beta1/marshal.go
+      - v1beta1/marshal_test.go

Makefile

@@ -54,7 +54,7 @@ clean: ## Runs go clean
 	go clean -i
 
 GOLANGCI_LINT ?= $(LOCALBIN)/golangci-lint
-GOLANGCI_LINT_VERSION ?= v1.60.1
+GOLANGCI_LINT_VERSION ?= v2.0.2
 
 golangci-lint: $(GOLANGCI_LINT)
 $(GOLANGCI_LINT): $(LOCALBIN)

cmd/config_file_schema.go

@@ -1,12 +1,14 @@
 package cmd
 
+// URLs contains url configuration.
 type URLs struct {
 	URL      string `json:"url"`
 	Username string `json:"username,omitempty"`
 	Password string `json:"password,omitempty"`
 	Token    string `json:"token,omitempty"`
 }
 
+// GITUrls contains git url configuration.
 type GITUrls struct {
 	URL         string `json:"url"`
 	Username    string `json:"username,omitempty"`

cmd/config_handler.go

@@ -3,21 +3,24 @@ package cmd
 import (
 	"fmt"
 	"os"
+	"path/filepath"
 
 	"k8s.io/apimachinery/pkg/util/yaml"
 
 	"github.com/Skarlso/crd-to-sample-yaml/pkg"
 )
 
+// ConfigHandler contains config.
 type ConfigHandler struct {
 	configFileLocation string
 }
 
+// CRDs returns schema types gathered from a config.
 func (h *ConfigHandler) CRDs() ([]*pkg.SchemaType, error) {
 	if _, err := os.Stat(h.configFileLocation); os.IsNotExist(err) {
 		return nil, fmt.Errorf("file under '%s' does not exist", h.configFileLocation)
 	}
-	content, err := os.ReadFile(h.configFileLocation)
+	content, err := os.ReadFile(filepath.Clean(h.configFileLocation))
 	if err != nil {
 		return nil, fmt.Errorf("failed to read file: %w", err)
 	}

cmd/crd.go

@@ -13,7 +13,9 @@ import (
 )
 
 const (
+	// FormatHTML is a setting that is accepted as a format output type. The type is HTML.
 	FormatHTML = "html"
+	// FormatYAML is a setting that is accepted as a format output type. The type is YAML.
 	FormatYAML = "yaml"
 )
 
@@ -35,6 +37,7 @@ type crdGenArgs struct {
 
 var crdArgs = &crdGenArgs{}
 
+// Handler defines an interface for all CRD providers to return Schemas.
 type Handler interface {
 	CRDs() ([]*pkg.SchemaType, error)
 }
@@ -108,7 +111,7 @@ func runGenerate(_ *cobra.Command, _ []string) error {
 		} else {
 			outputLocation := filepath.Join(crdArgs.output, crd.Kind+"_sample."+crdArgs.format)
 			// closed later during render
-			outputFile, err := os.Create(outputLocation)
+			outputFile, err := os.Create(filepath.Clean(outputLocation))
 			if err != nil {
 				errs = append(errs, fmt.Errorf("failed to create file at: '%s': %w", outputLocation, err))
 

cmd/file_handler.go

@@ -3,6 +3,7 @@ package cmd
 import (
 	"fmt"
 	"os"
+	"path/filepath"
 
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/util/yaml"
@@ -11,16 +12,18 @@ import (
 	"github.com/Skarlso/crd-to-sample-yaml/pkg/sanitize"
 )
 
+// FileHandler provides options for a file provider.
 type FileHandler struct {
 	location string
 	group    string
 }
 
+// CRDs returns schemas parsed out of a file.
 func (h *FileHandler) CRDs() ([]*pkg.SchemaType, error) {
 	if _, err := os.Stat(h.location); os.IsNotExist(err) {
 		return nil, fmt.Errorf("file under '%s' does not exist", h.location)
 	}
-	content, err := os.ReadFile(h.location)
+	content, err := os.ReadFile(filepath.Clean(h.location))
 	if err != nil {
 		return nil, fmt.Errorf("failed to read file: %w", err)
 	}

cmd/folder_handler.go

@@ -13,11 +13,13 @@ import (
 	"github.com/Skarlso/crd-to-sample-yaml/pkg/sanitize"
 )
 
+// FolderHandler scans folders and returns schemas found in that folder.
 type FolderHandler struct {
 	location string
 	group    string
 }
 
+// CRDs goes through schemas in folders.
 func (h *FolderHandler) CRDs() ([]*pkg.SchemaType, error) {
 	if _, err := os.Stat(h.location); os.IsNotExist(err) {
 		return nil, fmt.Errorf("file under '%s' does not exist", h.location)
@@ -40,7 +42,7 @@ func (h *FolderHandler) CRDs() ([]*pkg.SchemaType, error) {
 			return nil
 		}
 
-		content, err := os.ReadFile(path)
+		content, err := os.ReadFile(filepath.Clean(path))
 		if err != nil {
 			return fmt.Errorf("failed to read file: %w", err)
 		}

cmd/git_handler.go

@@ -19,6 +19,7 @@ import (
 	"github.com/Skarlso/crd-to-sample-yaml/pkg/sanitize"
 )
 
+// GitHandler contains data to parse git configuration and values.
 type GitHandler struct {
 	URL      string
 	Username string
@@ -32,6 +33,7 @@ type GitHandler struct {
 	group       string // this is used by the configfile.
 }
 
+// CRDs returns a list of crds parsed out from crds contained in a git repository.
 func (g *GitHandler) CRDs() ([]*pkg.SchemaType, error) {
 	opts, err := g.constructGitOptions()
 	if err != nil {

cmd/kube_handler.go

@@ -15,6 +15,7 @@ import (
 	"github.com/Skarlso/crd-to-sample-yaml/pkg"
 )
 
+// KubeHandler contains data for a kubernetes resource.
 type KubeHandler struct {
 	crd             string
 	group           string
@@ -23,6 +24,7 @@ type KubeHandler struct {
 	resource        string
 }
 
+// CRDs returns schemas found in a cluster that have been installed.
 func (h *KubeHandler) CRDs() ([]*pkg.SchemaType, error) {
 	kubeconfig := os.Getenv("KUBECONFIG")
 	if kubeconfig == "" {

cmd/test.go

@@ -36,7 +36,7 @@ func init() {
 
 func runTest(cmd *cobra.Command, args []string) {
 	if len(args) == 0 {
-		fmt.Fprintf(os.Stderr, "test needs an argument where the tests are located at")
+		_, _ = fmt.Fprintf(os.Stderr, "test needs an argument where the tests are located at")
 
 		os.Exit(1)
 	}
@@ -81,7 +81,7 @@ func displayWarnings(warnings []tests.Outcome) error {
 	t.AppendSeparator()
 	t.Render()
 
-	fmt.Fprintf(os.Stdout, "\nTests total: %d, failed: %d, passed: %d\n", len(warnings), errs, len(warnings)-errs)
+	_, _ = fmt.Fprintf(os.Stdout, "\nTests total: %d, failed: %d, passed: %d\n", len(warnings), errs, len(warnings)-errs)
 
 	if errs > 0 {
 		return fmt.Errorf("%d test(s) failed", errs)