makefile-review

审计Makefile文件,检查构建正确性、可移植性和配方重复问题。

安装使用

复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:

帮我安装这个 AI Skill:makefile-review。
它的用途是:审计Makefile文件,检查构建正确性、可移植性和配方重复问题。
完整的 Skill 内容见:https://321skill.com/skills/makefile-review-x/raw/index.md
请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。

提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。

使用示例

‘请用 makefile-review 工具分析一下当前目录下的 Makefile 文件。’,它会执行该工具并返回一份分析报告,指出文件中存在的潜在问题,例如哪些目标声明了重复的构建步骤,哪些命令可能在不同平台上不兼容,帮助你提前修复构建脚本中的缺陷。

介绍

makefile-review 是一款专注于分析和改进 Makefile 文件的工具。它主要解决在软件构建过程中,由于 Makefile 编写不规范、存在隐藏错误或平台依赖性强而导致的构建失败、效率低下和可维护性差的问题。该工具通过静态分析,自动检测 Makefile 中的常见陷阱,如错误的依赖关系、不可移植的 shell 命令、重复的配方(recipe)等,帮助开发者提前发现并修复问题。

使用方式非常直接,通常通过命令行调用,指定需要分析的 Makefile 文件路径即可。工具会运行一系列检查规则,并生成一份详细的报告,列出发现的问题、严重程度以及可能的修复建议。开发者可以根据报告逐项修改,提升 Makefile 的质量。

这个工具特别适合需要维护复杂构建系统、或希望确保其项目能在不同环境下(如不同操作系统、Shell)稳定构建的开发者。无论是个人项目还是团队协作,一个健壮的 Makefile 都是持续集成和自动化部署流程的重要基石。

在使用时,建议将其集成到项目的 CI/CD 流水线中,作为代码提交前的检查环节。需要注意的是,该工具主要基于规则进行静态分析,可能无法捕捉所有运行时逻辑错误,因此其报告应作为改进的参考,而非绝对真理。对于高度定制或使用了复杂宏展开的 Makefile,可能需要结合手动审查。

核心特点

与通用的代码质量扫描工具不同,它专门针对 Makefile 的语法和语义进行深度分析,能精准识别 Makefile 特有的问题,如配方重复、隐含规则冲突和可移植性陷阱(例如对特定 Shell 的依赖)。

注意事项

不适合用于分析非 Makefile 的构建脚本(如 CMakeLists.txt, Bazel BUILD 文件),也无法检测构建过程中的动态依赖或运行时错误。

常见问题

makefile-review 能检查哪些具体问题?

它能检查构建目标缺失、配方重复、使用不可移植的命令(如非POSIX命令)、变量使用错误、PHONY目标声明缺失等。

如何将 makefile-review 集成到 CI 流程中?

可以在 CI 配置文件中添加一个步骤,运行 makefile-review 命令,并根据其退出码决定是否阻断构建流程。

给 AI 助手的安装指引

如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:

请访问 https://321skill.com/skills/makefile-review-x/raw/index.md 读取 makefile-review 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。