oldas/Makefile at main · davep/oldas · 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
lib      := oldas
src      := src/
tests    := tests/
docs     := docs/
run      := uv run --env-file .env
sync     := uv sync
build    := uv build
publish  := uv publish --username=__token__ --keyring-provider=subprocess
test     := $(run) pytest
python   := $(run) python
ruff     := $(run) ruff
lint     := $(ruff) check
fmt      := $(ruff) format
mypy     := $(run) mypy
mkdocs   := $(run) mkdocs
spell    := $(run) codespell

##############################################################################
# Local "interactive testing" of the code.
.PHONY: run
run:				# Run the code in a testing context
	$(python) -m $(lib)

##############################################################################
# Setup/update packages the system requires.
.PHONY: setup
setup:				# Set up the repository for development
	$(sync)
	$(run) pre-commit install

.PHONY: update
update:				# Update all dependencies
	$(sync) --upgrade

.PHONY: resetup
resetup: realclean		# Recreate the virtual environment from scratch
	make setup

##############################################################################
# Checking/testing/linting/etc.
.PHONY: lint
lint:				# Check the code for linting issues
	$(lint) $(src) $(tests)

.PHONY: codestyle
codestyle:			# Is the code formatted correctly?
	$(fmt) --check $(src) $(tests)

.PHONY: typecheck
typecheck:			# Perform static type checks with mypy
	$(mypy) --scripts-are-modules $(src) $(tests)

.PHONY: stricttypecheck
stricttypecheck:	        # Perform a strict static type checks with mypy
	$(mypy) --scripts-are-modules --strict $(src) $(tests)

.PHONY: test
test:				# Run the unit tests
	$(test) -v

.PHONY: spellcheck
spellcheck:			# Spell check the code
	$(spell) *.md $(src) $(docs) $(tests)

.PHONY: checkall
checkall: spellcheck codestyle lint stricttypecheck test # Check all the things

##############################################################################
# Documentation.
.PHONY: docs
docs:                           # Generate the system documentation
	$(mkdocs) build

.PHONY: rtfm
rtfm:                           # Locally read the library documentation
	$(mkdocs) serve

.PHONY: publishdocs
publishdocs:			# Set up the docs for publishing
	$(mkdocs) gh-deploy

##############################################################################
# Package/publish.
.PHONY: package
package:			# Package the library
	$(build)

.PHONY: spackage
spackage:			# Create a source package for the library
	$(build) --sdist

.PHONY: testdist
testdist: package			# Perform a test distribution
	$(publish) --index testpypi

.PHONY: dist
dist: package			# Upload to pypi
	$(publish)

##############################################################################
# Utility.
.PHONY: repl
repl:				# Start a Python REPL in the venv.
	$(python)

.PHONY: delint
delint:			# Fix linting issues.
	$(lint) --fix $(src)

.PHONY: pep8ify
pep8ify:			# Reformat the code to be as PEP8 as possible.
	$(fmt) $(src) $(tests)

.PHONY: tidy
tidy: pep8ify delint		# Tidy up the code, fixing lint and format issues.

.PHONY: clean
clean:				# Clean the build directories
	rm -rf dist

.PHONY: realclean
realclean: clean		# Clean the venv and build directories
	rm -rf .venv

.PHONY: help
help:				# Display this help
	@grep -Eh "^[a-z]+:.+# " $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.+# "}; {printf "%-20s %s\n", $$1, $$2}'

##############################################################################
# Housekeeping tasks.
.PHONY: housekeeping
housekeeping:			# Perform some git housekeeping
	git fsck
	git gc --aggressive
	git remote update --prune

### Makefile ends here