Merge pull request #171 from Jens0512/misc/makefile_improvements

Misc/makefile improvements

.gitignore

@@ -1,13 +1,18 @@
 *~
 
+# Local files
+/local/
+
 # Build artifacts and dependencies
 /lib/
 /bin/
 /.shards/
 
 # Crystal generated docs
 /docs/
+
 # The myst executable
 /myst
+
 # DWARF file from compiling on macOS
-/myst.dwarf
+*.dwarf

Makefile

@@ -1,22 +1,128 @@
-.PHONY: help clean spec mystspec
+# Because env `SHELL` might be 
+# some extremely weird shell
+SHELL = bash
 
-spec:      ## Runs all specs
-	crystal spec
-	crystal run src/myst_cli.cr -- spec/myst/spec.mt
+# https://www.gnu.org/software/make/manual/html_node/One-Shell.html
+.ONESHELL:
 
-myst-spec: ## Runs just the in-language specs
-	crystal run src/myst_cli.cr -- spec/myst/spec.mt
-
-build:     ## Builds myst into an executable
-	shards build
+MYST_CLI = src/myst_cli.cr
 
-check:     ## Runs all crystal specs
-	crystal spec/
+MYST_INTERPRETER_SPEC = spec/all_spec.cr
+MYST_IN_LANG_SPEC     = spec/myst/spec.mt
 
-clean:     ## Cleans (deletes) docs and executables
-	rm -rf docs
-	rm bin/*
+SOURCE_FILES := $(shell find src    -type f -name '*.cr')
+SPEC_FILES   := $(shell find spec   -type f -name '*.cr' -o -name '*.mt')
+STDLIB_FILES := $(shell find stdlib -type f -name '*.mt')
+ALL_FILES    := $(SPEC_FILES) $(STDLIB_FILES) $(SOURCE_FILES)
 
-# https://gist.github.com/prwhite/8168133 "Help target"
-help:      ## Show this help.
-	@fgrep -h "##" $(MAKEFILE_LIST) | fgrep -v fgrep | sed -e 's/\\$$//' | sed -e 's/##//'
+INSTALL_LOCATION ?= /usr/local/bin/myst
+MYSTBUILD        ?= myst
+
+OUT ?= bin
+
+info ?= true
+
+# If another default is wished for,
+# set it in local/*.mk, like this:
+# .DEFAULT_GOAL = goal
+# 
+.DEFAULT_GOAL = spec
+
+# Parse makefiles named *.mk in the dir `local`
+# for local extra makefile targets if wanted.
+# It is smart to set MYSTBUILD to your myst dev-build there
+-include local/*.mk
+
+info_log = $(if $(subst false,,$(info)),$(info $(1)))
+
+# Makefile convention 
+.PHONY: all
+all: $(OUT)/myst $(OUT)/spec
+
+.PHONY: spec
+spec: itr-spec myst-spec ## Runs all specs
+
+.PHONY: myst-spec
+myst-spec: $(OUT)/myst ## Runs just the in-language specs
+	$(call info_log,Running in-language spec)
+	$(OUT)/myst $(MYST_IN_LANG_SPEC)
+
+.PHONY: itr-spec
+itr-spec: $(OUT)/spec ## Runs just the interpreter specs
+	$(call info_log,Running interpreter spec)
+	$(OUT)/spec
+
+.PHONY: install
+install: $(INSTALL_LOCATION) ## Install myst to INSTALL_LOCATION		
+
+.PHONY: build
+build: $(OUT)/myst ## Builds myst into an executable
+
+.PHONY: myst-spec_with_build
+myst-spec_with_build: ## Runs the in-language specs with MYSTBUILD
+	$(MYSTBUILD) $(MYST_IN_LANG_SPEC)
+
+$(OUT)/myst: $(SOURCE_FILES)
+	$(call info_log,Building myst...)
+	mkdir -p $(OUT)
+	crystal build -o $(OUT)/myst $(MYST_CLI)
+
+$(OUT)/spec: $(ALL_FILES)
+	$(call info_log,Building specs...)
+	mkdir -p $(OUT)
+	crystal build -o $(OUT)/spec $(MYST_INTERPRETER_SPEC)
+
+$(INSTALL_LOCATION): $(SOURCE_FILES)
+	$(call info_log,Installing myst to $(INSTALL_LOCATION) ...)
+	mkdir -p $(dir $(INSTALL_LOCATION))	
+	sudo crystal build --release -o $(INSTALL_LOCATION) $(MYST_CLI)	
+
+.PHONY: clean
+clean: ## Cleans (deletes) docs and executables	
+ifdef OUT	
+	@[ -f $(OUT)/myst ] && rm -f $(OUT)/myst*
+	@[ -f $(OUT)/spec ] && rm -f $(OUT)/spec*
+endif
+	@rm -rf docs
+	@
+
+# Thanks https://stackoverflow.com/questions/4219255/how-do-you-get-the-list-of-targets-in-a-makefile/26339924#26339924
+define TARGET_LIST =
+$(shell \
+	$(MAKE) -pRrq -f $(MAKEFILE_LIST) : 2>/dev/null | awk -v RS= -F: '/^# File/,/^# Finished Make data base/ {if ($$1 !~ "^[#.]") {print $$1}}' |\
+	sort |\
+	egrep -v -e '^[^[a-zA-Z0-9]]' -e '^$@$$' |\
+	xargs )
+endef
+
+# Used in help target
+list:
+	@echo $(TARGET_LIST)
+
+HELP_INDENTATION 	 ?= 2
+HELP_NAME-DESC_SEP ?= 2
+
+LENGTH_OF_LONGEST_TARGET_NAME = $(shell ruby -e 'puts ARGV.sort_by(&:size)[-1].size' $$(make list))
+
+parse_help = perl -n -e \
+	'if(/^(\S*)?(?=:).*$(HELP_MARK)\s*(.*)/){ \
+		print((" " x $(HELP_INDENTATION)) . "$$1" . (" " x ($(LENGTH_OF_LONGEST_TARGET_NAME) + $(HELP_NAME-DESC_SEP) - length($$1))) . "- $$2\n") \
+	}' $(1) |\
+	sort
+
+# Help target that reads text after two '#'s in a target definition and prints it after the target name
+.PHONY: help
+help: ## Show this help
+	@echo "The main targets are:"
+	@$(call parse_help, $(firstword $(MAKEFILE_LIST))); echo
+	# Iterate through the extra optional makefiles
+	@for makefile in $(wordlist 2, $(words $(MAKEFILE_LIST)), $(MAKEFILE_LIST)); do 
+		echo "Targets defined in $$makefile:"
+			$(call parse_help, $$makefile)
+		echo
+	done
+	@echo "The default target is '$(.DEFAULT_GOAL)'"
+
+define HELP_MARK
+##
+endef

spec/all_spec.cr

@@ -0,0 +1 @@
+require "./**"

src/myst/cli.cr

@@ -1,7 +1,7 @@
 require "option_parser"
 
 module Myst
-  class Cli
+  class CLI
     def self.run
       source = ""
       show_ast = false

src/myst_cli.cr

@@ -2,4 +2,4 @@ require "./myst"
 
 include Myst
 
-Cli.run
+CLI.run