tools: adopt llformat formatting targets

Author: hieblmi

.gitignore

@@ -26,6 +26,7 @@ _testmain.go
 
 /loop-debug
 /loopd-debug
+/tools/llformat
 
 output*.log
 

.golangci.yml

@@ -54,6 +54,11 @@ linters:
     - funcorder
     - wsl_v5
     - noinlineerr
+    # llformat now owns vertical whitespace for handwritten Go. The
+    # whitespace linter cannot express the project rule that multi-line
+    # function signatures keep a body separator while single-return control
+    # blocks stay compact.
+    - whitespace
   settings:
     gosec:
       excludes:
@@ -67,9 +72,6 @@ linters:
       case:
         rules:
           json: snake
-    whitespace:
-      multi-if: true
-      multi-func: true
   exclusions:
     generated: lax
     presets:

Makefile

@@ -7,9 +7,11 @@ GOTEST := GO111MODULE=on go test -v
 
 
 GOIMPORTS_PKG := github.com/rinchsan/gosimports/cmd/gosimports
+LLFORMAT_PKG := github.com/bhandras/llformat/cmd/llformat
 
 GO_BIN := ${GOPATH}/bin
 GOIMPORTS_BIN := $(GO_BIN)/gosimports
+LLFORMAT_BIN := $(CURDIR)/$(TOOLS_DIR)/llformat
 
 GOBUILD := CGO_ENABLED=0 GO111MODULE=on go build -v
 GOINSTALL := CGO_ENABLED=0 GO111MODULE=on go install -v
@@ -35,6 +37,7 @@ UNIT := $(GOLIST) | $(XARGS) env $(GOTEST) $(TEST_FLAGS)
 ifneq ($(workers),)
 LINT_WORKERS = --concurrency=$(workers)
 endif
+FMT_BASE := $(if $(base),$(base),origin/master)
 
 DOCKER_TOOLS = docker run \
   --rm \
@@ -64,6 +67,11 @@ $(GOIMPORTS_BIN):
 	@$(call print, "Installing goimports.")
 	cd $(TOOLS_DIR); go install -trimpath $(GOIMPORTS_PKG)
 
+$(LLFORMAT_BIN): $(TOOLS_DIR)/go.mod $(TOOLS_DIR)/go.sum
+	@$(call print, "Installing llformat.")
+	cd $(TOOLS_DIR); GOBIN="$(CURDIR)/$(TOOLS_DIR)" \
+		go install -trimpath $(LLFORMAT_PKG)
+
 
 # ============
 # INSTALLATION
@@ -132,11 +140,15 @@ unit-postgres-race:
 # UTILITIES
 # =========
 
-fmt: $(GOIMPORTS_BIN)
-	@$(call print, "Fixing imports.")
-	gosimports -w $(GOFILES_NOVENDOR)
-	@$(call print, "Formatting source.")
-	gofmt -l -w -s $(GOFILES_NOVENDOR)
+fmt: $(LLFORMAT_BIN)
+	@$(call print, "Formatting all handwritten Go source.")
+	@./scripts/llformat-files.sh all | \
+		xargs -0 -n 1 $(LLFORMAT_BIN) -w
+
+fmt-changed: $(LLFORMAT_BIN)
+	@$(call print, "Formatting Go source changes against $(FMT_BASE).")
+	@./scripts/llformat-files.sh changed "$(FMT_BASE)" | \
+		xargs -0 -n 1 $(LLFORMAT_BIN) -w
 
 lint: docker-tools
 	@$(call print, "Linting source.")

scripts/llformat-files.sh

@@ -0,0 +1,72 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+usage() {
+	echo "usage: $0 all|changed [base]" >&2
+}
+
+is_format_file() {
+	local file="$1"
+
+	[[ -f "$file" ]] || return 1
+	[[ "$file" == *.go ]] || return 1
+
+	case "$file" in
+	*.pb.go | *.pb.gw.go | *.pb.json.go | *.pb.validate.go | \
+		*.connect.go | *.gen.go | *_gen.go | *_generated.go | \
+		*.sql.go | db.go | */db.go | models.go | */models.go | \
+		querier.go | */querier.go | .git/* | */.git/* | \
+		vendor/* | */vendor/* | third_party/* | */third_party/* | \
+		testdata/* | */testdata/*)
+		return 1
+		;;
+	esac
+
+	return 0
+}
+
+print_file() {
+	local file="$1"
+
+	if is_format_file "$file"; then
+		printf '%s\0' "$file"
+	fi
+}
+
+list_all() {
+	local file
+
+	while IFS= read -r -d '' file; do
+		print_file "${file#./}"
+	done < <(find . -type f -name '*.go' -print0)
+}
+
+list_changed() {
+	local base="$1"
+	local file
+
+	{
+		git diff --name-only --diff-filter=ACMR "$base"...HEAD
+		git diff --name-only --diff-filter=ACMR
+		git diff --cached --name-only --diff-filter=ACMR
+		git ls-files --others --exclude-standard
+	} | sort -u | while IFS= read -r file; do
+		print_file "$file"
+	done
+}
+
+mode="${1:-}"
+
+case "$mode" in
+all)
+	list_all
+	;;
+changed)
+	list_changed "${2:-origin/master}"
+	;;
+*)
+	usage
+	exit 2
+	;;
+esac

tools/go.mod

@@ -3,6 +3,7 @@ module github.com/lightninglabs/loop/tools
 go 1.26
 
 require (
+	github.com/bhandras/llformat v0.1.1-beta // indirect
 	// Once golangci-lint v2.4.1 update it here.
 	github.com/golangci/golangci-lint/v2 v2.10.1
 	github.com/rinchsan/gosimports v0.3.8
@@ -222,3 +223,8 @@ require (
 	go.augendre.info/fatcontext v0.9.0 // indirect
 	go.yaml.in/yaml/v3 v3.0.4 // indirect
 )
+
+tool (
+	github.com/bhandras/llformat/cmd/llformat
+	github.com/golangci/golangci-lint/v2/cmd/golangci-lint
+)

tools/go.sum

@@ -102,6 +102,8 @@ github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24
 github.com/beorn7/perks v1.0.0/go.mod h1:KWe93zE9D1o94FZ5RNwFwVgaQK1VOXiVxmqh+CedLV8=
 github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
 github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
+github.com/bhandras/llformat v0.1.1-beta h1:eXOyGfkvISWM7d5RUcwhvXPidEsDwLzOB1LN+d5FE9Q=
+github.com/bhandras/llformat v0.1.1-beta/go.mod h1:fudtFasc8GnV1JFw+tB9tb7W0wj7IRUvUdGkOaw+q0s=
 github.com/bkielbasa/cyclop v1.2.3 h1:faIVMIGDIANuGPWH031CZJTi2ymOQBULs9H21HSMa5w=
 github.com/bkielbasa/cyclop v1.2.3/go.mod h1:kHTwA9Q0uZqOADdupvcFJQtp/ksSnytRMe8ztxG8Fuo=
 github.com/blizzy78/varnamelen v0.8.0 h1:oqSblyuQvFsW1hbBHh1zfwrKe3kcSj0rnXkKzsQ089M=