typeid-python/Makefile at main · akhundMurad/typeid-python · 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
# ==============================================================================
# Project configuration
# ==============================================================================

PACKAGE      := typeid
TESTS        := tests
DIST_DIR     := dist
VENV_DIR     := .venv

UV           := uv run
PYTEST       := $(UV) pytest
RUFF         := $(UV) ruff
BLACK        := $(UV) black
MYPY         := $(UV) mypy

# ==============================================================================
# Phony targets
# ==============================================================================

.PHONY: help lint lint-fix test test-docs docs docs-build build-sdist clean

# ==============================================================================
# Help
# ==============================================================================

help:
	@echo "Available targets:"
	@echo ""
	@echo "  lint         Run all linters (ruff, black, mypy)"
	@echo "  lint-fix     Automatically fix linting issues"
	@echo "  test         Run test suite"
	@echo "  test-docs    Run documentation tests"
	@echo "  docs         Serve documentation locally"
	@echo "  docs-build   Build documentation"
	@echo "  build-sdist  Build source distribution"
	@echo "  clean        Remove build artifacts"
	@echo ""

# ==============================================================================
# Linting
# ==============================================================================

lint:
	$(RUFF) check $(PACKAGE)/ $(TESTS)/
	$(BLACK) --check --diff $(PACKAGE)/ $(TESTS)/
	$(MYPY) $(PACKAGE)/

lint-fix:
	$(RUFF) check --fix $(PACKAGE)/ $(TESTS)/
	$(BLACK) $(PACKAGE)/ $(TESTS)/

# ==============================================================================
# Testing
# ==============================================================================

test:
	$(PYTEST) -v $(TESTS)

test-docs:
	$(PYTEST) README.md docs/ --markdown-docs

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

docs:
	mkdocs serve

docs-build:
	mkdocs build

# ==============================================================================
# Build & cleanup
# ==============================================================================

build-sdist: clean
	@uv build --sdist -o $(DIST_DIR)
	@ls -la $(DIST_DIR)

clean:
	@rm -rf $(DIST_DIR) build *.egg-info $(VENV_DIR)