Cargo Thanku

中文 README.md

A command-line tool for generating acknowledgments for your Rust project dependencies.

Key Features

• Generates acknowledgments in multiple formats (Markdown table/list, JSON, TOML, CSV, YAML)
• Fetches dependency information from crates.io and GitHub
• Supports concurrent processing with configurable limits
• Implements retry mechanism for failed requests
• Offers command-line completion for Bash, Zsh, Fish, PowerShell, and Elvish
• Provides internationalization support (zh/en/ja/ko/es/fr/de/it)

Installation

Ensure you have the Rust toolchain installed on your system, then execute:

# Install cargo-thanku
cargo install cargo-thanku

# Generate shell completions (optional)
cargo thanku completions bash > ~/.local/share/bash-completion/completions/cargo-thanku

Usage

Basic Usage

# Generate acknowledgments for your project
cargo thanku

# Specify output format
cargo thanku -f markdown-table  # or markdown-list, json, csv, yaml, toml

# Set GitHub token for more information and automatic starring
cargo thanku -t YOUR_GITHUB_TOKEN

# Change language
cargo thanku -l en  # supports zh/en/ja/ko/es/fr/de/it

Advanced Options

# Configure concurrent requests
cargo thanku -j 10  # Set maximum concurrent requests to 10

# Adjust retry attempts
cargo thanku -r 5   # Set maximum retry attempts to 5

# Customize output file
cargo thanku -o custom_thanks.md

# Enable verbose logging
cargo thanku -v

# Filter out libraries imported with relative paths
cargo thanku --no-relative-libs

Format Conversion

Convert between different output formats:

# Do support `cargo thanku convert` syntax to invoke converter 
# Convert a single file to multiple formats
cargo-thanku convert input.md -o markdown-table,json,yaml,toml

# Short command aliases
cargo-thanku cvt input.csv -o mt,yaml
cargo-thanku conv input.md -o json,csv
cargo-thanku convt input.yaml -o markdown-list

The converter will:

• Create a converted directory in the same location as the input file
• Generate output files with appropriate extensions
• Support conversion between all supported formats (mt[markdown-table], ml[markdown-list], json, toml, yaml, csv)

Command-Line Arguments

Command-Line Completion

Generate command-line completion scripts for various shells:

# Bash
cargo thanku completions bash > ~/.local/share/bash-completion/completions/cargo-thanku

# Zsh
cargo thanku completions zsh > ~/.zsh/_cargo-thanku

# Fish
cargo thanku completions fish > ~/.config/fish/completions/cargo-thanku.fish

# PowerShell
mkdir -p $PROFILE\..\Completions
cargo thanku completions powershell > $PROFILE\..\Completions\cargo-thanku.ps1

# Elvish
cargo thanku completions elvish > ~/.elvish/lib/cargo-thanku.elv

Command-Line Arguments

Output Formats

Markdown Table

| Name | Description | Source | Stats | Status |
|------|-------------|--------|-------|--------|
|🔍   |  Normal     |        |       |        |
|[serde](https://crates.io/crates/serde) | Serialization framework | [GitHub](https://github.com/serde-rs/serde) | 🌟 3.5k | ✅ |

Markdown List

# Dependencies

- [serde](https://crates.io/crates/serde) [Serialization framework](https://github.com/serde-rs/serde) (🌟 3.5k) ✅

MARKDOWN/JSON/TOML/YAML/CSV

Also supports structured output formats for programmatic use.

Important Notes

1. Setting a GitHub token (-t or GITHUB_TOKEN env) enables:

   • Fetching additional repository information
   • Automatic fetching stars of dependency repositories
   • Higher API rate limits

2. Failed dependency processing:

   • Won't interrupt the overall process
   • Will be marked with ❌ in the output
   • Shows error messages for debugging

3. Language codes:

   • Supports flexible formats (e.g., "en", "en_US", "en_US.UTF-8")
   • Falls back to primary language code
   • Suggests similar codes for typos

Acknowledgments

This project itself is built with many excellent Rust crates. Here are some key dependencies:

For a complete list of dependencies and their acknowledgments, run:

cargo thanku

License

This project is licensed under the MIT License - see the LICENSE file for details.