获得徽章 0
赞了这篇沸点
`cargo-public-api` 是一个为 Rust 开发者设计的 Cargo 子命令,它的核心作用是**列出并对比(diff)一个 Rust Crate 的公共 API**。
如果你在开发一个库(library),保持 API 的稳定性或遵循语义化版本(SemVer)至关重要。这个工具可以帮你清晰地看到哪些函数、结构体或 Trait 被暴露给了外部用户。
---
### **核心功能**
* **列出公共 API**:它可以扫描你的项目,并以纯文本或 JSON 格式输出所有标记为 `pub` 的项(如函数签名、结构体字段、枚举变体等)。
* **对比差异(Diff)**:这是它最强大的地方。你可以对比当前分支与 `main` 分支,或者对比当前代码与已发布的版本。如果某个 API 被删除了或者签名变了,它会直观地标示出来。
* **CI 门禁**:你可以将其集成到 GitHub Actions 等 CI 流程中。如果开发者在提交代码时意外修改了公共 API,CI 可以直接报错,防止无意间引入破坏性改动(Breaking Changes)。
如果你在开发一个库(library),保持 API 的稳定性或遵循语义化版本(SemVer)至关重要。这个工具可以帮你清晰地看到哪些函数、结构体或 Trait 被暴露给了外部用户。
---
### **核心功能**
* **列出公共 API**:它可以扫描你的项目,并以纯文本或 JSON 格式输出所有标记为 `pub` 的项(如函数签名、结构体字段、枚举变体等)。
* **对比差异(Diff)**:这是它最强大的地方。你可以对比当前分支与 `main` 分支,或者对比当前代码与已发布的版本。如果某个 API 被删除了或者签名变了,它会直观地标示出来。
* **CI 门禁**:你可以将其集成到 GitHub Actions 等 CI 流程中。如果开发者在提交代码时意外修改了公共 API,CI 可以直接报错,防止无意间引入破坏性改动(Breaking Changes)。
展开
1
2
赞了这篇沸点
赞了这篇文章
赞了这篇文章
赞了这篇沸点
赞了这篇沸点
赞了这篇文章
赞了这篇沸点
赞了这篇沸点
赞了这篇文章
赞了这篇文章
赞了这篇沸点