Quick Start

Get up and running in under a minute. golint-sl runs as a golangci-lint module plugin.

1. Add .custom-gcl.yml to your project:

version: v2.8.0

plugins:
  - module: 'github.com/spechtlabs/golint-sl'
    version: v0.1.0

2. Build the custom binary and run:

golangci-lint custom
./custom-gcl run ./...

Looking for more details?

See the Installation Guide for full setup instructions and configuration.

What Makes golint-sl Different?

Most linters focus on syntax and formatting. golint-sl focuses on production readiness:

Wide Events Over Scattered Logs - One log line per request with 50+ structured fields beats 15 scattered logs

// Bad: Scattered logs throughout the function
log.Info("starting request")
log.Info("fetched user")
log.Info("updated database")

// Good: Single wide event at the end
logger.Info("request completed",
    zap.String("request_id", reqID),
    zap.String("user_id", userID),
    zap.Duration("duration", time.Since(start)),
    zap.Int("items_processed", count),
)

Nil Checks at Function Boundaries - Catch nil pointer panics before they reach production

// golint-sl catches this
func ProcessUser(user *User) error {
    return user.Save() // nil check missing!
}

// Fixed
func ProcessUser(user *User) error {
    if user == nil {
        return errors.New("user cannot be nil")
    }
    return user.Save()
}

Kubernetes Reconciler Patterns - Ensure your operators follow best practices

// golint-sl ensures you update status
func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
    // ... reconciliation logic ...

    // Missing status update detected!
    return ctrl.Result{}, nil
}

Integration

golint-sl integrates with your existing workflow:

Integration	Description
GitHub Actions	Run on every PR with clear annotations
Pre-commit Hooks	Catch issues before they're committed
golangci-lint	Configuration and setup details