Make Make pretty.
This program intend to extend Make capabilities. Actually it parse a Makefile to produce a pretty help. See example below:
To use Pretty Make you only have to add the following at the end of your Makefile:
bin/pretty-make:
@curl -Ls https://raw.githubusercontent.com/awea/pretty-make/master/scripts/install.sh | bash -s
.PHONY: help
## List available commands
help: bin/pretty-make
@bin/pretty-make pretty-help MakefileFirst you have to install Pretty Make using the following command:
cargo install pretty-makeThen you can use Pretty Make in your Makefile like this:
.PHONY: help
## List available commands
help:
@pretty-make pretty-help Makefilemake help#@name Project name
#@description Project description. (optional)
#@color-title #70c3cc (optional)
#@color-subtitle #c970cc (optional)
#@color-link #0314fc (optional)
# This is a comment and it won't appear in the `make help`.
## Build site for production use
.PHONY: build
build: deps
@echo "Building front-end"
@rm -rf site/*
@NODE_ENV=production $(WEBPACK) --config webpack/prod.js
@echo "Front-end built!"
# ✨ This display a title
# --
.DEFAULT_GOAL := serve
## Serve:
## - Site at http:https://localhost:3000 with hot reloading
## - API at http:https://localhost:3010
## - phpMyAdmin at http:https://localhost:3011
.PHONY: serve
serve: api deps
@$(WEBPACK_SERVER) --inline --progress --config webpack/dev.js- @Awea - Idea and initial work
- @mmaayylliiss - Design and review
Contributions, issues and feature requests are welcome! See the list of contributors who participated in this project.
Pretty Make is licensed under the GNU General Public License v3.0.