py-buzz/Makefile at main · dusktreader/py-buzz · 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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
PACKAGE_TARGET:=src/buzz

default: help


## ==== Quality Control ================================================================================================

qa: qa/full  ## Shortcut for qa/full

qa/test:  ## Run the tests
	@uv run pytest

qa/types:  ## Run static type checks
	@uv run ty check ${PACKAGE_TARGET} tests

qa/lint:  ## Run linters
	@uv run ruff check ${PACKAGE_TARGET} tests src/buzz_demo
	@uv run typos ${PACKAGE_TARGET} tests src/buzz_demo
	@uv run yamllint -d "{extends: relaxed, rules: {line-length: disable, colons: {max-spaces-after: 2}}}" .github/ docs/ .pre-commit-config.yaml

qa/full: qa/test qa/lint qa/types  ## Run the full set of quality checks
	@echo "All quality checks pass!"

qa/format:  ## Run code formatter
	@uv run ruff check --select I --fix ${PACKAGE_TARGET} tests src/buzz_demo
	@uv run ruff format ${PACKAGE_TARGET} tests src/buzz_demo

qa/mutate:  ## Run mutation testing (slow, not part of qa/full)
	@uv run mutmut run


## ==== Documentation ==================================================================================================

docs: docs/serve  ## Shortcut for docs/serve

docs/build:  ## Build the documentation
	@uv run mkdocs build --config-file=docs/mkdocs.yaml

docs/serve:  ## Build the docs and start a local dev server
	@uv run mkdocs serve --config-file=docs/mkdocs.yaml --dev-addr=localhost:10000


## ==== Demo ===========================================================================================================

demo: demo/run  ## Shortcut for demo/run

demo/run:  ## Run the demo application
	@uv run --extra=demo py-buzz-demo

demo/debug:  ## Run the demo application in debug mode
	@uv run --extra=demo debugpy --listen localhost:5678 --wait-for-client py-buzz-demo


## ==== Other Commands =================================================================================================

publish: _confirm  ## Publish the package by pushing a tag with the current version
	@if [[ "$$(git rev-parse --abbrev-ref HEAD)" != "main" ]]; then \
		echo "You must be on the main branch to publish." && exit 1; \
	fi
	@git tag v$$(uv version --short) && git push origin v$$(uv version --short)


## ==== Helpers ========================================================================================================

hooks:  ## Install/update pre-commit hooks
	@uv run pre-commit install --hook-type=pre-commit --hook-type=pre-push

clean:  ## Clean up build artifacts and other junk
	@rm -rf .venv
	@uv run pyclean . --debris
	@rm -rf dist
	@rm -rf .ruff_cache
	@rm -rf .pytest_cache
	@rm -rf .mypy_cache
	@rm -f .coverage*
	@rm -f .junit.xml
	@rm -rf .mutmut-cache
	@rm -rf mutants

help:  ## Show help message
	@awk "$$PRINT_HELP_PREAMBLE" $(MAKEFILE_LIST)


# ..... Make configuration .............................................................................................

.ONESHELL:
SHELL:=/bin/bash
.PHONY: qa qa/test qa/types qa/lint qa/full qa/format qa/mutate \
	docs docs/build docs/serve \
	demo demo/run demo/debug \
	publish \
	hooks clean help


# ..... Color table for pretty printing ................................................................................

RED    := \033[31m
GREEN  := \033[32m
YELLOW := \033[33m
BLUE   := \033[34m
TEAL   := \033[36m
GRAY   := \033[90m
CLEAR  := \033[0m
ITALIC := \033[3m


# ..... Hidden auxiliary targets .......................................................................................

_confirm:  # Requires confirmation before proceeding (Do not use directly)
	@if [[ -z "$(CONFIRM)" ]]; then \
		echo -n "Are you sure? [y/N] " && read ans && [ $${ans:-N} = y ]; \
	fi


# ..... Help printer ...................................................................................................

define PRINT_HELP_PREAMBLE
BEGIN {
	print "Usage: $(YELLOW)make <target>$(CLEAR)"
	print
	print "Targets:"
}
/^## =+ .+( =+)?/ {
    s = $$0
    sub(/^## =+ /, "", s)
    sub(/ =+/, "", s)
	printf("\n  %s:\n", s)
}
/^## -+ .+( -+)?/ {
    s = $$0
    sub(/^## -+ /, "", s)
    sub(/ -+/, "", s)
	printf("\n    $(TEAL)> %s$(CLEAR)\n", s)
}
/^[$$()% 0-9a-zA-Z_\/-]+(\\:[$$()% 0-9a-zA-Z_\/-]+)*:.*?##/ {
    t = $$0
    sub(/:.*/, "", t)
    h = $$0
    sub(/.?*##/, "", h)
    printf("    $(YELLOW)%-19s$(CLEAR) $(GRAY)$(ITALIC)%s$(CLEAR)\n", t, h)
}
endef
export PRINT_HELP_PREAMBLE