go-flashduty/Makefile at main · flashcatcloud/go-flashduty · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
# go-flashduty — developer tasks. Mirrors the flashcatcloud org convention
# (see flashduty-mcp-server) for fmt / gci / lint.

# Tooling
BUILD_DIR := bin
GOLANGCI_LINT_VERSION := v2.11.4
GOLANGCI_LINT := $(BUILD_DIR)/golangci-lint
GCI_VERSION := v0.13.5
GCI := $(BUILD_DIR)/gci

# Go
GOCMD := go
GOFMT := gofmt
MODULE := $(shell $(GOCMD) list -m)

# The vendored OpenAPI under openapi/ is a synced copy of the single source of
# truth in the public flashduty-docs repo. Override to sync from a branch or a
# local checkout (e.g. DOCS_SPEC_BASE=file:///abs/path/to/flashduty-docs/api-reference).
DOCS_SPEC_BASE ?= https://raw.githubusercontent.com/flashcatcloud/flashduty-docs/main/api-reference

# Source roots to format (whole module; gci skips generated files itself).
FMT_DIRS := .

.PHONY: all
all: check

# ---------------------------------------------------------------------------
# Build / generate / test
# ---------------------------------------------------------------------------

.PHONY: build
build: ## Compile all packages
	$(GOCMD) build ./...

.PHONY: generate
generate: ## Regenerate the typed service layer from the OpenAPI spec
	$(GOCMD) generate ./...

.PHONY: sync-spec
sync-spec: ## Refresh vendored OpenAPI from flashduty-docs (run 'make generate' after)
	curl -sSfL "$(DOCS_SPEC_BASE)/openapi.en.json" -o openapi/openapi.en.json
	curl -sSfL "$(DOCS_SPEC_BASE)/openapi.zh.json" -o openapi/openapi.zh.json
	@echo "Synced openapi/ from $(DOCS_SPEC_BASE). Run 'make generate' to regenerate."

.PHONY: test
test: ## Run unit tests with the race detector
	$(GOCMD) test -race ./...

.PHONY: e2e
e2e: ## Run live E2E tests (needs FLASHDUTY_E2E_APP_KEY [+ FLASHDUTY_E2E_BASE_URL])
	@if [ -z "$$FLASHDUTY_E2E_APP_KEY" ] && [ -z "$$FLASHDUTY_APP_KEY" ]; then \
		echo "Error: set FLASHDUTY_E2E_APP_KEY (and optionally FLASHDUTY_E2E_BASE_URL)"; \
		exit 1; \
	fi
	$(GOCMD) test -v -tags e2e ./e2e/... -timeout 10m

# ---------------------------------------------------------------------------
# Formatting / linting
# ---------------------------------------------------------------------------

.PHONY: fmt
fmt: $(GCI) ## Format source and sort imports (gofmt -s + gci)
	$(GOFMT) -s -w $(FMT_DIRS)
	$(GCI) write --skip-generated -s standard -s default -s "prefix($(MODULE))" $(FMT_DIRS)

.PHONY: gci
gci: $(GCI) ## Sort imports only
	$(GCI) write --skip-generated -s standard -s default -s "prefix($(MODULE))" $(FMT_DIRS)

.PHONY: lint
lint: $(GOLANGCI_LINT) ## Run golangci-lint
	$(GOLANGCI_LINT) run

.PHONY: lint-fix
lint-fix: $(GOLANGCI_LINT) ## Run golangci-lint with --fix
	$(GOLANGCI_LINT) run --fix

# ---------------------------------------------------------------------------
# Aggregate / tooling
# ---------------------------------------------------------------------------

.PHONY: check
check: fmt lint test build ## Pre-push: fmt, lint, test, build

.PHONY: tools
tools: $(GOLANGCI_LINT) $(GCI) ## Install pinned dev tools into ./bin

$(BUILD_DIR):
	mkdir -p $(BUILD_DIR)

$(GOLANGCI_LINT): $(BUILD_DIR)
	@if [ ! -f "$(GOLANGCI_LINT)" ]; then \
		echo "Installing golangci-lint $(GOLANGCI_LINT_VERSION)..."; \
		curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(BUILD_DIR) $(GOLANGCI_LINT_VERSION); \
	fi

$(GCI): $(BUILD_DIR)
	@if [ ! -f "$(GCI)" ]; then \
		echo "Installing gci $(GCI_VERSION)..."; \
		GOBIN=$(CURDIR)/$(BUILD_DIR) $(GOCMD) install github.com/daixiang0/gci@$(GCI_VERSION); \
	fi

.PHONY: help
help: ## Show this help
	@grep -hE '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[36m%-14s\033[0m %s\n", $$1, $$2}'