golangci-lint: updates (#114)

- Add golangci-lint configuration with core linters (errcheck, govet, staticcheck, unused), and formatters (gci, gofmt, goimports, golines) with 120 char line limit.
- Add detailed golangci-lint instructions to CONTRIBUTING.md
- Add Requirements section with gofumpt and golangci-lint links
- Update GitHub Actions to use golangci-lint v2.3.0
- Separate linting and testing steps in contribution workflow
- Apply fixes from linting
- Standarize on camelCase for JSON properties (breaking change!)
- Added exceptions for upstream JSON data

Author: peteski22

.github/workflows/golangci-lint.yaml

@@ -27,4 +27,4 @@ jobs:
       - name: golangci-lint
         uses: golangci/golangci-lint-action@4afd733a84b1f43292c63897423277bb7f4313a9 # 8.0.0
         with:
-          version: v2.1
+          version: v2.3.0

.golangci.yaml

@@ -0,0 +1,79 @@
+version: "2"
+
+linters:
+  enable:
+    - errcheck
+    - govet
+    - ineffassign
+    - staticcheck
+    - unused
+    - tagliatelle
+    - tagalign
+  settings:
+    tagliatelle:
+      case:
+        rules:
+          json: camel
+          yaml: snake
+          toml: snake
+        overrides:
+          # Ignore the _meta field on 'Tool'
+          - pkg: internal/packages
+            ignored-fields:
+              - Meta
+          # Ignore casing conflicts in upstream data
+          - pkg: internal/provider/mcpm
+            ignore: true
+
+formatters:
+  enable:
+    - gci
+    - gofmt
+    - gofumpt
+    - goimports
+    - golines
+  settings:
+    gci:
+      # Section configuration to compare against.
+      # Section names are case-insensitive and may contain parameters in ().
+      # The default order of sections is `standard > default > custom > blank > dot > alias > localmodule`.
+      # If `custom-order` is `true`, it follows the order of `sections` option.
+      # Default: ["standard", "default"]
+      sections:
+      - standard # Standard section: captures all standard packages.
+      - default # Default section: contains all imports that could not be matched to another section type.
+      - prefix(github.com/mozilla-ai/mcpd) # Custom section: groups all imports with the specified Prefix.
+      - blank # Blank section: contains all blank imports. This section is not present unless explicitly enabled.
+      - dot # Dot section: contains all dot imports. This section is not present unless explicitly enabled.
+      #- alias # Alias section: contains all alias imports. This section is not present unless explicitly enabled.
+      - localmodule # Local module section: contains all local packages. This section is not present unless explicitly enabled.
+    golines:
+      max-len: 120
+
+issues:
+  fix: true
+
+output:
+  formats:
+    text:
+      # Default: stdout
+      path: stderr
+  sort-order:
+    - severity
+    - file
+    - linter
+
+run:
+  timeout: 5m
+  # The mode used to evaluate relative paths.
+  # It's used by exclusions, Go plugins, and some linters.
+  # The value can be:
+  # - `gomod`: the paths will be relative to the directory of the `go.mod` file.
+  # - `gitroot`: the paths will be relative to the git root (the parent directory of `.git`).
+  # - `cfg`: the paths will be relative to the configuration file.
+  # - `wd` (NOT recommended): the paths will be relative to the place where golangci-lint is run.
+  # Default: cfg
+  relative-path-mode: gomod
+  modules-download-mode: readonly
+  allow-parallel-runners: true
+  allow-serial-runners: true

CONTRIBUTING.md

@@ -15,26 +15,44 @@ We encourage contributions via GitHub pull requests. Before you start, please re
 * **Features:** Please use our [Feature Request template](.github/ISSUE_TEMPLATE/feature_request.yaml) to describe the problem your idea solves and your proposed solution.
 * **Search First:** Before creating a new issue, please search existing issues to see if your topic has already been discussed.
 
+### Requirements
+
+* [gofumpt](https://github.com/mvdan/gofumpt)
+* [golangci-lint](https://golangci-lint.run/welcome/install/)
+
 ### Contributing Code
 
 1. **Fork** the repository on GitHub.
-1. **Clone** your forked repository to your local machine.
+2. **Clone** your forked repository to your local machine.
     ```bash
     git clone https://github.com/{YOUR_GITHUB_USERNAME}/mcpd.git
     cd mcpd
     ```
-1. **Create a new branch** for your changes based on the `main` branch.
+3. **Create a new branch** for your changes based on the `main` branch.
     ```bash
     git checkout main
     git pull origin main
     git checkout -b your-feature-or-bugfix-branch
     ```
-1. **Make your changes.**
-1. **Format and Lint:** Ensure your code is formatted using [gofumpt](https://github.com/mvdan/gofumpt) and [golangci-lint run ./...](https://golangci-lint.run/welcome/install/).
-1. **Add Unit Tests:** All new features and bug fixes should be accompanied by relevant unit tests.
-1. **Commit your changes** with a clear and descriptive message.
-1. **Push your branch** to your forked repository.
-1. **Open a Pull Request** from your branch to the `main` branch of the upstream `mozilla-ai/mcpd` repository, 
+4. **Make your changes:** You can build your changes with:
+   ```bash
+   make build
+   ```
+5. **Format and Lint:** Ensure your code passes linting and formatting checks:
+   ```bash
+   # Run golangci-lint (uses .golangci.yaml config)
+   golangci-lint run
+   
+   # Auto-fix formatting issues (recommended)
+   golangci-lint run --fix
+   ```
+6. **Add Unit Tests:** All new features and bug fixes should be accompanied by relevant unit tests. Run tests with:
+   ```bash
+   make test
+   ```
+7. **Commit your changes** with a clear and descriptive message.
+8. **Push your branch** to your forked repository.
+9. **Open a Pull Request** from your branch to the `main` branch of the upstream `mozilla-ai/mcpd` repository, 
   reference the relevant GitHub issue in your PR summary.
 
 ## Security Vulnerabilities

cmd/add.go

@@ -231,7 +231,10 @@ func parseServerEntry(
 
 	runtimeSpecificName := pkg.InstallationDetails[selectedRuntime].Package
 	if runtimeSpecificName == "" {
-		return config.ServerEntry{}, fmt.Errorf("installation package name is missing for runtime '%s'", selectedRuntime)
+		return config.ServerEntry{}, fmt.Errorf(
+			"installation package name is missing for runtime '%s'",
+			selectedRuntime,
+		)
 	}
 	runtimePackageVersion := fmt.Sprintf("%s::%s@%s", selectedRuntime, runtimeSpecificName, v)
 

cmd/add_test.go

@@ -269,11 +269,11 @@ func TestAddCmd_ServerWithArguments(t *testing.T) {
 					},
 				},
 				Arguments: packages.Arguments{
-					"--endpoint": {VariableType: packages.VariableTypeArg, Required: true},
-					"--api-key": {VariableType: packages.VariableTypeArg, Required: true},
-					"--format": {VariableType: packages.VariableTypeArg, Required: false},
+					"--endpoint":     {VariableType: packages.VariableTypeArg, Required: true},
+					"--api-key":      {VariableType: packages.VariableTypeArg, Required: true},
+					"--format":       {VariableType: packages.VariableTypeArg, Required: false},
 					"--enable-cache": {VariableType: packages.VariableTypeArgBool, Required: true},
-					"--debug": {VariableType: packages.VariableTypeArgBool, Required: false},
+					"--debug":        {VariableType: packages.VariableTypeArgBool, Required: false},
 				},
 			},
 			expectedRequiredValues: []string{"--endpoint", "--api-key"},
@@ -296,8 +296,8 @@ func TestAddCmd_ServerWithArguments(t *testing.T) {
 					},
 				},
 				Arguments: packages.Arguments{
-					"OPTIONAL_ENV": {VariableType: packages.VariableTypeEnv, Required: false},
-					"--optional-flag": {VariableType: packages.VariableTypeArgBool, Required: false},
+					"OPTIONAL_ENV":     {VariableType: packages.VariableTypeEnv, Required: false},
+					"--optional-flag":  {VariableType: packages.VariableTypeArgBool, Required: false},
 					"--optional-value": {VariableType: packages.VariableTypeArg, Required: false},
 				},
 			},

cmd/config/export/export_test.go

@@ -132,7 +132,11 @@ func TestExportCommand_Integration(t *testing.T) {
 			require.NoError(t, err)
 			expectedContextContent, err := os.ReadFile(paths.contextFile)
 			require.NoError(t, err)
-			require.Equal(t, strings.TrimSpace(string(expectedContextContent)), strings.TrimSpace(string(contextContent)))
+			require.Equal(
+				t,
+				strings.TrimSpace(string(expectedContextContent)),
+				strings.TrimSpace(string(contextContent)),
+			)
 
 			// Verify contract output content
 			contractContent, err := os.ReadFile(contractOutput)

cmd/remove_test.go

@@ -5,12 +5,11 @@ import (
 	"os"
 	"testing"
 
-	"github.com/mozilla-ai/mcpd/v2/internal/cmd"
-
 	"github.com/BurntSushi/toml"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
+	"github.com/mozilla-ai/mcpd/v2/internal/cmd"
 	"github.com/mozilla-ai/mcpd/v2/internal/config"
 	"github.com/mozilla-ai/mcpd/v2/internal/flags"
 )

cmd/search.go

@@ -142,7 +142,7 @@ func (c *SearchCmd) filters() map[string]string {
 		f["license"] = c.License
 	}
 	if c.IsOfficial {
-		f["is_official"] = "true"
+		f["isOfficial"] = "true"
 	}
 
 	return f

cmd/search_test.go

@@ -73,8 +73,8 @@ func TestSearchCmd_Filters(t *testing.T) {
 				c.License = "MIT"
 			},
 			wantFilter: map[string]string{
-				"is_official": "true",
-				"license":     "MIT",
+				"isOfficial": "true",
+				"license":    "MIT",
 			},
 		},
 		{
@@ -549,7 +549,11 @@ func (f *fakeRegistryMultiple) Resolve(_ string, _ ...options.ResolveOption) (pa
 	return packages.Package{}, f.err
 }
 
-func (f *fakeRegistryMultiple) Search(_ string, _ map[string]string, _ ...options.SearchOption) ([]packages.Package, error) {
+func (f *fakeRegistryMultiple) Search(
+	_ string,
+	_ map[string]string,
+	_ ...options.SearchOption,
+) ([]packages.Package, error) {
 	return f.packages, f.err
 }
 

internal/api/health.go

@@ -32,8 +32,8 @@ type ServerHealth struct {
 	Name           string       `json:"name"`
 	Status         HealthStatus `json:"status"`
 	Latency        *string      `json:"latency,omitempty"`
-	LastChecked    *time.Time   `json:"last_checked,omitempty"`
-	LastSuccessful *time.Time   `json:"last_successful,omitempty"`
+	LastChecked    *time.Time   `json:"lastChecked,omitempty"`
+	LastSuccessful *time.Time   `json:"lastSuccessful,omitempty"`
 }
 
 // ServersHealth represents a collection of ServerHealth.
@@ -44,13 +44,13 @@ type ServersHealth struct {
 // ServersHealthResponse is the response for GET /health
 type ServersHealthResponse struct {
 	Body struct {
-		Servers []ServerHealth `json:"servers" doc:"Tracked MCP server health statuses"`
+		Servers []ServerHealth `doc:"Tracked MCP server health statuses" json:"servers"`
 	}
 }
 
 // ServerHealthRequest represents the incoming request for obtaining ServerHealth.
 type ServerHealthRequest struct {
-	Name string `path:"name" example:"time" doc:"Name of the server to check"`
+	Name string `doc:"Name of the server to check" example:"time" path:"name"`
 }
 
 // ServerHealthResponse represents the wrapped API response for a ServerHealth.