🗣️ 摘要 —

摘要 是一个功能强大的命令行工具，旨在高效地进行 Git 仓库分析和总结。它提供顺序和并行处理能力，以及灵活的文件过滤选项。

Summary -P > Summary.md

摘要 将为第一个和最后一个提交之间的所有提交和标签生成以下 Summary.md。

功能

• 自定义文件模式匹配。
• 在 Git 标签之间生成差异。
• 目录遍历和文件过滤。
• 排除指定的文件或目录。
• Git 仓库分析。
• 与 Pieces OS 集成以增强功能。
• 并行和顺序处理模式。

Pieces OS 集成

摘要 CLI 支持 Pieces OS，允许它

• 自动生成全面的差异日志和发布说明。
• 提供基于 AI 的代码分析和见解。
• 提供改进的上下文感知的仓库变更处理。
• 无缝与其他 Pieces OS 兼容的开发工具交互。

通过利用 Pieces OS，摘要 可以访问更广泛的开发生态系统和服务，显著扩展其功能，超越基本的文件处理。

安装

cargo install psummary

使用方法

摘要工具可以使用各种选项

🗣️ Summary —

Usage: Summary [OPTIONS]

Options:
  -P, --Parallel           ⏩ Parallel —
  -R, --Root <ROOT>        📂 Root — [default: .]
  -E, --Exclude <EXCLUDE>  🚫 Exclude — [default: node_modules]
      --Pattern <PATTERN>  🔍 Pattern — [default: .git]
  -O, --Omit <OMIT>        🚫 Omit — [default: Documentation]
  -h, --help               Print help
  -V, --version            Print version

此命令将在指定的仓库内为所有的 Git 标签生成摘要。

选项

摘要工具可以使用各种选项

--Exclude 或 -E

排除某些文件或目录。

默认值为

Summary -P -E node_modules

省略或 -O

指定正则表达式模式以从处理中排除文件。

默认值为

Summary -P \
	--Omit "(?i)documentation" \
	--Omit "(?i)target" \
	--Omit "(?i)changelog\.md$" \
	--Omit "(?i)summary\.md$"

并行或 -P

并行运行处理。

默认值为

Summary

模式

指定一个自定义匹配模式。

默认值为

Summary -P --Pattern .git

根目录或 -R

将当前工作目录设置为不同的文件夹。

默认值为

Summary -P --Root .

对于 Pieces OS 集成，请参阅 Pieces OS 文档了解特定标志和配置选项。Pieces OS

示例

分析当前目录

Summary

并行分析特定目录

Summary -P -R D:\Developer

排除附加目录

Summary -P -E "node_modules target dist vendor"

省略特定文件模式

Summary -P -O "\.md$" -O "\.txt$"

依赖项

概要依赖于几个 Rust crate 来提供其功能

• clap - 用于解析命令行参数。
• futures - 用于异步编程抽象。
• git2 - 用于 Git 仓库操作。
• num_cpus - 用于确定并行处理的 CPU 数量。
• rayon - 用于并行处理。
• regex - 用于模式匹配和文本操作。
• tokio - 用于异步运行时。
• walkdir - 用于高效的文件系统遍历。

Pieces OS 用于扩展功能和系统集成。

更新日志

有关此 CLI 更改历史的详细信息，请参阅 CHANGELOG.md。