refactor: add more linters and implement suggestions (#53)

* frefactor: convert ErrorWithDetails to a method on Detailer struct

* feat: add context handling for Detailer with NewContext and FromContext functions

* refactor: pass context with detailer to functions returning errors with details

* refactor: enhance codebase with additional linters suggestions

* chore: bump version to 0.2.3

Author: lorenzofelletti

.golangci.yaml

@@ -1,6 +1,17 @@
 version: "2"
 
 linters:
+  enable:
+  - govet
+  - errcheck
+  - staticcheck
+  - ineffassign
+  - misspell
+  - gocritic
+  - revive
+  - gosec
+  - nolintlint
+  - gocyclo
   exclusions:
     warn-unused: true
     presets:

README.md

@@ -1,4 +1,7 @@
 # Cuestomize
+
+[![Go Reference](https://pkg.go.dev/badge/github.com/workday/cuestomize.svg)](https://pkg.go.dev/github.com/workday/cuestomize)
+
 Cuestomize is a Kubernetes Package Manager using CUE-lang and integrated in Kustomize.
 
 It is implemented as a Kustomize KRM function that reads a CUE model, and optionally some input resources from the Kustomize stream, and passes back to Kustomize the generated resources.

api/convert.go

@@ -1,3 +1,5 @@
+// Package api provides utilities for converting Go values into CUE values and defines
+// interfaces for types that can be converted to CUE format.
 package api
 
 import (

api/krm.go

@@ -30,7 +30,7 @@ type KRMInput struct {
 // ExtractIncludes populates the includes structure from the provided KRMInput and items.
 // It searches items for matches against the includes defined in the KRMInput's spec
 // and returns the includes map.
-func ExtractIncludes(krm *KRMInput, items []*kyaml.RNode, ctx context.Context) (Includes, error) {
+func ExtractIncludes(ctx context.Context, krm *KRMInput, items []*kyaml.RNode) (Includes, error) {
 	log := logr.FromContextOrDiscard(ctx)
 
 	includes := make(Includes)

api/krm_test.go

@@ -47,7 +47,7 @@ func TestKRMInput_ExtractIncludes(t *testing.T) {
 			krmInput := testhelpers.LoadFromFile[KRMInput](t, tt.testdataDir+"/"+TestKRMInputFileName)
 			items := testhelpers.LoadResourceList(t, tt.testdataDir+"/"+TestKRMInputFileName, tt.testdataDir+"/"+TestItemsFileName)
 
-			includes, err := ExtractIncludes(krmInput, items, t.Context())
+			includes, err := ExtractIncludes(t.Context(), krmInput, items)
 
 			if tt.expectedError {
 				require.Error(t, err)

api/remote_module.go

@@ -2,6 +2,7 @@ package api
 
 import "sigs.k8s.io/kustomize/api/types"
 
+// RemoteModule defines the structure to describe a remote CUE module to fetch from an OCI registry.
 type RemoteModule struct {
 	Registry string `yaml:"registry" json:"registry"`
 	Repo     string `yaml:"repo" json:"repo"`

e2e/main.go

@@ -1,3 +1,4 @@
+// Package main provides an e2e test setup utility that uploads CUE modules to local registries.
 package main
 
 import (

hack/push-examples.go

@@ -1,3 +1,4 @@
+// Package main provides a utility to push CUE module examples to an OCI registry.
 package main
 
 import (

internal/pkg/cuerrors/details.go

@@ -1,3 +1,9 @@
+// Package cuerrors provides utilities for enhanced error formatting and detailed error reporting
+// when dealing with CUE language errors. It includes functionality to format errors with
+// additional context and details using CUE's built-in error configuration system.
+//
+// The main component is the Detailer type, which wraps CUE's errors.Config to provide
+// consistent error formatting.
 package cuerrors
 
 import (
@@ -6,10 +12,13 @@ import (
 	"cuelang.org/go/cue/errors"
 )
 
+// Detailer struct can be used to format CUE errors with additional details.
 type Detailer struct {
 	Cfg errors.Config
 }
 
+// NewDetailerWithCwd creates a new Detailer with the specified current working directory (cwd).
+// In formatted errors, file paths will be made relative to this directory.
 func NewDetailerWithCwd(cwd string) Detailer {
 	return Detailer{
 		Cfg: errors.Config{

internal/pkg/cuestomize/builder.go

@@ -1,3 +1,6 @@
+// Package cuestomize provides a builder for creating KRM (Kubernetes Resource Model) functions
+// that generate Kubernetes resources from CUE configurations. It enables users to define
+// resource transformations using CUE language and apply them as part of a Kustomize pipeline.
 package cuestomize
 
 import (
@@ -13,8 +16,8 @@ const (
 	DefaultResourcesPath = "/cue-resources"
 )
 
-// CUEstomizeFuncBuilder is a builder for the CUEstomize KRM function.
-type CUEstomizeFuncBuilder struct {
+// KRMFuncBuilder is a builder for the Cuestomize KRM function.
+type KRMFuncBuilder struct {
 	// resourcesPath is the path to the directory containing the CUE resources.
 	// If not set, it defaults to "/cue-resources".
 	resourcesPath string
@@ -23,29 +26,29 @@ type CUEstomizeFuncBuilder struct {
 	config *api.KRMInput
 }
 
-// NewBuilder creates a new CUEstomizeFuncBuilder with the default resources path.
-func NewBuilder() *CUEstomizeFuncBuilder {
-	return &CUEstomizeFuncBuilder{
+// NewBuilder creates a new KRMFuncBuilder with the default resources path.
+func NewBuilder() *KRMFuncBuilder {
+	return &KRMFuncBuilder{
 		resourcesPath: DefaultResourcesPath,
 	}
 }
 
 // SetConfig sets the reference to the configuration object that the KRM function will receive in input.
-func (b *CUEstomizeFuncBuilder) SetConfig(config *api.KRMInput) *CUEstomizeFuncBuilder {
+func (b *KRMFuncBuilder) SetConfig(config *api.KRMInput) *KRMFuncBuilder {
 	b.config = config
 	return b
 }
 
 // SetResourcesPath sets the path to the directory containing the CUE resources.
-func (b *CUEstomizeFuncBuilder) SetResourcesPath(resourcesPath string) *CUEstomizeFuncBuilder {
+func (b *KRMFuncBuilder) SetResourcesPath(resourcesPath string) *KRMFuncBuilder {
 	b.resourcesPath = resourcesPath
 	return b
 }
 
 // Build returns a function that can be used to generate resources from a CUE configuration and some input resources.
-func (b *CUEstomizeFuncBuilder) Build(ctx context.Context) (func([]*kyaml.RNode) ([]*kyaml.RNode, error), error) {
+func (b *KRMFuncBuilder) Build(ctx context.Context) (func([]*kyaml.RNode) ([]*kyaml.RNode, error), error) {
 	if b.config == nil {
 		return nil, fmt.Errorf("config must be set before building the KRM function")
 	}
-	return newCuestomizeFunctionWithPath(b.config, &b.resourcesPath, ctx), nil
+	return newCuestomizeFunctionWithPath(ctx, b.config, &b.resourcesPath), nil
 }