feat: Add first modules

This adds the first modules blocks from the initial proof of concept, with basic docs. Currently missing is bundling and usage instructions
2023-02-15 00:19:14 +01:00
parent c25f947416
commit 762ae97a36
15 changed files with 920 additions and 2 deletions
@@ -0,0 +1,14 @@
+SHELL := /bin/bash
+.PHONY: help
+
+help: ## Display this help page
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[33m%-30s\033[0m %s\n", $$1, $$2}'
+
+lint: ## Lint files with shellcheck
+	@find src/*.sh -type f -exec "shellcheck" "-x" {} \;
+
+generate-docs: ## Build documentation using docker container
+	docker build . -t bash-tui-toolkit/shdoc -f .development/docs/Dockerfile
+	docker run --rm  bash-tui-toolkit/shdoc 'shdoc < logging.sh ' 2>&1 > docs/modules/Logging.md
+	docker run --rm  bash-tui-toolkit/shdoc 'shdoc < prompts.sh ' 2>&1 > docs/modules/Prompts.md
+	docker run --rm  bash-tui-toolkit/shdoc 'shdoc < user_feedback.sh ' 2>&1 > docs/modules/User-Feedback.md