acknowledge-rs

acknowledge 是一个基于您的 Cargo.toml 文件生成致谢列表的 CLI 工具。

它与 GitHub 和 GitLab API 一起工作。仅支持公开仓库。

安装

cargo install acknowledgements-rs

使用方法

acknowledge is a simple CLI tool to analyze dependencies of a Cargo (rust) project and produce an ACKNOWLEDMENTS.md file listing (major) contributors of your dependencies

Usage: acknowledge [OPTIONS] --path <PATH> [COMMAND]

Commands:
  clear-cache  Clears cache
  help         Print this message or the help of the given subcommand(s)

Options:
  -p, --path <PATH>
          Path to Cargo project for analysis
  -g, --gh-token <GH_TOKEN>
          Running Acknowledgements on any project of reasonable size you're likely to face rate limits. Please provide a personal access token
  -o, --output <OUTPUT>
          Output file path, defaults to project path if not provided
  -m, --mention
          Whether to include @ (at) symbol in front of a github user's name
  -f, --format <FORMAT>
          Format of the output file [default: NameAndCount]
  -b, --breadth <BREADTH>
          Breadth of scan, whether to include optional, build and dev deps contributors [default: NonOpt]
  -c, --contributions-threshold <CONTRIBUTIONS_THRESHOLD>
          Min number of contributions to be included in the list, doesn't apply to sole contributors [default: 2]
  -s, --sources <SOURCES>
          List other sources, not specified in Cargo.toml
  -t, --template <TEMPLATE>
          Use your own template. See https://github.com/anvlkv/acknowledgements/blob/main/src/template.md?plain=1 for reference
  -h, --help
          Print help
  -V, --version
          Print version

选项

GitHub 访问令牌

如果您等待限制重置时间过长或过于频繁，请务必提供。此令牌不需要任何权限。

来源

链接通过 Cargo.toml 无法发现的任何仓库

宽度

• NonOpt - 非可选依赖
• All - 所有依赖
• BuildAndDev - 包括 [build-dependencies] 和 [dev-dependencies] 的所有依赖

格式

• NameAndCount - 贡献者的名称和贡献次数
• DepAndNames - 依赖项的名称，贡献者的名称
• NameAndDeps - 贡献者的名称，他们做出贡献的依赖项的名称

示例

• NameAndCount - acknowledge -p .
• DepAndNames - acknowledge -p . -f DepAndNames
• NameAndDeps - acknowledge -p . -f NameAndDeps
• BuildAndDev - acknowledge -p . -b BuildAndDev