#cargo-toml #cargo #cargo-subcommand #prepublish

app cargo-prepublish

一个帮助为 Crates.io 发布准备软件包的 Cargo 插件

6 个版本

0.1.5 2023年2月20日
0.1.4 2023年2月17日

#387Cargo 插件

31 每月下载次数

MIT/Apache

26KB
563

Cargo-prepublish

crates.io docs

一个 Cargo 插件,帮助在发布前设置和准备软件包。

它如何工作?

它读取您的 cargo.toml 文件,并根据不存在的值,要么设置默认值,要么提示您输入。

一些提示是必需的,其他的是可选的。

要求

Git 需要安装,因为该工具使用命令行来运行 git 命令。

如何使用

cargo install cargo-prepublish

# To make changes to the Cargo.toml file
cargo prepublish

# To make changes to the Cargo.toml file with just the defaults and not interactivity
cargo prepublish -n
# OR
cargo prepublish --non-interactive

# To check if the Cargo.toml is valid
cargo prepublish -v
# OR
cargo prepublish --valid

有哪些检查

它检查以下内容

  • 分类:如果不存在,则向文档添加一个空数组并注释
  • 描述
  • 文档(可选)Crates.io 将自动将其链接到 docs.rs
  • 主页:如果没有设置或输入,则使用 git 仓库作为默认值
  • 关键词:至少需要输入一个关键词。默认值为软件包名称
  • 许可协议和许可文件:默认为 MIT 或 Apache 2.0 许可协议
  • 自述文件:首先寻找现有文件,如果没有,则生成一个
  • 仓库:如果是有效的 git 仓库,则提取
  • 作者:可选

额外检查

  • package.metadata.docs.rs.all-features:仅在软件包具有功能时应用

限制

  • 散列的表格数组(表格默认按 toml_edit 排序)

贡献

欢迎任何贡献。如果您发现错误、有建议或功能请求,请创建问题。

依赖项

~6.5–8.5MB
~154K SLoC