A Makefile that documents itself

Plaintext

Running make with no arguments prints every target that carries a comment.

.DEFAULT_GOAL := help

help:  ## Show this help
	@grep -E '^[a-zA-Z_-]+:.*?## ' $(MAKEFILE_LIST) \
	  | awk 'BEGIN {FS = ":.*?## "}; {printf "  %-14s %s\n", $$1, $$2}'

build:  ## Compile the assets
	npm run build

test:  ## Run the test suite
	npm test

.PHONY: help build test

Download

Build & CI make tooling docs chris

More in Build & CI

Cache busting with a content hash Build & CI Names the built file after its contents so a deploy invalidates the cache without a version bump. A GitHub Actions workflow for a Node project Build & CI Caches the dependency install, runs on a matrix of versions, and fails the build on a lint error. Pin a dependency to an exact version Build & CI Caret ranges are how a build that passed last week fails today. Exact versions plus a lockfile remove the surprise.

Random picks

Which DNS records does a domain have? Networking dig with +short strips everything but the answer. Async/await with a task group in Swift Systems Runs the downloads concurrently and collects them, with cancellation propagating to all of them. A dataclass with validation Python __post_init__ runs after the generated constructor, which is where cheap invariants belong. An RSS feed skeleton Data Formats The minimum a reader needs. Dates must be RFC 822, which is the part most generators get wrong. A regular expression for ISO 8601 dates Text Processing Matches a date, optionally with a time and a zone. Deliberately strict about separators. Rename a batch of files with a pattern Shell Strips a prefix from every file in a directory using shell parameter expansion, no rename utility required. Group an array by a key JavaScript Object.groupBy is available in current runtimes; the reduce version is the fallback for older ones. Fetch with a timeout JavaScript fetch has no timeout of its own. AbortSignal.timeout is the short way to give it one.