Add golangci-lint to codebase & CI

.github/workflows/ci.yaml

@@ -12,6 +12,20 @@ permissions:
   contents: read
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: go.mod
+      - name: Run golangci-lint
+        uses: golangci/golangci-lint-action@v7
+        with:
+          version: v2.12.2
+
   unit-tests:
     runs-on: ubuntu-latest
     steps:

.golangci.yml

@@ -0,0 +1,71 @@
+version: "2"
+
+run:
+  timeout: 5m
+
+linters:
+  # Enables the standard set: errcheck, gosimple, govet, ineffassign, staticcheck, unused
+  default: standard
+  enable:
+    - bodyclose      # HTTP response bodies are closed
+    - gocritic       # broad style and correctness checks
+    - misspell       # catches common spelling mistakes in comments and strings
+    - nolintlint     # ensures //nolint directives are valid and specific
+    - unconvert      # removes unnecessary type conversions
+    - unparam        # detects function params that always receive the same value
+  disable:
+    # errcheck: 312 existing violations — deferred to a dedicated cleanup PR
+    - errcheck
+    # revive: 578 existing violations, mostly missing GoDoc on exported symbols — deferred to a dedicated cleanup PR
+    - revive
+
+  settings:
+    gocritic:
+      enabled-tags:
+        - diagnostic
+        - style
+        - performance
+      disabled-checks:
+        # CLI performance is not sensitive enough to warrant changing all option structs to pointers
+        - hugeParam
+        # Same rationale: range-copy cost is negligible in a CLI
+        - rangeValCopy
+
+    revive:
+      rules:
+        - name: blank-imports
+        - name: context-as-argument
+        - name: context-keys-type
+        - name: dot-imports
+        - name: error-return
+        - name: error-strings
+        - name: error-naming
+        - name: exported
+        - name: if-return
+        - name: increment-decrement
+        - name: var-naming
+        - name: var-declaration
+        - name: package-comments
+        - name: range
+        - name: receiver-naming
+        - name: time-naming
+        - name: unexported-return
+        - name: indent-error-flow
+        - name: errorf
+        - name: empty-block
+        - name: superfluous-else
+        - name: unused-parameter
+        - name: unreachable-code
+        - name: redefines-builtin-id
+
+  exclusions:
+    rules:
+      # Test files get more latitude — errcheck and unparam noise is expected there
+      - path: _test\.go
+        linters:
+          - gocritic
+          - unparam
+
+issues:
+  max-issues-per-linter: 0
+  max-same-issues: 0

cmd/gen-manpages/main.go

@@ -39,7 +39,7 @@ func main() {
 	}
 
 	// Ensure output directory exists
