Go Linting

version: "2"
linters:
  enable:
    # Minimum recommended
    - errcheck
    - govet
    - revive
    - staticcheck
    # Additional recommended
    - bodyclose
    - gocyclo
    - gosec
    - ineffassign
    - misspell
  settings:
    revive:
      rules:
        - name: exported
    gocyclo:
      min-complexity: 15
  exclusions:
    generated: lax
    paths:
      - third_party$
      - builtin$
      - examples$

issues:
  max-issues-per-linter: 0
  max-same-issues: 0

formatters:
  enable:
    - goimports
  exclusions:
    generated: lax
    paths:
      - third_party$
      - builtin$
      - examples$

#!/usr/bin/env bash
set -euo pipefail

VERSION="1.0.0"
SCRIPT_NAME="$(basename "$0")"

usage() {
    cat <<EOF
$SCRIPT_NAME v$VERSION — Generate .golangci.yml and run initial lint

USAGE
    bash $SCRIPT_NAME [options] [local-prefix]

DESCRIPTION
    Creates a .golangci.yml with a curated set of linters (errcheck,
    goimports, revive, govet, staticcheck) and runs golangci-lint.
    If local-prefix is provided, configures goimports to group local
    imports separately.

    Exits 0 if lint passes, 1 if lint issues found, 2 on error.

OPTIONS
    -h, --help       Show this help message
    -v, --version    Show version
    --json           Output results as JSON
    --force          Overwrite existing .golangci.yml
    --dry-run        Print generated config to stdout without writing
    --limit N        Max lint issue lines in JSON output (default: 50, 0 = unlimited)

ARGUMENTS
    local-prefix     Module path prefix for goimports grouping
                     (e.g., github.com/myorg/myrepo)

EXAMPLES
    bash $SCRIPT_NAME
    bash $SCRIPT_NAME github.com/myorg/myrepo
    bash $SCRIPT_NAME --force github.com/myorg/myrepo
    bash $SCRIPT_NAME --dry-run github.com/myorg/myrepo
    bash $SCRIPT_NAME --json
    bash $SCRIPT_NAME --json --limit 20
EOF
}

json_escape() {
    local s="$1"
    s="${s//\\/\\\\}"
    s="${s//\"/\\\"}"
    s="${s//$'\t'/\\t}"
    s="${s//$'\r'/}"
    s="${s//$'\n'/\\n}"
    printf '%s' "$s"
}

JSON_OUTPUT=false
FORCE=false
DRY_RUN=false
LIMIT=50
LOCAL_PREFIX=""

while [[ $# -gt 0 ]]; do
    case "$1" in
        -h|--help)    usage; exit 0 ;;
        -v|--version) echo "$SCRIPT_NAME v$VERSION"; exit 0 ;;
        --json)       JSON_OUTPUT=true; shift ;;
        --force)      FORCE=true; shift ;;
        --dry-run)    DRY_RUN=true; shift ;;
        --limit)
            if [[ $# -lt 2 ]]; then
                echo "error: --limit requires a number" >&2
                exit 2
            fi
            LIMIT="$2"
            shift 2
            ;;
        -*)           echo "error: unknown option: $1" >&2; usage >&2; exit 2 ;;
        *)            LOCAL_PREFIX="$1"; shift ;;
    esac
done

if ! [[ "$LIMIT" =~ ^[0-9]+$ ]]; then
    echo "error: --limit must be a non-negative integer, got: $LIMIT" >&2
    exit 2
fi

generate_config() {
    cat <<'YAML'
version: "2"
linters:
  enable:
    # Minimum recommended
    - errcheck
    - govet
    - revive
    - staticcheck
    # Additional recommended
    - bodyclose
    - gocyclo
    - gosec
    - ineffassign
    - misspell
  settings:
    revive:
      rules:
        - name: exported
    gocyclo:
      min-complexity: 15
  exclusions:
    generated: lax
    paths:
      - third_party$
      - builtin$
      - examples$

issues:
  max-issues-per-linter: 0
  max-same-issues: 0

formatters:
  enable:
    - goimports
  exclusions:
    generated: lax
    paths:
      - third_party$
      - builtin$
      - examples$
YAML

    if [[ -n "$LOCAL_PREFIX" ]]; then
        cat <<YAML
  settings:
    goimports:
      local-prefixes:
        - ${LOCAL_PREFIX}
YAML
    fi
}

if $DRY_RUN; then
    generate_config
    exit 0
fi

CONFIG_PATH=".golangci.yml"

if [[ -f "$CONFIG_PATH" ]] && ! $FORCE; then
    echo "error: $CONFIG_PATH already exists (use --force to overwrite)" >&2
    exit 2
fi

generate_config > "$CONFIG_PATH"

LINT_OUTPUT=""
LINT_EXIT=0
if ! command -v golangci-lint &>/dev/null; then
    echo "error: golangci-lint is not installed" >&2
    exit 2
fi

LINT_OUTPUT=$(golangci-lint run ./... 2>&1) || LINT_EXIT=$?

if $JSON_OUTPUT; then
    LINT_TRUNCATED=false
    LINT_DISPLAY="$LINT_OUTPUT"
    if [[ $LIMIT -gt 0 && -n "$LINT_OUTPUT" ]]; then
        LINT_ARR=()
        while IFS= read -r line; do
            LINT_ARR+=("$line")
        done <<< "$LINT_OUTPUT"
        if [[ ${#LINT_ARR[@]} -gt $LIMIT ]]; then
            LINT_DISPLAY=""
            for (( i=0; i<LIMIT; i++ )); do
                [[ -n "$LINT_DISPLAY" ]] && LINT_DISPLAY+=$'\n'
                LINT_DISPLAY+="${LINT_ARR[$i]}"
            done
            LINT_TRUNCATED=true
        fi
    fi
    LINT_ESC="$(json_escape "$LINT_DISPLAY")"
    CONFIG_ESC="$(json_escape "$CONFIG_PATH")"
    PREFIX_ESC="$(json_escape "$LOCAL_PREFIX")"
    CREATED=true
    HAS_ISSUES=$( [[ $LINT_EXIT -ne 0 ]] && echo true || echo false )
    TRUNC_FIELD=""
    $LINT_TRUNCATED && TRUNC_FIELD=',"truncated":true'
    cat <<EOF
{"config_path":"$CONFIG_ESC","local_prefix":"$PREFIX_ESC","created":$CREATED,"lint_issues":$HAS_ISSUES,"lint_output":"$LINT_ESC"$TRUNC_FIELD}
EOF
else
    echo "Created $CONFIG_PATH"
    if [[ $LINT_EXIT -ne 0 ]]; then
        echo ""
        echo "$LINT_OUTPUT"
        echo ""
        echo "Lint issues found — fix them category by category (formatting first, then vet, then style)."
    else
        echo "golangci-lint: all clean."
    fi
fi

if [[ $LINT_EXIT -ne 0 ]]; then
    exit 1
fi
exit 0