maker

maker a tool that augments make with Makefile menu help, dotenv support

Examples

Example Help

This help output

Usage: make <target>

### HELP
  help - Print Help
### DEVELOPMENT
  build - Build binary
  test  - Test

is generated using make help and this Makefile

.PHONY: help build install clean test

### HELP
help: ## Print Help
	@maker --menu Makefile

### DEVELOPMENT
build: ## Build binary
	@echo "Run build ..."

test: build ## Test
	@echo "Run Tests ..."

Example dotenv support

Maker supports .env files. The default is to load $HOME/.env then the projects .env file.

Given the following .env files.

# Home directory "$HOME/.env" file
MYSECRET=MySeceret

# Projects "./.env" file
REPO=http://artifactory.mycompany.com/packages

Then the Makefile will print the environment variables listed in the _printvars target.

NOTE Maker will automatically prepend the underscore "_" to the target *before calling make again. E.G. make target will become make _target when *it falls through to the catchall.

MAKEFLAGS += --no-print-directory
.PHONY: _printvars

### HELP
_printvars: ## Print variables
	@echo "HOME=${HOME}"
	@echo "REPO=${REPO}"
	@echo "MYSECRET=${MYSECRET}"

# Catch all target to wrap tasks with a single underscore prefix.
%:
	@maker $@

Output of make printvars (Notice no preceding underscore)

HOME=/home/username
REPO=http://artifactory.mycompany.com/packages
MYSECRET=MySeceret

Maker will not override any existing environment variables. The default order of precedence is.

1. Global environment variables.
2. Home directory ~/.env file.
3. The current folders .env file.

Help

# maker --help
maker

Usage:
  maker [--dotenv=<files>] [--scan=<makefile>] [--prefix=<prefix>] <target>
  maker --menu=<makefile>

Options:
  -h --help          Show this screen
  --version          Show version
  --dotenv=<files>   List of comma separated paths to load dotenv files [default: ~/.env,.env]
  --menu=<makefile>  Print Makefile menu
  --prefix=<prefix>  Scan for "<target>" then "<prefix><target>" when scanning makefiles [default: "_"]
  --scan=<makefile>  Scan make makefile for targets and wrap with dotenv variables [default: Makefile]
  <target>           makefile target

Install

Install MACOS

wget https://github.com/kick-project/maker/releases/latest/download/maker.rb
brew install maker.rb

Install RPM

sudo rpm -ivh https://github.com/kick-project/maker/releases/download/v1.1.0/maker-1.1.0.x86_64.rpm

Install DEBs

wget https://github.com/kick-project/maker/releases/download/v1.1.0/maker_1.1.0_amd64.deb
sudo apt install ./maker_1.1.0_amd64.deb