task.mk
-
+
the task runner for GNU Make you've been missing
+
+ Documentation
+
@@ -15,19 +18,25 @@ to add some QOL improvements for your users and fellow maintainers.
Current Features:
-- ANSI escape code support (including NO\_COLOR)
-- formatted help output
-- custom print function
-- confirmation prompt
+ - ANSI escape code support (including NO_COLOR)
+ - formatted help output
+ - custom print function
+ - confirmation prompt
+ - goal phonifier (disabled by default)
Depends on `GNU Make`, obviously and `Python >=3.7`, and `bash` (or `zsh`).
Wait python?!?!, I'm not `pip` installing some package just to parse my makefile.
-I agree, all you need is one file [`.task.mk`](https://github.com/daylinmorgan/task.mk/v23.1.1/task.mk).
-You can automagically include it with just two additional lines to your `Makefile` (and probably one to your `.gitignore`) and your good to go.
+I agree, all you need is one file [`.task.mk`](./task.mk).
+You can automagically include it with just two additional lines to your `Makefile` (and probably one to your `.gitignore`) and you're good to go.
## Setup
+One line setup to download .task.mk and add appropriate includes to your `Makefile`.
+```bash
+bash <(curl -fsSL gh.dayl.in/task.mk/init) # or w/ TASKMK_VERSION=
+```
+
You can include this as an optional dependency on your project by adding the below lines to the end of your `Makefile`.
If someone tries to invoke `make help` it will download `.task.mk` for them.
@@ -36,54 +45,11 @@ If someone tries to invoke `make help` it will download `.task.mk` for them.
$(if $(filter help,$(MAKECMDGOALS)),$(if $(wildcard .task.mk),,.task.mk: ; curl -fsSL https://raw.githubusercontent.com/daylinmorgan/task.mk/v23.1.1/task.mk -o .task.mk))
```
-You might also consider making it a consistently downloaded dependency if you plan to use any of it's advanced feature set, by dropping the `$(MAKECMDGOALS)` check.
+If you plan to use any features besides the help prompt you may want to instead commit `.task.mk` to version control or drop the `$(MAKECMDGOALS)` check so it's always downloaded once `make` is invoked.
```make
-include .task.mk
$(if $(wildcard .task.mk),,.task.mk: ; curl -fsSL https://raw.githubusercontent.com/daylinmorgan/task.mk/v23.1.1/task.mk -o .task.mk)
```
-Alternatively, you can use the builtin rule `_update-task.mk` to update to the latest development version.
-
-See [Usage](./usage) to get started running all your tasks.
-See [Examples](./examples) for more use cases.
-
-## Zsh Completions for GNU Make
-
-If you use `GNU Make` with zsh you may want to add the following
-line to your rc file to allow `make` to handle the autocomplete.
-
-```zsh
-zstyle ':completion::complete:make:*:targets' call-command true
-```
-
-## Why Make?
-
-There are lot of `GNU Make` alternatives but none have near the same level of ubiquity.
-This project attaches to `make` some of the native features of [`just`](https://github.com/casey/just), a command runner.
-
-Just is a great task runner, but it suffers two problems, users probably don't have it installed already, and there is no way to define file specific recipes.
-Most of my `Makefile`'s are comprised primarily of handy `.PHONY` recipes, but I always end up with a few file specific recipes.
-
-Another interesting project I've evaluated for these purposes is [`go-task/task`](https://github.com/go-task/task).
-`Task` has many of the features of `GNU Make` and some novel features of it's own.
-But like `just` it's a tool people don't usually already have and it's configured using a `yaml` file.
-`Yaml` files can be finicky to work with and and it uses a golang based shell runtime, not your native shell, which might lead to unexpected behavior.
-
-
-## Simpler Alternative
-
-But I just want a basic help output, surely I don't need python for this... you would be right.
-`Task.mk` replaces my old `make help` recipe boilerplate which may better serve you (so long as you have `sed`/`awk`).
-
-
-```make
-## h, help | show this help
-.PHONY: help h
-help h: Makefile
- @awk -v fill=$(shell sed -n 's/^## \(.*\) | .*/\1/p' $< | wc -L)\
- 'match($$0,/^## (.*) \|/,name) && match($$0,/\| (.*)$$/,help)\
- {printf "\033[1;93m%*s\033[0m | \033[30m%s\033[0m\n",\
- fill,name[1],help[1];} match($$0,/^### (.*)/,str) \
- {printf "%*s \033[30m%s\033[0m\n",fill," ",str[1];}' $<
-```
+For more info see the [documentation](https://gh.dayl.in/task.mk).
diff --git a/docs/init b/docs/init
index bd724d9..96dbf04 100644
--- a/docs/init
+++ b/docs/init
@@ -11,20 +11,22 @@ if [ -f "./.task.mk" ]; then
fi
curl -fsSL "https://raw.githubusercontent.com/daylinmorgan/task.mk/$VERSION/task.mk" -o .task.mk
echo .task.mk >>.gitignore
-printf '\n-include .task.cfg.mk .task.mk\n' >>Makefile
-printf '$(if $(filter help,$(MAKECMDGOALS)),$(if $(wildcard .task.mk),,.task.mk: ; curl -fsSL https://raw.githubusercontent.com/daylinmorgan/task.mk/%s/task.mk -o .task.mk))' \
+printf '\n-include .task.cfg.mk\n' >>Makefile
+printf '%s %s\n' '-include' '.task.mk' >>.task.cfg.mk
+printf '$(if $(filter help,$(MAKECMDGOALS)),$(if $(wildcard .task.mk),,.task.mk: ; curl -fsSL https://raw.githubusercontent.com/daylinmorgan/task.mk/%s/task.mk -o .task.mk))\n' \
"$VERSION" \
- >>Makefile
+ >>.task.cfg.mk
printf ".task.mk files added to repo\n\n"
echo "Do you want to commit these changes?"
-printf "RUN COMMAND: %s (Y/n) " \
- "git add Makefile .gitignore && git commit -m \"chore: initialize .task.mk\""
+printf "Run the below command?\n\n %s (Y/n) " \
+ "git add Makefile .gitignore .task.cfg.mk && git commit -m \"chore: initialize .task.mk\""
-read -r answer
+read -r answer =0;--C){var E=this.tryEntries[C],t=E.completion;if("root"===E.tryLoc)return Q("end");if(E.tryLoc<=this.prev){var e=B.call(E,"catchLoc"),i=B.call(E,"finallyLoc");if(e&&i){if(this.prev