Improve Makefile

Signed-off-by: Pedro B S Lisboa <[email protected]>

Author: pedrobslisboa

Makefile

@@ -1,42 +1,75 @@
 INSTALL_ARGS := $(if $(PREFIX),--prefix $(PREFIX),)
+EXAMPLE_DESCRIPTIONS := \
+	"example-building-ast:Demonstrates how to build AST" \
+	"example-destructuring-ast:Demonstrates how to destructure an AST" \
 
-# Default rule
+.PHONY: help
+help:
+	@echo "";
+	@echo "List of available make commands";
+	@echo "";
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2}';
+	@echo "";
+	@echo "Available examples:";
+	@echo "";
+	@for desc in $(EXAMPLE_DESCRIPTIONS); do \
+		target=$$(echo $$desc | cut -d: -f1); \
+		description=$$(echo $$desc | cut -d: -f2); \
+		printf "  \033[36m%-30s\033[0m %s\n" "$$target" "$$description"; \
+	done
+	@echo "";
+
+.PHONY: default
 default:
 	dune build --auto-promote @install
 
+.PHONY: install
 install:
 	dune install $(INSTALL_ARGS)
 
+.PHONY: uninstall
 uninstall:
 	dune uninstall $(INSTALL_ARGS)
 
-reinstall: uninstall reinstall
+.PHONY: reinstall
+reinstall:
+	uninstall reinstall
 
+.PHONY: test
 test:
 	dune runtest
 
+.PHONY: doc
 doc:
 	dune build @doc
 
+.PHONY: doc-dev
+doc-dev:
+	dune build @doc --watch & dune_pid=$$!; \
+	trap 'kill $$dune_pid' EXIT; \
+	sleep 2 && open _build/default/_doc/_html/index.html & \
+	wait $$dune_pid
+
+.PHONY: clean
 clean:
 	dune clean
 
+.PHONY: all-supported-ocaml-versions
 all-supported-ocaml-versions:
 	dune build @install --workspace dune-workspace.dev --root .
 
+.PHONY: opam-release
 opam-release:
 	dune-release distrib --skip-build --skip-lint --skip-tests
 	dune-release publish distrib --verbose
 	dune-release opam pkg
 	dune-release opam submit
 
+.PHONY: bench
 bench:
 	dune build bench --profile release
 	dune exec bench/bench.exe
 
-.PHONY: default install uninstall reinstall clean test doc bench
-.PHONY: all-supported-ocaml-versions opam-release
-
 .PHONY: $(TARGET)
 example-%: 
-	DUNE_CONFIG__GLOBAL_LOCK=disabled opam exec -- dune exec $*-example
+	opam exec -- dune exec $*-example

doc/dune

@@ -1,13 +1,2 @@
 (documentation
  (package ppxlib))
-
-(rule
- (alias doc)
- (deps
-  (glob_files ./images/*))
- (action
-  (progn
-   (system "mkdir -p %{project_root}/_doc/_html/ppxlib/assets/images")
-   (system "chmod -R a+rw %{project_root}/_doc/_html/ppxlib/assets/images")
-   (system
-    "cp -R ./images/ %{project_root}/_doc/_html/ppxlib/assets/images/"))))