https://github.com/yuniqueunic/cargo-thanku

cargo-thanku | Rust Dependency Acknowledgment Generator 🦀 ❤️‍🔥 Enhanced cargo-thanks, give an Acknowledgment to your rust project for thanks. Automatically generate polished acknowledgments for your Rust project's dependencies ✨ Multi-format outputs (Markdown/JSON/YAML/CSV) • 🚀 Concurrent GitHub/crates.io API integration • 🌐 Multi-languages
https://github.com/yuniqueunic/cargo-thanku

acknowledgement cargo cli rust thanks tool

Last synced: 4 months ago
JSON representation

cargo-thanku | Rust Dependency Acknowledgment Generator 🦀 ❤️‍🔥 Enhanced cargo-thanks, give an Acknowledgment to your rust project for thanks. Automatically generate polished acknowledgments for your Rust project's dependencies ✨ Multi-format outputs (Markdown/JSON/YAML/CSV) • 🚀 Concurrent GitHub/crates.io API integration • 🌐 Multi-languages

• Host: GitHub
• URL: https://github.com/yuniqueunic/cargo-thanku
• Owner: YuniqueUnic
• License: mit
• Created: 2025-03-13T16:24:06.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-11-21T05:43:55.000Z (7 months ago)
• Last Synced: 2025-11-21T06:07:05.085Z (7 months ago)
• Topics: acknowledgement, cargo, cli, rust, thanks, tool
• Language: Rust
• Homepage: https://crates.io/crates/cargo-thanku
• Size: 546 KB
• Stars: 32
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Cargo Thanku

[中文 README.md](./README_CN.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)

## Architecture Overview

- `src/app` owns CLI bootstrapping, command dispatch (`convert`, `completions`, `test`), logging initialization, and the asynchronous dependency-processing pipeline built on `tokio` semaphores plus `FuturesUnordered` for smoother bounded concurrency.

- `src/output` is split into focused modules:

  - `output/dependency.rs` defines the domain entities (`DependencyInfo`, `DependencyKind`, parsing helpers, failure helpers).

  - `output/markdown/tokenizer.rs` exposes a lightweight tokenizer for Markdown list headers/items so parsing no longer relies on brittle string splits.

  - `output/format/` hosts Markdown, CSV, and structured (JSON/TOML/YAML) formatters behind a shared `Formatter` trait and `OutputFormat` enum.

  - `output/manager.rs` centralizes writer orchestration so CLI and the converter can stream results to stdout/files uniformly.

- `sources.rs` keeps HTTP clients (crates.io + GitHub) isolated; integration-style tests that hit the network are flagged with `#[ignore]` so the default `cargo test` run stays deterministic/offline-friendly.

- `travert::Converter` parses once using a streaming `BufReader` and writes each target file via `BufWriter`, which reduces peak memory and improves throughput for large conversion batches.

- `tests/` mirrors the module layout (`config_tests.rs`, `markdown_format_tests.rs`, etc.) and runs entirely through the public API; ignored cases (like live crates.io calls) are clearly tagged so CI remains deterministic.

A quick glance at `app/pipeline.rs` + `output/` is usually all you need to understand how new data sources or formats plug into the tool.

## Installation

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

```bash

# 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

```bash

# 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

```bash

# 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:

```bash

# 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

  

| Argument            | Description                                        | Default Value     |

|---------------------|----------------------------------------------------|-------------------|

| `-i, --input`       | Input Cargo.toml file path                         | -                 |

| `-o, --outputs`     | Output file formats                                | -                 |

| `-l, --language`    | Language (zh/en/ja/ko/es/fr/de/it)                 | `zh`              |

| `-v, --verbose`     | Enable verbose logging                             | `false`           |

### Command-Line Completion

Generate command-line completion scripts for various shells:

```bash

# 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

```

## Testing

Run the entire suite (unit-style and integration) with:

```bash

cargo test

```

Network-dependent checks are ignored by default; include them with `cargo test -- --ignored` when you have connectivity and credentials.

## Command-Line Arguments

| Argument            | Description                                        | Default Value     |

|---------------------|----------------------------------------------------|-------------------|

| `-i, --input`       | Input Cargo.toml file path                         | `Cargo.toml`      |

| `-o, --output`      | Output file path                                   | `thanks.md`       |

| `-f, --format`      | Output format                                      | `markdown-table`  |

| `-t, --token`       | GitHub API token                                   | -                 |

| `-l, --language`    | Language (zh/en/ja/ko/es/fr/de/it)                 | `zh`              |

| `-v, --verbose`     | Enable verbose logging                             | `false`           |

| `-j, --concurrent`  | Maximum concurrent requests                        | `5`               |

| `-r, --retries`     | Maximum retry attempts                             | `3`               |

| `--no-relative-libs`| Filter out libraries imported with relative paths  | `false`           |

## Output Formats

### Markdown Table

```markdown

| 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

```markdown

# 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:

