#makefile #help #pretty #parser

app pretty-make

让 Make 更美观

14 个版本

0.6.3 2022年9月23日
0.6.2 2022年2月8日
0.6.0 2021年4月30日
0.5.3 2021年1月26日
0.4.1 2020年11月27日

#1241 in 开发工具

GPL-3.0-or-later

95KB
240

让 Make 更美观

Make 更美观。

此程序旨在扩展 Make 的功能。实际上,它解析 Makefile 以生成美观的帮助文档。以下是一个示例:

example.png

🏁 安装

通过下载二进制文件按项目安装

要使用 Pretty Make,您只需在您的 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 Makefile

使用 cargo 系统全局安装

首先,您必须使用以下命令安装 Pretty Make

cargo install pretty-make

然后,您可以在您的 Makefile 中像这样使用 Pretty Make

.PHONY: help
## List available commands
help:
  @pretty-make pretty-help Makefile

⌨️ 使用方法

make help

📝 Makefile 帮助语法

#@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 https://127.0.0.1:3000 with hot reloading
## - API at https://127.0.0.1:3010
## - phpMyAdmin at https://127.0.0.1:3011
.PHONY: serve
serve: api deps
  @$(WEBPACK_SERVER) --inline --progress --config webpack/dev.js

✍️ 作者

🤜🤛 贡献

欢迎贡献、问题和功能请求! 请参阅参与此项目的 贡献者列表

📄 许可证

让 Make 更美观 使用 GNU 通用公共许可证 v3.0 许可。

依赖关系

~3–13MB
~106K SLoC