commit-stream

把一个 git log 转换成提交对象流

API

commitStream([defaultGithubUser, defaultGithubProject])

返回一个对象流，您可以从的输出中通过管道生成换行流 git log 出现。流的输出是一系列对象，每个对象表示来自日志的提交。

旨在用于标准日志格式（而不是使用简化日志格式之一的简化日志格式） --format 选项)，但它也会处理更改统计，如果你 git log --stat。

典型的用法:

import { spawn } from 'node:child_process'
import { createInterface } from 'node:readline'
import { pipeline } from 'node:stream/promises'
import commitStream from 'commit-stream'

const { stdout } = spawn('git', ['log'])
const commits = []

await pipeline(
  createInterface({ input: stdout, crlfDelay: Infinity }), // break up by newline characters
  commitStream('rvagg', 'commit-stream'),
  async (source) => {
    for await (const commit of source) commits.push(commit)
  }
)
// commits is an array of objects

提交对象属性：

• sha：完整提交sha
• author：一个对象，表示提交的作者
  • name：提交者的名称
  • email：提交者的电子邮件
• authors：表示提交的作者的对象列表，支持多个作者通过 Co-authored-by:
• authorDate：一个字符串，表示作者原始提交的日期（永远不会更改）
• commitDate：表示最后一次提交更改的日期的字符串
• summary：提交的一行摘要
• description：摘要的自由格式文本内容，减去特定的元数据行
• reviewers：包含对象的数组 name 和 email 属性中包含审阅者 Reviewed-By: Foo Bar <baz@boom> 格式。
• changes:如果 --stat 数据包含在git日志中，一个包含变更统计的对象：
  • files：修改的文件数
  • insertions：插入的新行数
  • deletions：删除的旧行数
• prUrl：如果提交元数据包含一个，则指向拉取请求的URL PR-URL: https://github.com/user/project/pull/XX 线。注意，无论进行什么 PR-URL: 字符串将在此属性中收集；一个例外是如果缩短 #XX 找到您提供的版本 defaultGitHubUser 和 defaultGitHubProject 参数，然后一个完整的GitHub拉取请求将在其位置重新构建。
• ghUser， ghProject， ghIssue：如果找到合适的GitHub拉取请求 prUrl 财产（包括缩短的） #XX 这些属性将被添加到指向此更改的原始用户、项目和发出（pull-request），就像从URL中提取的那样。此外，如果提交消息行以 (#XX) 与绿色按钮合并一样，将使用此选项。

许可证

commit-stream 版权所有(c) 2015 Rod Vagg @rvagg 并获得麻省理工学院的许可。保留MIT许可中未明确授予的所有权利。请参阅所包含的许可证。Md文件获取更多详细信息。