Skip to content

Instantly share code, notes, and snippets.

@dsisnero
Forked from straight-shoota/Makefile
Created May 24, 2023 20:27
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save dsisnero/10eb2f5efcd46c4eac0ca4ec39618095 to your computer and use it in GitHub Desktop.
Save dsisnero/10eb2f5efcd46c4eac0ca4ec39618095 to your computer and use it in GitHub Desktop.
Makefile for Crystal + Shards
-include Makefile.local # for optional local options
DOC_SOURCE ::= src/**
BUILD_TARGET ::= bin/app
# The shards command to use
SHARDS ?= shards
# The crystal command to use
CRYSTAL ?= crystal
SRC_SOURCES ::= $(shell find src -name '*.cr' 2>/dev/null)
LIB_SOURCES ::= $(shell find lib -name '*.cr' 2>/dev/null)
SPEC_SOURCES ::= $(shell find spec -name '*.cr' 2>/dev/null)
.PHONY: build
build: ## Build the application binary
build: $(BUILD_TARGET)
$(BUILD_TARGET): $(SRC_SOURCES) $(LIB_SOURCES) lib
mkdir -p $(shell dirname $(@))
$(CRYSTAL) build src/cli.cr -o $(@)
.PHONY: test
test: ## Run the test suite
test: lib
$(CRYSTAL) spec
.PHONY: format
format: ## Apply source code formatting
format: $(SRC_SOURCES) $(SPEC_SOURCES)
$(CRYSTAL) tool format src spec
docs: ## Generate API docs
docs: $(SRC_SOURCES) lib
$(CRYSTAL) docs -o docs $(DOC_SOURCE)
lib: shard.lock
$(SHARDS) install
shard.lock: shard.yml
$(SHARDS) update
.PHONY: clean
clean: ## Remove application binary
clean:
@rm -f $(BUILD_TARGET)
.PHONY: help
help: ## Show this help
@echo
@printf '\033[34mtargets:\033[0m\n'
@grep -hE '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) |\
sort |\
awk 'BEGIN {FS = ":.*?## "}; {printf " \033[36m%-15s\033[0m %s\n", $$1, $$2}'
@echo
@printf '\033[34moptional variables:\033[0m\n'
@grep -hE '^[a-zA-Z_-]+ \?=.*?## .*$$' $(MAKEFILE_LIST) |\
sort |\
awk 'BEGIN {FS = " \\?=.*?## "}; {printf " \033[36m%-15s\033[0m %s\n", $$1, $$2}'
@echo
@printf '\033[34mrecipes:\033[0m\n'
@grep -hE '^##.*$$' $(MAKEFILE_LIST) |\
awk 'BEGIN {FS = "## "}; /^## [a-zA-Z_-]/ {printf " \033[36m%s\033[0m\n", $$2}; /^## / {printf " %s\n", $$2}'
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment