如何将cruft/cookiecutter模板应用于未使用过该模板的现有Git/GitHub项目？

优先选择Cruft（推荐长期维护） #

Cruft是Cookiecutter的增强工具，支持跟踪模板版本、自动合并更新，更适配已有项目的模板接入与后续维护：

1. 备份当前项目
   先提交所有未完成改动，再创建备份分支以防意外：

git add .
git commit -m "Backup before applying cruft template"
git checkout -b pre-cruft-backup
git push origin pre-cruft-backup
git checkout main

2. 初始化Cruft模板
   在项目根目录执行命令，替换<模板仓库地址>为目标模板的Git地址或本地路径：

cruft create <模板仓库地址>

执行过程中需填写模板要求的配置参数（如项目名、作者等），Cruft会生成模板文件并创建.cruft.json（记录模板版本与配置，用于后续更新）。

3. 解决文件冲突
   若现有项目与模板存在同名文件，Cruft会标记冲突，此时需：

• 保留核心业务代码文件（如src目录下的业务逻辑）
• 合并模板提供的辅助文件（如.github/workflows/、pyproject.toml、Makefile、.gitignore等）
• 手动编辑冲突文件，结合模板最佳实践与现有项目需求调整

4. 提交并验证
   解决所有冲突后，提交改动并测试项目功能：

git add .
git commit -m "Apply cruft template: merge config and tooling files"
# 运行项目测试用例，确保功能正常
pytest  # 示例命令，根据项目类型调整

5. 后续模板更新
   当模板仓库有更新时，直接执行以下命令自动合并差异：

cruft update

Cruft会对比当前项目与最新模板的差异，帮助快速合并更新内容。

使用Cookiecutter（适合一次性接入） #

若仅需一次性应用模板，无需后续跟踪更新，可使用原生Cookiecutter：

1. 备份项目
   同Cruft步骤，先提交改动并创建备份分支。

2. 生成模板到临时目录
   在项目外创建临时目录，生成模板文件：

cookiecutter <模板仓库地址> --output-dir ./temp-template

3. 手动合并文件
   将临时目录中的模板文件复制到现有项目：

• 复制辅助配置文件（如CI脚本、依赖配置）
• 避免覆盖核心业务代码
• 手动解决同名文件的内容冲突

4. 提交并验证
   提交合并后的改动，测试项目是否正常运行。

关键注意事项 #

• 核心代码优先：模板主要提供工程化工具、配置规范，不要覆盖或修改核心业务逻辑。
• 测试先行：每次合并或更新后，必须运行测试用例确保项目功能不受影响。
• 版本跟踪：Cruft生成的.cruft.json要纳入Git版本管理，方便后续更新。

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