Node.js如何安全稳定获取最新Git提交的描述字段

Git 本身没有把提交标题、描述作为独立字段存储，GitLab、GitKraken、VS Code Git 插件这类GUI工具，都是遵循行业通用的Git提交消息规则拆分内容：

• 提交消息的第一行作为标题
• 标题之后第一个空行往后的所有内容作为提交描述
• 首尾多余的空行会自动过滤忽略

你用多个-m参数执行提交时，Git会自动在每个参数的内容之间插入空行，刚好符合这个拆分规则。

Git命令选型 #

不要用默认的git log -1，它会附带提交hash、作者、提交时间等元数据，还会给每一行内容前加4个空格缩进，解析容易出错。直接用Git内置的格式化参数输出纯内容即可：

• 单独获取提交标题：git log -1 --pretty=%s
• 单独获取提交描述（正文）：git log -1 --pretty=%b
• 获取完整原始提交消息：git log -1 --pretty=%B

其中%b参数会自动返回标题之后的正文内容，自动过滤掉标题和正文之间的分隔空行，输出结果和各类GUI工具显示的提交描述完全一致，不需要额外做复杂的字符串拆分。

Node.js 安全实现 #

不要用exec/execSync走shell调用，存在命令注入风险。推荐用execFileSync直接传入参数数组调用，不经过shell解析，安全性更高：

const { execFileSync } = require('child_process');

/**
 * 获取当前仓库最新一次提交的描述内容
 * @returns {string} 提交描述，无描述或非Git环境下返回空字符串
 */
function getLatestCommitDesc() {
  try {
    const output = execFileSync(
      'git',
      ['log', '-1', '--pretty=%b'],
      {
        encoding: 'utf8',
        stdio: ['ignore', 'pipe', 'ignore']
      }
    );
    return output.trim();
  } catch (err) {
    // 可根据自身需求调整错误处理逻辑，比如抛出错误
    return '';
  }
}

// 调用示例
const desc = getLatestCommitDesc();
console.log('最新提交描述：', desc);

• 若提交只传了一个-m参数（只有标题没有描述），%b返回空内容，函数返回空字符串，符合预期
• 若提交传了3个及以上-m参数，%b会返回第二个及之后所有-m参数拼接的完整正文，和GUI工具展示结果一致
• 若当前执行目录不是Git仓库，或没有Git执行权限，函数会捕获异常返回空字符串，不会导致进程崩溃

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