template-arch-lint

README

Template Architecture Lint

Copy-paste configuration files for enterprise-grade Go linting. This is NOT a library to install—it's a template to copy from.

Table of Contents

• Overview
• Features
• Installation
• Usage
• Development
• Contributing
• License
• Contact

Overview

A reference implementation and configuration template demonstrating:

• Clean Architecture enforced by go-arch-lint
• 99+ linters via golangci-lint with maximum strictness
• Zero-tolerance quality: magic numbers, banned patterns (interface{}, any, panic()), complexity limits
• Security scanning: gosec, govulncheck, NilAway (80% panic reduction)

The Go code showcases proper architecture boundaries—copy these configs to your real projects.

🎯 THE VALUE: COPY THESE 3 FILES TO YOUR PROJECT

This is NOT a library to install - it's a template to copy from!

THESE 3 FILES ARE WHAT YOU NEED:

1. .go-arch-lint.yml - Enforces Clean Architecture boundaries (Domain → Application → Infrastructure)
2. .golangci.yml - 40+ linters with maximum strictness (magic numbers, strings, security, complexity)
3. justfile - 30+ commands for just lint, just test, just security-audit, etc.

🚀 ULTRA-SIMPLE: ONE COMMAND SETUP

# 🎯 RECOMMENDED: One command that does EVERYTHING
curl -fsSL https://raw.githubusercontent.com/LarsArtmann/template-arch-lint/master/bootstrap.sh | bash

# ✨ Or safer two-step (for paranoid users):
curl -fsSL https://raw.githubusercontent.com/LarsArtmann/template-arch-lint/master/bootstrap.sh -o bootstrap.sh
chmod +x bootstrap.sh && ./bootstrap.sh

# 🔧 Or if you already have the config files:
just bootstrap

What the bootstrap does FOR YOU:

• ✅ Verifies your Go project + git repository
• ✅ Checks/installs required tools (go, curl, git, just)
• ✅ Downloads all 3 config files (.go-arch-lint.yml, .golangci.yml, justfile)
• ✅ Installs all linting tools (golangci-lint, go-arch-lint)
• ✅ Verifies everything works correctly
• ✅ Provides clear next steps
• ✅ Rolls back on any error - completely safe!

MANUAL COPY-PASTE (If you prefer):

# Get the configs manually:
curl -fsSL -o .go-arch-lint.yml https://raw.githubusercontent.com/LarsArtmann/template-arch-lint/master/.go-arch-lint.yml
curl -fsSL -o .golangci.yml https://raw.githubusercontent.com/LarsArtmann/template-arch-lint/master/.golangci.yml
curl -fsSL -o justfile https://raw.githubusercontent.com/LarsArtmann/template-arch-lint/master/justfile

# Install the linters:
just install

# Start using immediately:
just lint        # Run ALL quality checks
just lint-arch   # Architecture boundaries only
just security-audit  # Complete security scan

These configs enforce:

• ✅ Architecture boundaries - Domain stays pure, no circular dependencies
• ✅ Magic number/string detection - goconst + mnd linters
• ✅ Security scanning - gosec + govulncheck + NilAway (80% panic reduction)
• ✅ Code quality - 40+ linters, max 50 lines per function, complexity limits
• ✅ Zero tolerance - forbidigo bans interface{}, any, panic(), print statements

Features

• 🏗️ Architecture Enforcement Enforces Clean Architecture and DDD boundaries automatically with go-arch-lint

• 🔒 Enterprise Security 40+ linters including NilAway, gosec, and custom security rules

• 🚨 Zero Tolerance Quality Maximum strictness configuration with zero technical debt tolerance

• 🤖 Complete Automation Integrated CI/CD pipeline with pre-commit hooks and auto-fixing

• 📊 Production Ready Docker containerization, monitoring, and enterprise deployment patterns

🚀 INSTANT SETUP - Zero-Friction Installation

ONE COMMAND SETUP (Recommended)

🎯 Get from zero to enterprise-grade linting in under 2 minutes:

curl -fsSL https://raw.githubusercontent.com/LarsArtmann/template-arch-lint/master/bootstrap.sh | bash

That's it! The bootstrap script:

• ✅ Verifies you're in a Go project with git
• ✅ Installs missing tools (including just command runner)
• ✅ Downloads all configuration files
• ✅ Installs all linting tools
• ✅ Verifies everything works
• ✅ Rolls back if anything fails

🛡️ Safety First? Download and inspect before running:

curl -fsSL https://raw.githubusercontent.com/LarsArtmann/template-arch-lint/master/bootstrap.sh -o bootstrap.sh
chmod +x bootstrap.sh && ./bootstrap.sh

🔧 Already have config files? Just run:

just bootstrap  # Verifies and installs everything needed

Prerequisites (Auto-detected & installed)

• ✅ Go 1.19+ (will check version compatibility)
• ✅ Git repository (will verify you're in one)
• ✅ curl (for downloading files)
• ✅ just command runner (will install automatically if missing)

The bootstrap script handles all of this automatically!

Usage

Development

Quick Development Setup

🚀 Get the complete development environment running instantly:

git clone https://github.com/LarsArtmann/template-arch-lint.git
cd template-arch-lint
just bootstrap  # Installs everything needed + verifies setup
go mod download  # Download Go dependencies

That's it! The just bootstrap command handles all tool installation and verification.

Prerequisites (Auto-detected)

• ✅ Go 1.19+ (bootstrap will verify version)
• ✅ Git (for cloning repository)
• ✅ just command runner (bootstrap will install if missing)
• ✅ All linting tools (bootstrap installs automatically)

Available Commands

🔥 ESSENTIAL COMMANDS (Copy these to your workflow!)

just install         # Install ALL linting tools (one-time setup)
just lint            # Run EVERYTHING: architecture + code + security (40+ linters)
just fix             # Auto-fix all fixable issues
just test            # Run tests with coverage
just build           # Build the application

🏗️ Architecture & Quality

just lint-arch       # Clean Architecture boundary validation
just lint-code       # Code quality linting (complexity, naming, etc.)
just lint-strict     # Maximum strictness mode
just graph           # Generate flow architecture graph (SVG)
just graph-di        # Generate dependency injection graph
just graph-vendor    # Generate graph with vendor dependencies
just graph-all       # Generate ALL architecture graphs
just graph-component <name> # Generate focused component graph

🔒 Security & Safety

just security-audit  # Complete security scan (gosec + govulncheck + licenses)
just lint-nilaway    # NilAway: 80% panic reduction
just lint-vulns      # CVE vulnerability scanning
just lint-deps-advanced  # Advanced dependency analysis

🧹 Formatting & Generation

just format          # gofumpt + goimports formatting
just templ           # Generate templ templates
just lint-cycles     # Import cycle detection
just lint-goroutines # Goroutine leak detection

Contributing

Development Guidelines

• Follow the existing code style
• Add tests for new features
• Update documentation as needed
• Ensure all tests pass

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

LarsArtmann

Project Link: https://github.com/LarsArtmann/template-arch-lint