Git commit-msg hook如何替换commit message中的BugID为Bug地址？

• 语法错误：fp.write(...)调用缺少闭合右括号，代码无法正常运行
• 文件读写逻辑错误：r+模式打开文件时，没有清空原有内容、也没有将文件指针重置到起始位置，直接在循环中执行write操作，会从当前指针位置覆盖原有内容，最终表现为在文件末尾追加零散内容，无法精准替换目标行
• 字符串操作逻辑错误：将换行符拆分项写为'/n'（正斜杠），实际正确的换行分隔符是'\n'，且readlines()本身已经按行拆分了内容，重复拆分完全多余
• 索引风险：判断行首是否为#的时候，没有过滤空行，遇到空行取line[0]会直接抛出索引越界错误
• 替换逻辑不完整：匹配到BugId行时，没有提取原有BugID的实际值，直接把冒号后的内容替换成固定前缀，没有拼出完整可访问的bug地址

拆分读写流程，不要边遍历边写文件。先将commit message文件的全部内容加载到内存，完成合规校验、BugId地址替换的所有处理后，再一次性将处理结果写回文件，从根源上避免文件指针错位、内容追加的问题。

修正后的参考实现 #

import sys

commit_msg_path = sys.argv[1]

# 第一步：读取全部commit内容到内存
with open(commit_msg_path, 'r') as fp:
    lines = fp.readlines()

processed_content = []
required_fields = ["Branch:", "BugId:", "Description:"]

# 第二步：逐行完成校验、替换处理
for line in lines:
    stripped_line = line.strip()
    # 保留原有注释行
    if stripped_line.startswith("#"):
        processed_content.append(line)
        continue
    # 保留原有空行排版
    if not stripped_line:
        processed_content.append(line)
        continue
    # 校验必填字段非空
    for field in required_fields:
        if stripped_line.startswith(field):
            field_value = stripped_line.split(":", 1)[-1].strip()
            if not field_value:
                print(f"提交错误：{field} 对应的内容不能为空")
                sys.exit(1)
            # 匹配到BugId行时替换为完整访问地址
            if field == "BugId:":
                bug_id = field_value
                replaced_line = f"BugId: http://bugs.xxxxxxxxx/{bug_id}\n"
                processed_content.append(replaced_line)
                break
    # 非模板指定的普通内容直接保留
    else:
        processed_content.append(line)

# 第三步：将处理完成的内容一次性写回原文件
with open(commit_msg_path, 'w') as fp:
    fp.writelines(processed_content)

sys.exit(0)

实现注意点 #

• 写回文件时使用w模式，会自动清空原有内容，不会出现文件指针位置错乱的问题
• 拆分字段值时用split(":", 1)，仅按第一个冒号做拆分，避免BugID本身包含冒号导致的拆分错误
• 处理过程中保留原有的空行、注释行格式，不会破坏commit message的原有排版

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