-	if err := os.MkdirAll(*output, 0755); err != nil {
+	if err := os.MkdirAll(*output, 0o755); err != nil {
 		fmt.Fprintf(os.Stderr, "Error: Could not create output directory: %s\n", err)
 		os.Exit(1)
 	}
@@ -70,11 +70,12 @@ func main() {
 	// List generated files for verbose
 	if *verbose {
 		files, err := filepath.Glob(filepath.Join(*output, "*.1"))
-		if err != nil {
+		switch {
+		case err != nil:
 			fmt.Fprintf(os.Stderr, "Warning: Failed to list generated files: %s\n", err)
-		} else if len(files) == 0 {
+		case len(files) == 0:
 			fmt.Printf("No man pages found in output directory: %s\n", *output)
-		} else {
+		default:
 			fmt.Printf("Generated %d man pages:\n", len(files))
 			for _, file := range files {
 				fmt.Printf(" - %s\n", filepath.Base(file))

internal/pkg/cli/command/auth/clear.go

@@ -49,19 +49,20 @@ func NewClearCmd() *cobra.Command {
 			}
 
 			// After clearing things, we need to resolve whether the user is still authenticated
-			if secrets.DefaultAPIKey.Get() != "" {
+			switch {
+			case secrets.DefaultAPIKey.Get() != "":
 				state.AuthedUser.Update(func(u *state.TargetUser) {
 					u.AuthContext = state.AuthDefaultAPIKey
 				})
-			} else if secrets.ClientId.Get() != "" && secrets.ClientSecret.Get() != "" {
+			case secrets.ClientId.Get() != "" && secrets.ClientSecret.Get() != "":
 				state.AuthedUser.Update(func(u *state.TargetUser) {
 					u.AuthContext = state.AuthServiceAccount
 				})
-			} else if secrets.GetOAuth2Token().AccessToken != "" {
+			case secrets.GetOAuth2Token().AccessToken != "":
 				state.AuthedUser.Update(func(u *state.TargetUser) {
 					u.AuthContext = state.AuthUserToken
 				})
-			} else {
+			default:
 				state.AuthedUser.Update(func(u *state.TargetUser) {
 					u.AuthContext = state.AuthNone
 				})

internal/pkg/cli/command/config/config_test.go

@@ -41,12 +41,12 @@ type mockConfigService struct {
 	lastDescribeKey string
 }
 
-func (m *mockConfigService) Get(key string) (string, bool, string, bool, error) {
+func (m *mockConfigService) Get(key string) (value string, sensitive bool, envVarName string, envVarOverride bool, err error) {
 	m.lastGetKey = key
 	return m.getValue, m.getSensitive, m.getEnvVarName, m.getEnvVarOverride, m.getErr
 }
 
-func (m *mockConfigService) GetStored(key string) (string, bool, error) {
+func (m *mockConfigService) GetStored(key string) (value string, sensitive bool, err error) {
 	m.lastGetStoredKey = key
 	if m.getStoredOverride {
 		return m.getStoredValue, m.getStoredSensitive, m.getStoredErr

internal/pkg/cli/command/config/list.go

@@ -4,9 +4,7 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/pinecone-io/cli/internal/pkg/utils/exit"
 	"github.com/pinecone-io/cli/internal/pkg/utils/help"
-	"github.com/pinecone-io/cli/internal/pkg/utils/msg"
 	"github.com/pinecone-io/cli/internal/pkg/utils/presenters"
 	"github.com/pinecone-io/cli/internal/pkg/utils/text"
 	"github.com/spf13/cobra"
@@ -33,10 +31,7 @@ func NewListCmd() *cobra.Command {
 		Args: cobra.NoArgs,
 		Run: func(cmd *cobra.Command, args []string) {
 			svc := newDefaultConfigService()
-			if err := runListCmd(svc, options); err != nil {
-				msg.FailJSON(options.json, "%s", err)
-				exit.ErrorMsg(err.Error())
-			}
+			runListCmd(svc, options)
 		},
 	}
 
@@ -47,7 +42,7 @@ func NewListCmd() *cobra.Command {
 	return cmd
 }
 
-func runListCmd(svc ConfigService, opts ListCmdOptions) error {
+func runListCmd(svc ConfigService, opts ListCmdOptions) {
 	// --json output for the list command
 	type listOutput struct {
 		Key            string `json:"key"`
@@ -74,7 +69,7 @@ func runListCmd(svc ConfigService, opts ListCmdOptions) error {
 			jsonEntries = append(jsonEntries, entry)
 		}
 		fmt.Fprintln(os.Stdout, text.IndentJSON(jsonEntries))
-		return nil
+		return
 	}
 
 	w := presenters.NewTabWriter()
@@ -102,5 +97,4 @@ func runListCmd(svc ConfigService, opts ListCmdOptions) error {
 			e.Description)
 	}
 	w.Flush()
-	return nil
 }

internal/pkg/cli/command/config/list_test.go

@@ -11,8 +11,7 @@ func Test_runListCmd_TabularOutputIncludesHeader(t *testing.T) {
 	svc := &mockConfigService{listResult: []ConfigEntry{}}
 
 	out := testutils.CaptureStdout(t, func() {
-		err := runListCmd(svc, ListCmdOptions{})
-		assert.NoError(t, err)
+		runListCmd(svc, ListCmdOptions{})
 	})
 
 	assert.Contains(t, out, "KEY")
@@ -30,8 +29,7 @@ func Test_runListCmd_TabularOutputMasksSensitiveKey(t *testing.T) {
 	}
 
 	out := testutils.CaptureStdout(t, func() {
-		err := runListCmd(svc, ListCmdOptions{})
-		assert.NoError(t, err)
+		runListCmd(svc, ListCmdOptions{})
 	})
 
 	assert.Contains(t, out, "api-key")
@@ -46,8 +44,7 @@ func Test_runListCmd_TabularOutputRevealsSensitiveKey(t *testing.T) {
 	}
 
 	out := testutils.CaptureStdout(t, func() {
-		err := runListCmd(svc, ListCmdOptions{reveal: true})
-		assert.NoError(t, err)
+		runListCmd(svc, ListCmdOptions{reveal: true})
 	})
 
 	assert.Contains(t, out, "sk-supersecret")
@@ -62,8 +59,7 @@ func Test_runListCmd_JSONOutput(t *testing.T) {
 	}
 
 	out := testutils.CaptureStdout(t, func() {
-		err := runListCmd(svc, ListCmdOptions{json: true})
-		assert.NoError(t, err)
+		runListCmd(svc, ListCmdOptions{json: true})
 	})
 
 	// Sensitive key should be masked in JSON output
@@ -83,8 +79,7 @@ func Test_runListCmd_AllFlagIncludesHiddenKeys(t *testing.T) {
 	}
 
 	out := testutils.CaptureStdout(t, func() {
-		err := runListCmd(svc, ListCmdOptions{all: true})
-		assert.NoError(t, err)
+		runListCmd(svc, ListCmdOptions{all: true})
 	})
 
 	assert.Contains(t, out, "environment")
@@ -99,8 +94,7 @@ func Test_runListCmd_JSONAllFlagIncludesHiddenField(t *testing.T) {
 	}
 
 	out := testutils.CaptureStdout(t, func() {
-		err := runListCmd(svc, ListCmdOptions{json: true, all: true})
-		assert.NoError(t, err)
+		runListCmd(svc, ListCmdOptions{json: true, all: true})
 	})
 
 	assert.Contains(t, out, "environment")
@@ -117,8 +111,7 @@ func Test_runListCmd_JSONOutputRevealsSensitiveKey(t *testing.T) {
 	}
 
 	out := testutils.CaptureStdout(t, func() {
-		err := runListCmd(svc, ListCmdOptions{json: true, reveal: true})
-		assert.NoError(t, err)
+		runListCmd(svc, ListCmdOptions{json: true, reveal: true})
 	})
 
 	assert.Contains(t, out, "sk-supersecret")
@@ -132,8 +125,7 @@ func Test_runListCmd_TabularOutputAnnotatesActiveEnvVarOverride(t *testing.T) {
 	}
 
 	out := testutils.CaptureStdout(t, func() {
-		err := runListCmd(svc, ListCmdOptions{all: true})
-		assert.NoError(t, err)
+		runListCmd(svc, ListCmdOptions{all: true})
 	})
 
 	assert.Contains(t, out, "staging")
@@ -148,8 +140,7 @@ func Test_runListCmd_TabularOutputNoAnnotationWithoutOverride(t *testing.T) {
 	}
 
 	out := testutils.CaptureStdout(t, func() {
-		err := runListCmd(svc, ListCmdOptions{all: true})
-		assert.NoError(t, err)
+		runListCmd(svc, ListCmdOptions{all: true})
 	})
 
 	assert.NotContains(t, out, "[$PINECONE_ENVIRONMENT]")
@@ -164,8 +155,7 @@ func Test_runListCmd_JSONOutputIncludesEnvVarFieldsWhenBound(t *testing.T) {
 	}
 
 	out := testutils.CaptureStdout(t, func() {
-		err := runListCmd(svc, ListCmdOptions{json: true, all: true})
-		assert.NoError(t, err)
+		runListCmd(svc, ListCmdOptions{json: true, all: true})
 	})
 
 	assert.Contains(t, out, `"PINECONE_ENVIRONMENT"`)
@@ -182,8 +172,7 @@ func Test_runListCmd_JSONOutputEnvVarOverrideIsFalseWhenNotActive(t *testing.T)
 	}
 
 	out := testutils.CaptureStdout(t, func() {
-		err := runListCmd(svc, ListCmdOptions{json: true, all: true})
-		assert.NoError(t, err)
+		runListCmd(svc, ListCmdOptions{json: true, all: true})
 	})
 
 	assert.Contains(t, out, `"PINECONE_ENVIRONMENT"`)

internal/pkg/cli/command/config/registry.go

@@ -296,7 +296,7 @@ func (s *defaultConfigService) Get(key string) (value string, sensitive bool, en
 	return desc.getStr(), desc.Sensitive, "", false, nil
 }
 
-func (s *defaultConfigService) GetStored(key string) (string, bool, error) {
+func (s *defaultConfigService) GetStored(key string) (value string, sensitive bool, err error) {
 	desc, err := lookupKey(key)
 	if err != nil {
 		return "", false, err

internal/pkg/cli/command/index/create.go

@@ -221,7 +221,7 @@ func runCreateIndexCmd(ctx context.Context, cmd *cobra.Command, service CreateIn
 
 		idx, err = service.CreateServerlessIndex(ctx, &args)
 		if err != nil {
-			wrapped := fmt.Errorf("Failed to create serverless index %s: %w", style.Emphasis(options.name), err)
+			wrapped := fmt.Errorf("failed to create serverless index %s: %w", style.Emphasis(options.name), err)
 			return nil, wrapped
 		}
 	case indexTypePod:
@@ -249,7 +249,7 @@ func runCreateIndexCmd(ctx context.Context, cmd *cobra.Command, service CreateIn
 
 		idx, err = service.CreatePodIndex(ctx, &args)
 		if err != nil {
-			wrapped := fmt.Errorf("Failed to create pod index %s: %w", style.Emphasis(options.name), err)
+			wrapped := fmt.Errorf("failed to create pod index %s: %w", style.Emphasis(options.name), err)
 			return nil, wrapped
 		}
 	case indexTypeIntegrated:
@@ -290,7 +290,7 @@ func runCreateIndexCmd(ctx context.Context, cmd *cobra.Command, service CreateIn
 
 		idx, err = service.CreateIndexForModel(ctx, &args)
 		if err != nil {
-			wrapped := fmt.Errorf("Failed to create integrated index %s: %w", style.Emphasis(options.name), err)
+			wrapped := fmt.Errorf("failed to create integrated index %s: %w", style.Emphasis(options.name), err)
 			return nil, wrapped
 		}
 	case indexTypeBYOC:
@@ -307,11 +307,11 @@ func runCreateIndexCmd(ctx context.Context, cmd *cobra.Command, service CreateIn
 
 		idx, err = service.CreateBYOCIndex(ctx, &args)
 		if err != nil {
-			wrapped := fmt.Errorf("Failed to create BYOC index %s: %w", style.Emphasis(options.name), err)
+			wrapped := fmt.Errorf("failed to create BYOC index %s: %w", style.Emphasis(options.name), err)
 			return nil, wrapped
 		}
 	default:
-		err := fmt.Errorf("Error creating index: invalid index type")
+		err := fmt.Errorf("error creating index: invalid index type")
 		return nil, err
 	}
 
@@ -411,10 +411,8 @@ func buildReadCapacityFromFlags(cmd *cobra.Command, mode, nodeType string, shard
 		default:
 			return nil, fmt.Errorf("invalid read-mode")
 		}
-	} else { // read-mode not provided, return nil if no specific configuration values are passed
-		if !nodeSet && !shardsSet && !replSet {
-			return nil, nil
-		}
+	} else if !nodeSet && !shardsSet && !replSet { // read-mode not provided, return nil if no specific configuration values are passed
+		return nil, nil
 	}
 
 	// dedicated mode if ondemand mode was not requested

internal/pkg/cli/command/index/create_test.go

@@ -6,7 +6,6 @@ import (
 	"testing"
 
 	"github.com/pinecone-io/go-pinecone/v5/pinecone"
-	"github.com/spf13/cobra"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -334,7 +333,7 @@ func Test_createIndexOptions_validate(t *testing.T) {
 }
 
 func Test_buildReadCapacityFromFlags(t *testing.T) {
-	newCmd := func() *cobra.Command { return NewCreateIndexCmd() }
+	newCmd := NewCreateIndexCmd
 
 	t.Run("no flags set returns nil", func(t *testing.T) {
 		cmd := newCmd()