Skip to content

huy209vn/Rust-crate-analyser

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 

Repository files navigation

🦀 Rust Library Analyzer – Final Feature List (V1 + Ambitious Ideas) Core MVP (Do This First): Scan Crate Directory:

CLI takes a path to a Rust crate/project.

Public API Extraction:

List all public functions, structs, enums, traits, and type aliases.

Group by module, show where each item lives.

Undocumented Detector:

Flag every public item missing a /// doc comment.

Optionally, warn for lazy/empty comments (e.g. only “TODO”).

Trait Implementation Map:

List all traits and show which types implement them (as much as syn allows).

Bonus: List methods provided by traits.

Doc Linker:

For each item, print docs.rs URL (if crate is published), else local path for generating docs.

Print out the first usage example from doc comments (if found).

Colorized/Organized Output:

Clear terminal output, color by item type, organize by module.

Easy to scan and copy.

Help & Usage Flags:

Print help message, support filtering (e.g. show only undocumented items, only traits, etc.).

Killer Advanced Features (For Later Versions): API Diff/Changelog:

Compare two versions of a crate, highlight API additions, removals, and doc changes.

Coverage and Quality Audits:

Percent of public API documented, items with examples, average doc length.

Export as JSON/Graphviz:

For use in GUIs or for CI automation.

Structure Visualizer:

Output a module tree, trait/type relationship graph (ASCII or Graphviz format).

Unused/Deprecated Item Detector:

Flag #[deprecated] items or items never used within the crate.

“Explain” Command (AI Add-on):

For any function/type/trait, auto-generate a human-friendly explanation (use LLM or local AI).

Pluggable Checks:

Allow users to define custom rules or checks (e.g., “warn if a module has >20 pub items”).

What Makes It Unique: Builder’s Perspective: Not for users reading docs, but for authors improving code, doc coverage, and API quality.

Actionable Feedback: Instantly see what’s missing, weak, or complex.

Deep Insight: Not just a list—see relationships, gaps, examples, and quality at a glance.

Offline & Local: Works for private/WIP projects, not just published crates.

About

analyses the Rust crate

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages