makefile-utils: 帮助写 Makefile 的小工具

V2EX = way to explore

V2EX 是一个关于分享和探索的地方

For Existing Member Sign In

爱意满满的作品展示区。

This topic created in 1161 days ago, the information mentioned may be changed or developed.

分享一个小工具。

如果你不想在项目中引入 cmake, xmake, mmake, emake 等高级的 make 工具，仅使用系统自带的 make 命令。 makefile-utils 能帮上一点小忙。

功能

make help

make help 能打印 target 列表。

make semver-*

make semver-major 能打印下一个 major 版本。还有 make semver-minor，make semver-patch。

你可能会想这有啥用？因为可以用它这么玩：批量升级替换文件里的版本号。

# @target bump-major  bump major version (x)
# @target bump-minor  bump minor version (y)
# @target bump-patch  bump patch version (z)
BUMP_TARGETS := $(addprefix bump-,major minor patch)
.PHONY: $(BUMP_TARGETS)
$(BUMP_TARGETS):
	@$(MAKE) $(subst bump-,semver-,$@) > VERSION
	@sed -i.bak -E "s/^VERSION=.+/VERSION=v$$(cat VERSION)/" README.md
	@rm README.md.bak VERSION

make md5

可以给指定目录里的每个文件生成.md5 文件。

默认目录是 ./dist。但你可以指定其他目录 make md5 DIST=./dist。

make md5-check

校验指定目录下的文件的 md5 。

默认目录是 ./dist。但你可以指定其他目录 make md5-check DIST=./dist。

安装使用

安装很简单，只要把 makefile-utils 目录拷贝到你的项目。然后在你的 Makefile 里加一行 include ./makefile-utils/*.mk 就可以使用了，按 make help 试试。

如果你的项目使用 git ，需要在 .gitignore 里加两行来忽略一些文件。

/makefile-utils/*
!/makefile-utils/*.mk

如果你想把 make help 作为默认命令就在 Makefile 里加一行 .DEFAULT_GOAL := help。

觉得不错的话，请给项目点给 Star 吧。

https://github.com/adoyle-h/makefile-utils

Supplement 1 · Mar 2, 2023

目前更新到 v0.4.1 版本，新增的功能有：

用户能通过 makefile-utils init . 来初始化项目。
通过 make CHANGELOG 根据 git message 来生成 changelog。changelog 是我总结的最佳实践，生成结果可以参考 makefile-utils 的 CHANGELOG。
通过 make md-check-links 检查项目文档中是否存在死链。