golangci-lint Setup with Custom Rules

Beginner8 minTrending

Install and configure golangci-lint with a curated set of linters and custom rules for consistent code quality.

Prerequisites

-Go 1.21+ installed

Steps

Install golangci-lint

Install the latest version of golangci-lint using the official install script.

$ curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin

On macOS you can also use: brew install golangci-lint

Run with default settings

Run golangci-lint against your project to see baseline issues.

$ golangci-lint run ./...

Create a configuration file

Write a .golangci.yml with curated linters and settings for your project.

$ cat > .golangci.yml << 'EOF' run: timeout: 5m linters: enable: - errcheck - govet - staticcheck - unused - gosimple - ineffassign - misspell - gofmt - revive - gocritic linters-settings: revive: rules: - name: exported severity: warning gocritic: enabled-tags: - diagnostic - style issues: exclude-rules: - path: _test\.go linters: - errcheck EOF

Run with the custom configuration

Execute the linter using your new config file.

$ golangci-lint run --config .golangci.yml ./...

Fix auto-fixable issues

Apply automatic fixes for issues that golangci-lint can resolve.

$ golangci-lint run --fix ./...

Review auto-fixed changes before committing. Not all fixes are perfect.

Full Script

full-script.sh

#!/bin/bash
# golangci-lint Setup and Run
set -euo pipefail

echo "=== Checking golangci-lint ==="
if ! command -v golangci-lint &> /dev/null; then
  echo "Installing golangci-lint..."
  curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b "$(go env GOPATH)/bin"
fi
golangci-lint --version

echo ""
echo "=== Running Linter ==="
golangci-lint run ./... --out-format colored-line-number || true

echo ""
echo "=== Lint Commands ==="
echo "Run:       golangci-lint run ./..."
echo "Fix:       golangci-lint run --fix ./..."
echo "Verbose:   golangci-lint run -v ./..."
echo "Specific:  golangci-lint run --enable gocritic ./..."
echo "Cache:     golangci-lint cache clean"

FAQ

Discussion

Loading comments...

#!/bin/bash # golangci-lint Setup and Run set -euo pipefail echo "=== Checking golangci-lint ===" if ! command -v golangci-lint &> /dev/null; then echo "Installing golangci-lint..." curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b "$(go env GOPATH)/bin" fi golangci-lint --version echo "" echo "=== Running Linter ===" golangci-lint run ./... --out-format colored-line-number || true echo "" echo "=== Lint Commands ===" echo "Run: golangci-lint run ./..." echo "Fix: golangci-lint run --fix ./..." echo "Verbose: golangci-lint run -v ./..." echo "Specific: golangci-lint run --enable gocritic ./..." echo "Cache: golangci-lint cache clean"