> [!TIP]

> Generated by `cargo-thanku` tool

| Name | Description | Crates.io | Source | Stats | Status |

|------|--------|--------|-------|-------|--------|

|🔍|Normal| | | | |

| anyhow | Flexible concrete Error type built on std::error::Error | [anyhow](https://crates.io/crates/anyhow) | [GitHub](https://github.com/dtolnay/anyhow) | ❓ | ✅ |

| cargo_metadata | structured access to the output of `cargo metadata` | [cargo_metadata](https://crates.io/crates/cargo_metadata) | [GitHub](https://github.com/oli-obk/cargo_metadata) | ❓ | ✅ |

| clap | A simple to use, efficient, and full-featured Command Line Argument Parser | [clap](https://crates.io/crates/clap) | [GitHub](https://github.com/clap-rs/clap) | ❓ | ✅ |

| clap_complete | Generate shell completion scripts for your clap::Command | [clap_complete](https://crates.io/crates/clap_complete) | [GitHub](https://github.com/clap-rs/clap) | ❓ | ✅ |

| futures | An implementation of futures and streams featuring zero allocations, composability, and iterator-like interfaces.  | [futures](https://crates.io/crates/futures) | [GitHub](https://github.com/rust-lang/futures-rs) | ❓ | ✅ |

| reqwest | higher level HTTP client library | [reqwest](https://crates.io/crates/reqwest) | [GitHub](https://github.com/seanmonstar/reqwest) | ❓ | ✅ |

| rust-i18n | Rust I18n is use Rust codegen for load YAML file storage translations on compile time, and give you a t! macro for simply get translation texts. | [rust-i18n](https://crates.io/crates/rust-i18n) | [GitHub](https://github.com/longbridge/rust-i18n) | ❓ | ✅ |

| serde | A generic serialization/deserialization framework | [serde](https://crates.io/crates/serde) | [GitHub](https://github.com/serde-rs/serde) | ❓ | ✅ |

| serde_json | A JSON serialization file format | [serde_json](https://crates.io/crates/serde_json) | [GitHub](https://github.com/serde-rs/json) | ❓ | ✅ |

| serde_yaml | YAML data format for Serde | [serde_yaml](https://crates.io/crates/serde_yaml) | [GitHub](https://github.com/dtolnay/serde-yaml) | ❓ | ✅ |

| strsim | Implementations of string similarity metrics. Includes Hamming, Levenshtein, OSA, Damerau-Levenshtein, Jaro, Jaro-Winkler, and Sørensen-Dice.  | [strsim](https://crates.io/crates/strsim) | [GitHub](https://github.com/rapidfuzz/strsim-rs) | ❓ | ✅ |

| thiserror | derive(Error) | [thiserror](https://crates.io/crates/thiserror) | [GitHub](https://github.com/dtolnay/thiserror) | ❓ | ✅ |

| tokio | An event-driven, non-blocking I/O platform for writing asynchronous I/O backed applications.  | [tokio](https://crates.io/crates/tokio) | [GitHub](https://github.com/tokio-rs/tokio) | ❓ | ✅ |

| toml | A native Rust encoder and decoder of TOML-formatted files and streams. Provides implementations of the standard Serialize/Deserialize traits for TOML data to facilitate deserializing and serializing Rust structures.  | [toml](https://crates.io/crates/toml) | [GitHub](https://github.com/toml-rs/toml) | ❓ | ✅ |

| tracing | Application-level tracing for Rust.  | [tracing](https://crates.io/crates/tracing) | [GitHub](https://github.com/tokio-rs/tracing) | ❓ | ✅ |

| tracing-subscriber | Utilities for implementing and composing `tracing` subscribers.  | [tracing-subscriber](https://crates.io/crates/tracing-subscriber) | [GitHub](https://github.com/tokio-rs/tracing) | ❓ | ✅ |

| url | URL library for Rust, based on the WHATWG URL Standard | [url](https://crates.io/crates/url) | [GitHub](https://github.com/servo/rust-url) | ❓ | ✅ |

|🔧|Development| | | | |

| assert_fs | Filesystem fixtures and assertions for testing. | [assert_fs](https://crates.io/crates/assert_fs) | [GitHub](https://github.com/assert-rs/assert_fs.git) | ❓ | ✅ |

| pretty_assertions | Overwrite `assert_eq!` and `assert_ne!` with drop-in replacements, adding colorful diffs. | [pretty_assertions](https://crates.io/crates/pretty_assertions) | [GitHub](https://github.com/rust-pretty-assertions/rust-pretty-assertions) | ❓ | ✅ |

| tokio-test | Testing utilities for Tokio- and futures-based code  | [tokio-test](https://crates.io/crates/tokio-test) | [GitHub](https://github.com/tokio-rs/tokio) | ❓ | ✅ |

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

```bash

cargo thanku

```

## License

This project is licensed under the MIT License - see the [LICENSE](./LICENSE.md) file for details.