Virgo ♍︎ Rust Crate Management for Vim 🦀

Virgo (Vim & Cargo) is a Rust crate management system, seamlessly integrated into Vim.

---

📖 Table of Contents

• 🔥 Features
• 🚀 What's New
• 🚀 Installation
• 🛠️ Commands Overview
• 📸 Usage Examples
• 🛠️ Troubleshooting

---

🔥 Features

✅ Crate Management - Search, add, remove, update, and rollback Rust crates effortlessly.
✅ Feature Orchestration - Add and remove crate features on the fly.
✅ Native Vim Compatibility - Seamlessly integrates with Vim using intuitive :virgo commands.
✅ Blazing Fast Performance - Built in Rust for maximum speed and efficiency.
✅ Fully Automated - No manual edits needed; Virgo takes care of Cargo.toml for you.
✅ Crate Info - Discover documentation, stats, and detailed crate info directly in Vim.
✅ Backup & Restore - Secure your Cargo.toml, rollback safely, and prevent accidental changes.
✅ Visual Feedback - Enhanced output formatting for structured readability and usability.
✅ Dependency Insights - Examine dependencies, visualize trees, track updates, and filter changelogs.
✅ Breaking Changes - Analyze Cargo.toml for breaking updates before they happen.
✅ Rollback Protection - Easily revert changes, maintain stability, and prevent unintended updates.
✅ Compare Versions - Instantly compare bleeding-edge vs latest stable versions.
✅ Docs Lookup - Fetch crate documentation and examples directly from docs.rs.
✅ Complete Cargo.toml Management - Health checks, edits, structured initialization, and validation.

---

🚀 What's New - v1.4.0

Optimizations – Added threading to outdated and depends commands which access crates.io concurrently, siginificantly reducing delays

---

🚀 Installation

With vim-plug

Add this to your Vim configuration (~/.vimrc or ~/.config/nvim/init.vim):

Plug 'dntstck/virgo'

Then run:

:PlugInstall

With Vundle

Add this to your .vimrc:

Plugin 'dntstck/virgo'

Then install it with:

:PluginInstall

With Pathogen

Clone the repo into your Vim bundle directory:

git clone https://github.com/dntstck/virgo-vim ~/.vim/bundle/virgo-vim

---

🛠️ Commands Overview

🔍 Search & Information

:virgo search      " Search for a crate on crates.io
:virgo stats       " Display the stats of a crate
:virgo info        " Displays detailed info of a crate
:virgo versions    " Displays all available versions of a crate
:virgo trending    " Displays trending crates

🛠 Dependency Management

:virgo add         " Adds selected crate, use -f <feature> to add crate features 
:virgo remove      " Removes selected crate, use -f <feature> to remove crate features
:virgo update      " Updates selected dependency
:virgo rollback    " Rolls back to a previous version
:virgo compare     " Compares bleeding-edge with latest stable version of a selected crate
:virgo depends     " Displays all the dependencies of a selected crate

📜 Project & Cargo.toml Handling

:virgo all         " Displays all installed dependencies in Cargo.toml
:virgo health      " Checks current Cargo.toml for overall health
:virgo breaking    " Analyzes Cargo.toml for breaking changes
:virgo lockfile    " Inspects Cargo.lock for precise version tracking
:virgo changelog   " View changelog for a selected crate (Filter by major, minor, patch, since x.x.x & more)
:virgo tree        " Display a tree of dependencies for a crate
:virgo init        " Creates a basic Cargo.toml in the current dir
:virgo edit        " Edit Name, Version, and Edition in the current Cargo.toml 

🔄 Backup & Restore

:virgo backup      " Backup Cargo.toml
:virgo restore     " Restore Cargo.toml from latest backup

📚 Documentation & Help

:virgo docs        "View documentation for a selected crate, use -o to open in docs.rs or -e to view examples
:virgo help        "Print this message or the help of the given subcommand(s)
:virgo about       "Display information about Virgo

---

📸 Usage Examples

🛠 Adding a Crate

Instantly add crates without leaving Vim.

🔍 Viewing Installed Crates

Displays all currently installed dependencies in Cargo.toml.

🔄 Creating a Backup

Secure your Cargo.toml before making changes.

⚠️ Detecting Breaking Changes

Analyze Cargo.toml for potential breaking updates.

📜 Viewing Changelog Entries

Filter changelogs by major, minor, patch, or version.

🔍 Comparing Versions

Instantly compare bleeding-edge with latest stable.

🔗 Inspecting Dependencies

Display dependencies of a selected crate.

📚 Viewing Documentation & Examples

Quickly fetch crate documentation and code examples.

🔎 Viewing Examples

Displays example snippets for a selected crate.

🌐 Opening Docs.rs

Open crate documentation directly in a browser.

✏️ Editing Cargo.toml

Modify Name, Version, and Edition in Cargo.toml.

✅ Checking Cargo.toml Health

Verify the integrity and structure of Cargo.toml.

ℹ️ Viewing Crate Info

Display detailed information about a crate.

🔑 Inspecting Cargo.lock

Track precise crate versions in Cargo.lock.

⚠️ Checking Outdated Dependencies

Identify outdated dependencies without Cargo.

❌ Removing Crates

Easily remove a selected crate.

🔄 Restoring a Backup

Revert Cargo.toml to a previous backup.

⏪ Rolling Back Versions

Roll back crates to a previous version.

🔎 Searching for Crates

Find dependencies with blazing-fast lookup.

📊 Viewing Crate Stats

Display download counts, ratings, and more.

🌳 Viewing Dependency Tree

Display a structured dependency tree for a crate.

🔥 Discovering Trending Crates

Find trending crates on crates.io.

🔄 Updating Crates

Update a dependency to the latest stable version.

📦 Viewing Available Versions

Display all available versions of a crate.

---

🛠️ Troubleshooting

Common Issues

Permission Denied?

chmod +x ~/.vim/bundle/virgo/bin/virgo

Cargo.lock Conflicts?

cargo generate-lockfile