Prettify make output commentary

Author: reece

Makefile

@@ -1,54 +1,107 @@
-.PHONY: install
-install: ## Install the virtual environment and install the pre-commit hooks
-	@echo "🚀 Creating virtual environment using uv"
-	@uv sync
-	@uv run pre-commit install
+.DELETE_ON_ERROR:
+.PHONY: FORCE
+.PRECIOUS:
+.SUFFIXES:
 
-.PHONY: check
-check: ## Run code quality tools.
-	@echo "🚀 Checking lock file consistency with 'pyproject.toml'"
-	@uv lock --locked
-	@echo "🚀 Linting code: Running pre-commit"
-	@uv run pre-commit run -a
-	#@echo "🚀 Static type checking: Running ty"
-	#@uv run ty check
-	@echo "🚀 Checking for obsolete dependencies: Running deptry"
-	@uv run deptry src
+.DEFAULT_GOAL := help
+default: help
 
-.PHONY: test
-test: ## Test the code with pytest
-	@echo "🚀 Testing code: Running pytest"
-	@uv run python -m pytest # --cov --cov-config=pyproject.toml --cov-report=xml
+SHELL:=/bin/bash
 
-.PHONY: build
-build: clean-build ## Build wheel file
-	@echo "🚀 Creating wheel file"
-	@uvx --from build pyproject-build --installer uv
+COLOR_RESET=\033[0m
+COLOR_CYAN_BOLD=\033[1;36m
+define ECHO_BANNER
+	@echo -e "⏩$(COLOR_CYAN_BOLD)$(1)$(COLOR_RESET)"
+endef
+
+############################################################################
+#= BASIC USAGE
 
-.PHONY: clean-build
-clean-build: ## Clean build artifacts
-	@echo "🚀 Removing build artifacts"
-	@uv run python -c "import shutil; import os; shutil.rmtree('dist') if os.path.exists('dist') else None"
+.PHONY: help
+help: ## Display help message
+	@uvx python -c "import re; \
+	[[print(f'- \033[36m{m[0]:<20}\033[0m {m[1]}') for m in re.findall(r'^([\sa-zA-Z_-]+):.*?## (.*)$$', open(makefile).read(), re.M)] for makefile in ('$(MAKEFILE_LIST)').strip().split()]" | sort
+
+
+############################################################################
+#= SETUP, INSTALLATION, PACKAGING
+
+install: devready
+.PHONY: devready
+devready: ## Prepare local dev env: Create virtual env, install the pre-commit hooks
+	$(call ECHO_BANNER, "Prepare local dev env: Create virtual env, install the pre-commit hooks")
+	uv sync --dev
+	uvx pre-commit install
+
+.PHONY: build
+build: ## Build package
+	$(call ECHO_BANNER, "Building package")
+	rm -fr dist
+	uvx --from build pyproject-build --installer uv
 
 .PHONY: publish
 publish: ## Publish a release to PyPI.
-	@echo "🚀 Publishing."
-	@uvx twine upload --repository-url https://upload.pypi.org/legacy/ dist/*
+	$(call ECHO_BANNER, "Publishing to PyPI.")
+	uvx publish
+
 
-.PHONY: build-and-publish
-build-and-publish: build publish ## Build and publish.
+############################################################################
+#= TESTING AND CODE QUALITY
+
+.PHONY: check
+cqa check: ## Run code quality tools.
+	$(call ECHO_BANNER, "Checking lock file consistency with 'pyproject.toml'")
+	uv lock --locked
+	$(call ECHO_BANNER, "Linting code: Running pre-commit")
+	uvx pre-commit run -a
+	$(call ECHO_BANNER, "Checking for obsolete dependencies: Running deptry")
+	uvx deptry src
+
+.PHONY: test
+test: ## Test the code with pytest
+	@echo "🚀 Testing code: Running pytest"
+	pytest
+	#uvx python -m pytest # --cov --cov-config=pyproject.toml --cov-report=xml
+
+
+############################################################################
+#= DOCUMENTATION
 
 .PHONY: docs-test
 docs-test: ## Test if documentation can be built without warnings or errors
-	@uv run mkdocs build -s
+	$(call ECHO_BANNER, "Testing whether docs can be build")
+	uvx mkdocs build -s
 
-.PHONY: docs
-docs: ## Build and serve the documentation
-	@uv run mkdocs serve
+.PHONY: serve
+serve: ## Build and serve the documentation
+	$(call ECHO_BANNER, "Build and serve docs for local development")
+	uvx mkdocs serve
 
-.PHONY: help
-help:
-	@uv run python -c "import re; \
-	[[print(f'\033[36m{m[0]:<20}\033[0m {m[1]}') for m in re.findall(r'^([a-zA-Z_-]+):.*?## (.*)$$', open(makefile).read(), re.M)] for makefile in ('$(MAKEFILE_LIST)').strip().split()]"
 
-.DEFAULT_GOAL := help
+############################################################################
+#= CLEANUP
+
+.PHONY: clean
+clean:  ## Remove temporary and backup files
+	$(call ECHO_BANNER, "Remove temporary and backup files")
+	rm -frv **/*~ **/*.bak
+
+.PHONY: cleaner
+cleaner: clean  ## Remove files and directories that are easily rebuilt
+	$(call ECHO_BANNER, "Remove files and directories that are easily rebuilt")
+	rm -frv .cache build dist docs/_build
+	rm -frv **/__pycache__
+	rm -frv **/*.egg-info
+	rm -frv **/*.pyc
+	rm -frv **/*.orig
+	rm -frv **/*.rej
+
+.PHONY: cleanest
+cleanest: cleaner  ## Remove all files that can be rebuilt
+	$(call ECHO_BANNER, "Remove files and directories that can be rebuilt")
+	rm -frv .eggs .tox .venv venv
+
+.PHONY: distclean
+distclean: cleanest  ## Remove untracked files and other detritus
+	@echo "❌ Remove untracked files and other detritus -- Too dangerous... do this yourself"
+	# git clean -df