Last active
March 22, 2025 13:36
-
-
Save kieronlanning/0bd4dedab604ea401a40452f39033c59 to your computer and use it in GitHub Desktop.
Makefile _include_ that auto populates `.PHONY` and generates help information based on targets. Include in your Makefile with: `include common.mk`
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Define the default target | |
.DEFAULT_GOAL := help | |
# Include this in your Makefile using 'include common.mk' | |
# ANSI colour codes for formatting (used for coloured output in help) | |
COLOUR_TARGET = \033[1;34m # Blue, bold | |
COLOUR_RESET = \033[0m # Reset colour | |
# Automatically calculate the maximum target width (without colour) | |
TARGET_WIDTH := $(shell grep -Eh '^[a-zA-Z_-]+:.*?##' $(MAKEFILE_LIST) | awk -F':' '{print length($$1)}' | sort -nr | head -1) | |
# Collect all targets from the Makefile and included files | |
PHONY_TARGETS := $(shell grep -Eh '^[a-zA-Z_-]+:.*?##' $(MAKEFILE_LIST) | awk -F':' '{print $$1}') # OR ... '{print $$1}' | sort -u) | |
# Declare all the targets as phony | |
.PHONY: $(PHONY_TARGETS) | |
# Help target that reads targets from all Makefiles listed in MAKEFILE_LIST | |
help: | |
@echo "Available targets:" | |
@grep -Eh '^[a-zA-Z_-]+:.*?##' $(MAKEFILE_LIST) | \ | |
#sort -u | \ # <-- Include this to sort the targets. | |
awk -v COLOUR_target="$(COLOUR_TARGET)" -v COLOUR_reset="$(COLOUR_RESET)" -v width=$(TARGET_WIDTH) '\ | |
BEGIN {FS = ":.*## "}; \ | |
{ \ | |
target = $$1; \ | |
description = $$2; \ | |
printf "%s%-*s%s %s\n", COLOUR_target, width, target, COLOUR_reset, description \ | |
}' |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
include .\common.mk | |
hello: ## Displays 'Hello, World!' | |
@echo "Hello, World!" | |
# Run make, and the 'help' target displays information about commented (## help text) targets. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment