dev: Makefile using Practicalli book task definitions

Author: practicalli-johnny

CHANGELOG.md

@@ -1,14 +1,15 @@
 # Changelog
 
 ## Unreleased
-- dev: spell lychee & repository trufflehog linters warn only (false positives) 
+- dev: spell lychee & repository trufflehog linters warn only (false positives)
 - dev: action/checkout v4 with sparse-checkout for megalinter
 - dev: sparse-checkout for publish-book workflow
 - dev: action/checkout v4 with sparse-checkout for changelog checker workflow
 - mkdocs: update emoji extension name for material 9.4 and update readme
 
 ### Added
 - building-api: add reitit overview and quick intro
+- dev: Makefile using Practicalli task definitions for books
 
 ### Changed
 - nav: refactor server-side-api to building-api

Makefile

@@ -8,65 +8,65 @@
 # https://makefiletutorial.com/#phony
 .PHONY: all clean docs lint pre-commit-check test
 
-
 # ------- Makefile Variables --------- #
-
 # run help if no target specified
 .DEFAULT_GOAL := help
+SHELL := /usr/bin/zsh
 
 # Column the target description is printed from
 HELP-DESCRIPTION-SPACING := 24
 
+# Tool Commands
+MEGALINTER_RUNNER := npx mega-linter-runner --flavor documentation --env "'MEGALINTER_CONFIG=.github/config/megalinter.yaml'" --env "'VALIDATE_ALL_CODEBASE=true'"  --remove-container
+MKDOCS_SERVER := mkdocs serve --dev-addr localhost:7777
+
 # Makefile file and directory name wildcard
 EDN-FILES := $(wildcard *.edn)
-
 # ------------------------------------ #
 
-
 # ------  Quality Checks  ------------ #
-
 pre-commit-check: lint
 
 lint:  ## Run MegaLinter with custom configuration (node.js required)
 	$(info --------- MegaLinter Runner ---------)
-	npx mega-linter-runner --flavor documentation --release beta --env "'MEGALINTER_CONFIG=.github/config/megalinter.yaml'" --remove-container
-
+	$(MEGALINTER_RUNNER)
 
 lint-fix:  ## Run MegaLinter with custom configuration (node.js required)
 	$(info --------- MegaLinter Runner ---------)
-	npx mega-linter-runner --fix --flavor documentation --release beta --env "'MEGALINTER_CONFIG=.github/config/megalinter.yaml'" --remove-container
+	$(MEGALINTER_RUNNER) --fix
 
 lint-clean:  ## Clean MegaLinter report information
 	$(info --------- MegaLinter Clean Reports ---------)
 	- rm -rf ./megalinter-reports
 
+megalinter-upgrade:  ## Upgrade MegaLinter config to latest version
+	$(info --------- MegaLinter Upgrade Config ---------)
+	npx mega-linter-runner@latest --upgrade
 # ------------------------------------ #
 
-
 # --- Documentation Generation  ------ #
-
-docs:  ## Build and run mkdocs in local server
+python-venv:  ## Enable Python Virtual Environment for MkDocs
 	$(info --------- Mkdocs Local Server ---------)
-	mkdocs serve --dev-addr localhost:7777
+	source ~/.local/venv/bin/activate
 
-docs-changed:  ## Build only changed files and run mkdocs in local server
+docs: ## Build and run mkdocs in local server (python venv)
 	$(info --------- Mkdocs Local Server ---------)
-	mkdocs serve --dirtyreload --dev-addr localhost:7777
+	source ~/.local/venv/bin/activate && $(MKDOCS_SERVER)
 
-docs-build:  ## Build mkdocs
+docs-changed:  ## Build only changed files and run mkdocs in local server (python venv)
 	$(info --------- Mkdocs Local Server ---------)
-	mkdocs build
+	source ~/.local/venv/bin/activate && $(MKDOCS_SERVER) --dirtyreload
 
+docs-build:  ## Build mkdocs (python venv)
+	$(info --------- Mkdocs Local Server ---------)
+	source ~/.local/venv/bin/activate && mkdocs build
 # ------------------------------------ #
 
-
 # ------------ Help ------------------ #
-
 # Source: https://nedbatchelder.com/blog/201804/makefile_help_target.html
 
 help:  ## Describe available tasks in Makefile
 	@grep '^[a-zA-Z]' $(MAKEFILE_LIST) | \
 	sort | \
 	awk -F ':.*?## ' 'NF==2 {printf "\033[36m  %-$(HELP-DESCRIPTION-SPACING)s\033[0m %s\n", $$1, $$2}'
-
 # ------------------------------------ #