如何将CMake生成的项目文件排除在Git版本控制之外

1. 用通用.gitignore规则覆盖绝大多数CMake产物 #

不管用户用什么名字的构建目录，CMake生成的核心文件/目录都是固定的，直接把这些规则加到项目根目录的.gitignore里，就能覆盖99%的情况：

# CMake通用生成文件
CMakeCache.txt
CMakeFiles/
CMakeScripts/
Makefile
cmake_install.cmake
install_manifest.txt
compile_commands.json  # 若不需要跟踪编译命令可保留，否则删除

# IDE项目文件（按需添加）
*.sln
*.vcxproj
*.vcxproj.filters
*.xcodeproj/
*.idea/
.vscode/

# 原地构建生成的隐藏目录
.cmake/

这些规则不绑定特定构建目录，不管用户用build、meta_build还是自定义名字的目录，只要是CMake生成的产物都会被忽略；就算有人原地构建，源码目录里的.cmake/、CMakeCache.txt这类文件也会被拦住。

2. 强制禁止原地构建（从根源避免污染） #

新手最容易犯原地构建的错，直接在项目根目录的CMakeLists.txt开头加一段检查逻辑，只要用户尝试原地构建就直接报错：

# 禁止原地构建
if(CMAKE_SOURCE_DIR STREQUAL CMAKE_BINARY_DIR)
  message(FATAL_ERROR "禁止原地构建！请创建单独的构建目录后再执行CMake。\n示例：\nmkdir meta_build && cd meta_build && cmake ..")
endif()

这样用户一跑cmake .就会收到明确的错误提示，从根本上避免源码目录被构建文件污染。

3. 针对团队常用构建目录加额外规则（可选） #

如果你的团队统一用meta_build目录，直接在.gitignore里补一行：

meta_build/

和通用规则形成双重保险，就算有漏网之鱼也能被拦住。

4. 用Git钩子防止误提交 #

再补一层防护：给Git加pre-commit钩子，提交前自动检查是否有CMake构建文件被误加入暂存区，有就直接阻止提交。
步骤很简单：

1. 在项目的.git/hooks/目录下新建pre-commit文件
2. 写入以下脚本：

#!/bin/sh
# 检查是否有CMake构建文件被暂存
forbidden_patterns="CMakeCache.txt|CMakeFiles/|Makefile|cmake_install.cmake|.cmake/"
forbidden_files=$(git diff --cached --name-only | grep -E "$forbidden_patterns")

if [ -n "$forbidden_files" ]; then
  echo "❌ 发现误提交的CMake构建文件："
  echo "$forbidden_files"
  echo "请用 git reset HEAD <文件名> 移除这些文件的暂存状态"
  exit 1
fi

exit 0

3. 给脚本加执行权限：chmod +x .git/hooks/pre-commit
   之后任何人提交时只要包含构建文件，都会被拦截并提示原因。

内容的提问来源于stack exchange，提问作者KnuppenSasper