https://github.com/nwiizo/cargo.nvim
A Neovim plugin that provides seamless integration with Rust's Cargo commands. Execute Cargo commands directly from Neovim with a floating window interface.
https://github.com/nwiizo/cargo.nvim
lua neovim neovim-plugin rust rust-lang
Last synced: 18 days ago
JSON representation
A Neovim plugin that provides seamless integration with Rust's Cargo commands. Execute Cargo commands directly from Neovim with a floating window interface.
- Host: GitHub
- URL: https://github.com/nwiizo/cargo.nvim
- Owner: nwiizo
- License: mit
- Created: 2025-01-14T01:26:21.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-03-06T11:55:03.000Z (about 2 months ago)
- Last Synced: 2025-04-06T03:58:28.481Z (19 days ago)
- Topics: lua, neovim, neovim-plugin, rust, rust-lang
- Language: Rust
- Homepage:
- Size: 1.27 MB
- Stars: 73
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- fucking-awesome-rust - cargo.nvim - A Neovim plugin for seamless integration with Cargo commands. (Development tools / IDEs)
- awesome-rust - cargo.nvim - A Neovim plugin for seamless integration with Cargo commands. (Development tools / IDEs)
README
# 🚀 cargo.nvim
[](https://github.com/nwiizo/cargo.nvim/actions/workflows/rust.yml)
[](https://github.com/nwiizo/cargo.nvim/actions/workflows/lua.yml)---
📦 A Neovim plugin that provides seamless integration with Rust's Cargo commands. Execute Cargo commands directly from Neovim with a floating window interface.
## ✨ Features
- 🔧 Execute Cargo commands directly from Neovim
- 🪟 Real-time output in floating windows
- 🎨 Syntax highlighting for Cargo output
- ⚡ Asynchronous command execution
- 🔄 Auto-closing windows on command completion
- ⌨️ Easy keyboard shortcuts for window management## contents
- [🚀 cargo.nvim](#-cargonvim)
- [✨ Features](#-features)
- [📥 Installation](#-installation)
- [Using lazy.nvim](#using-lazynvim)
- [Using packer.nvim](#using-packernvim)
- [📋 Requirements](#-requirements)
- [🛠️ Available Commands](#️-available-commands)
- [⚙️ Configuration](#️-configuration)
- [⌨️ Key Mappings](#️-key-mappings)
- [👥 Contributing](#-contributing)
- [📜 License](#-license)
- [💝 Acknowledgements](#-acknowledgements)## 📥 Installation
### Using [lazy.nvim](https://github.com/folke/lazy.nvim)
```lua
{
"nwiizo/cargo.nvim",
build = "cargo build --release",
config = function()
require("cargo").setup({
float_window = true,
window_width = 0.8,
window_height = 0.8,
border = "rounded",
auto_close = true,
close_timeout = 5000,
})
end,
ft = { "rust" },
cmd = {
"CargoBench",
"CargoBuild",
"CargoClean",
"CargoDoc",
"CargoNew",
"CargoRun",
"CargoTest",
"CargoUpdate"
}
}
```### Using [packer.nvim](https://github.com/wbthomason/packer.nvim)
```lua
use {
"nwiizo/cargo.nvim",
run = "cargo build --release",
config = function()
require("cargo").setup({
float_window = true,
window_width = 0.8,
window_height = 0.8,
border = "rounded",
auto_close = true,
close_timeout = 5000,
})
end,
}
```## 📋 Requirements
- 💻 Neovim >= 0.9.0
- 🦀 Rust and Cargo installed on your system
- 📚 Additional dependencies:
- **Ubuntu/Debian:** `libluajit-5.1-dev` (Install with `sudo apt install libluajit-5.1-dev`)
- For other Linux distributions, you may need to install an equivalent LuaJIT development packageIf you encounter build errors mentioning `lluajit-5.1` during installation, you likely need to install the LuaJIT development package for your system.
## 🛠️ Available Commands
- 📊 `:CargoBench` - Run benchmarks
- 🏗️ `:CargoBuild` - Build the project
- 🧹 `:CargoClean` - Remove generated artifacts
- 📚 `:CargoDoc` - Generate project documentation
- ✨ `:CargoNew` - Create a new Cargo project
- ▶️ `:CargoRun` - Run the project
- 🧪 `:CargoTest` - Run tests
- 🔄 `:CargoUpdate` - Update dependencies
- 🤖 `:CargoAutodd` - Automatically manage dependencies## ⚙️ Configuration
You can customize cargo.nvim by passing options to the setup function:
```lua
require("cargo").setup({
-- Window settings
float_window = true, -- Use floating window
window_width = 0.8, -- Window width (80% of editor width)
window_height = 0.8, -- Window height (80% of editor height)
border = "rounded", -- Border style ("none", "single", "double", "rounded")
-- Auto-close settings
auto_close = true, -- Auto close window on success
close_timeout = 5000, -- Close window after 5000ms
-- Command settings
commands = {
bench = { nargs = "*" }, -- Command arguments configuration
build = { nargs = "*" },
clean = { nargs = "*" },
doc = { nargs = "*" },
new = { nargs = 1 },
run = { nargs = "*" },
test = { nargs = "*" },
update = { nargs = "*" },
}
})
```## ⌨️ Key Mappings
In the floating window:
- `q` or `` - Close the window
- `` - Cancel the running command and close the window## 👥 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
1. 🍴 Fork the repository
2. 🌿 Create a feature branch
3. ✍️ Commit your changes
4. 🚀 Push to the branch
5. 📫 Open a Pull Request## 📜 License
MIT License - see the [LICENSE](LICENSE) file for details.
## 💝 Acknowledgements
This plugin is inspired by various Neovim plugins and the Rust community.
## 🎉 Related Projects
- [cargo-autodd](https://github.com/nwiizo/cargo-autodd)