Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cargo-limit/cargo-limit
Productivity improvements for Rust ecosystem: warnings are skipped until errors are fixed, LSP-independent Neovim integration, etc.
https://github.com/cargo-limit/cargo-limit
build cargo cargo-plugin cargo-wrapper cli crates deduplication filter limit neovim neovim-plugin nvim plugin productivity runner rust wrapper
Last synced: 2 days ago
JSON representation
Productivity improvements for Rust ecosystem: warnings are skipped until errors are fixed, LSP-independent Neovim integration, etc.
- Host: GitHub
- URL: https://github.com/cargo-limit/cargo-limit
- Owner: cargo-limit
- License: apache-2.0
- Created: 2020-09-13T23:01:03.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-09T11:14:13.000Z (3 months ago)
- Last Synced: 2024-10-29T23:35:58.249Z (16 days ago)
- Topics: build, cargo, cargo-plugin, cargo-wrapper, cli, crates, deduplication, filter, limit, neovim, neovim-plugin, nvim, plugin, productivity, runner, rust, wrapper
- Language: Rust
- Homepage:
- Size: 457 KB
- Stars: 262
- Watchers: 3
- Forks: 3
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# cargo-limit [](https://crates.io/crates/cargo-limit) [](https://crates.io/crates/cargo-limit) [](https://github.com/rust-unofficial/awesome-rust#build-system)
[](https://liberapay.com/cargo-limit/donate)
[](https://ko-fi.com/summary/8c07db6b-1b19-4af7-bc6d-c321db86ade0)
[](https://www.patreon.com/checkout/alopatindev/9785189)
[](https://opencollective.com/cargo-limit)
[](#Support)
## Description
🚀 Cargo with less noise:
- errors have highest priority
- they never appear in the middle of warnings
- **warnings are skipped** by default until errors are fixed
- external [path dependencies'](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-path-dependencies) warnings are skipped by default
- all messages come **in reversed order** by default
- to avoid extra scrolling
- messages are grouped by filenames
- number of messages can be limited
- after encountering **first error** the rest of **build time is limited** by default
- files can be **[automatically opened](#text-editoride-integrations) in your text editor on affected lines**
Initially this project was a workaround for **[this issue](https://github.com/rust-lang/rust/issues/27189), which was closed with no adequate solution**.
Check out [roadmap](https://github.com/cargo-limit/cargo-limit/projects/1?fullscreen=true), [issues](https://github.com/cargo-limit/cargo-limit/issues) and [🎙️ Rustacean Station podcast episode](https://rustacean-station.org/episode/alexander-lopatin/) for more.
[](https://asciinema.org/a/441673)
## Installation
### From crates.io
```
cargo install --locked cargo-limit
```
### From git
```
cargo install --locked --force --git https://github.com/cargo-limit/cargo-limit
```
## Usage
Run any of these in your project directory:
```
cargo lbench
cargo lbuild
cargo lcheck
cargo lclippy
cargo ldoc
cargo lfix
cargo lrun
cargo lrustc
cargo lrustdoc
cargo ltest
```
Also `llcheck`, `llrun`, etc. to **auto-open text editor for warnings** as well, not just for errors.
This tool is especially useful in combination with [cargo-watch](https://crates.io/crates/cargo-watch).
💡 Environment Variables 👁️
### CARGO_MSG_LIMIT
- limit compiler messages number
- `0` means no limit, which is default
### CARGO_TIME_LIMIT
- `cargo` execution time limit in seconds after encountering first compiling error
- `1` is default
- `0` means no limit
### CARGO_ASC
- show compiler messages in ascending order
- `false` is default
### CARGO_FORCE_WARN
- show warnings even if errors still exist
- `false` is default
### CARGO_DEPS_WARN
- show external path dependencies' warnings
- `false` is default
### CARGO_EDITOR
- opens affected files in external app
- see [neovim integration](#text-editoride-integrations)
- empty (`""`) means don't run external app
- `"_cargo-limit-open-in-nvim"` is default
## Text Editor/IDE integrations
💡 Neovim Plugin 👁️
Requires `nvim >= 0.7.0` and `git` to be installed.
This plugin is [LSP](https://microsoft.github.io/language-server-protocol/)-independent, **it will keep working even when [rust-analyzer](https://rust-analyzer.github.io/) fails** to produce diagnostics!
### Using **[vim-plug](https://github.com/junegunn/vim-plug#neovim):**
```viml
Plug 'alopatindev/cargo-limit', { 'do': 'cargo install --locked cargo-limit nvim-send' }
```
and run
```bash
nvim +PlugInstall +UpdateRemotePlugins +qa
```
💡 Using other Neovim Plugin Managers 👁️
### [lazy.nvim](https://github.com/folke/lazy.nvim)
```lua
{ 'alopatindev/cargo-limit', build = 'cargo install --locked cargo-limit nvim-send' },
```
and run
```bash
nvim --headless "+Lazy! sync" +qa
```
### [paq-nvim](https://github.com/savq/paq-nvim):
```lua
{ 'alopatindev/cargo-limit', build = ':!cargo install --locked cargo-limit nvim-send' },
```
and run
```bash
nvim +PaqSync +qa
```
### [packer.nvim](https://github.com/wbthomason/packer.nvim):
```lua
{ use 'alopatindev/cargo-limit', run = ':!cargo install --locked cargo-limit nvim-send' }
```
and run
```bash
nvim +PackerUpdate +qa
```
### [dein](https://github.com/Shougo/dein.vim):
```viml
call dein#add('alopatindev/cargo-limit', { 'rev': 'master', 'hook_post_update': '!cargo install --locked cargo-limit nvim-send' })
```
and run
```bash
nvim --cmd '!call dein#install()'
```
### Optionally: F2 to save, F2 again to jump to next affected line
```viml
fun! SaveAllFilesOrOpenNextLocation()
let l:all_files_are_saved = v:true
for i in getbufinfo({'bufmodified': 1})
if i.name !=# ''
let l:all_files_are_saved = v:false
break
endif
endfor
if l:all_files_are_saved
if exists('*CargoLimitOpenNextLocation')
call g:CargoLimitOpenNextLocation()
endif
else
execute 'wa!'
endif
endf
nmap :call SaveAllFilesOrOpenNextLocation()
vmap :call SaveAllFilesOrOpenNextLocation()v
imap :call SaveAllFilesOrOpenNextLocation()i
```
### Optionally: less verbose messages
```viml
let g:CargoLimitVerbosity = 2 " warnings level
```
💡 Test the plugin! 👁️
1. Open two terminals (or tmux windows, etc.)
2. `cd your/project/directory` in both of them
3. Run `nvim` in one of them
4. Run `cargo lrun` in the other
5. In case of compiling errors `nvim` opens new or existing tabs with the files on affected lines and columns
6. Fix the error, save the file and `nvim` will jump to the next error location
7. `cargo llrun` (`cargo llcheck`, etc.) will open them in case of warnings as well.
⚠️ Known Limitations! 👁️
### 1. Auto-jumps work only if
- current **mode is normal**
- current buffer is either **empty or contains some existing and unmodified** (saved) file
This is by design, in order to **not disrupt** from active text editing or file navigation process.
### 2. Auto-jump on each file save is currently imprecise
- it may jump to a wrong line if it moved
- it may not jump at all, if the next affected line is supposed to be modified already
For precise jump please rerun `cargo ll{check,run,etc.}`.
### 3. Before running `nvim`: Current Directory should be Project (sub)directory
- that's required so **cargo-limit** could [figure out](https://github.com/cargo-limit/cargo-limit/issues/30#issuecomment-1219793195) which exact `nvim` instance should be controlled
- only **first `nvim` instance** with current project (sub)directory will be **controlled by cargo-limit**.
## Customizations
Add a **custom open handler** to your `init.vim` if you want other Neovim behavior.
💡 See examples! 👁️
### Open Files in Buffers Instead of Tabs
```viml
function! g:CargoLimitOpen(editor_data)
let l:current_file = resolve(expand('%:p'))
if l:current_file != '' && !filereadable(l:current_file)
return
endif
for location in reverse(a:editor_data.files)
let l:path = fnameescape(location.path)
if mode() == 'n' && &l:modified == 0
execute 'edit ' . l:path
call cursor((location.line), (location.column))
else
break
endif
endfor
endf
```
### Populate a QuickFix List
```viml
set errorformat =%f:%l:%c:%m
function! g:CargoLimitOpen(editor_data)
let l:winnr = winnr()
cgetexpr []
for file in a:editor_data['files']
caddexpr file['path'] . ':' . file['line'] . ':' . file['column'] . ':' . file['message']
endfor
if empty(a:editor_data['files'])
cclose
else
copen
endif
if l:winnr !=# winnr()
wincmd p
endif
endf
```
💡 Other Text Editors/IDEs 👁️
**cargo-limit** can run external app/script and provide affected locations to stdin in the following JSON format:
```json
{
"protocol_version": "0.0.11",
"workspace_root": "/full/path/to/project",
"files": [
{
"path": "/full/path/to/project/file.rs",
"line": 4,
"column": 1,
"message": "unused import: `diagnostic::DiagnosticSpan`",
"level": "warning"
}
]
}
```
Theoretically this can be used for any text editor or IDE, especially if it supports client/server communication. To do that you need a **wrapper app/script** that parses the `files` and gives them to the text editor or IDE client.
💡 Example: Gedit! 👁️
1. Install [`jq`](https://stedolan.github.io/jq/download/)
2. Create `open-in-gedit.sh`:
```bash
#!/bin/bash
jq --raw-output '.files |= unique_by(.path) | .files[] | [
"gedit",
.path,
"+" + (.line | tostring) + ":" + (.column | tostring),
"&"
] | join(" ")' | bash
```
3. `chmod +x open-in-gedit.sh`
4. Set `CARGO_EDITOR=/path/to/open-in-gedit.sh` environment variable
5. Run `cargo lrun` in your project directory
6. In case of compiling errors `open-in-gedit.sh` will open files in `gedit` on affected lines and columns
7. `cargo llrun` (`cargo llcheck`, etc.) will open them in case of warnings as well.
## Similar Projects/Inspirations
- [bacon](https://github.com/Canop/bacon) is a background rust code checker
- [cargo-firstpage](https://github.com/cecton/cargo-firstpage) shows only the first page of rustc output
- [ograc](https://gitlab.com/lirnril/ograc) like cargo, but backwards
## Support
If this project improved your workflow — please consider:
- pressing ⭐
- sharing this project with your friends/colleges
- buying me some ~~coffee~~ veggies 🥕
---
Your donations will help me allocate more time to resolve [issues](https://github.com/cargo-limit/cargo-limit/issues) and to **finish all the [planned features](https://github.com/cargo-limit/cargo-limit/projects/1?fullscreen=true)**! ❤️
- **Bitcoin** (BTC) `1Afgvdz1oPaugFcLgDaAzCYYdHexV6tTvH`
- **TRON** (TRX, USDT-TRC20, etc.) `TVxE2HyryNyNReMvw9HRQ3BkYePCszXSrc`
- **Ethereum** (ETH, DAI, etc.) `0xa879cdb1d7d859e6e425f8e50c4ee49f4b3a7b06`
- **TON**: `EQApceYoD6FDKn4azXrUxOIyT8VF4NIV_PRE7x9KsTJC9h0q`
- **Zcash** (ZEC): `t1NiwnuUQC1tENTY2aPDDhKEA3pykF582TP`
- **Litecoin** (LTC): `Le3yFbk854T1nrRUjWHkqTNrwz1zgDFqVX`
- **Monero** (XMR): `46pRHmFpqzUBA8SLrdjW73H6ainCqRGpe8shjqQJ4UoBFAbegkAwqvjTSCBvBL71NZXYhriSuKPBkGxc1FjCeiut2EvFvxk`
- **[Liberapay](https://liberapay.com/cargo-limit)**
- **[Patreon](https://www.patreon.com/checkout/alopatindev/9785189)**
- **[Ko-fi](https://ko-fi.com/summary/8c07db6b-1b19-4af7-bc6d-c321db86ade0)**
- **[Open Collective](https://opencollective.com/cargo-limit)**
For **general donations** dedicated to all my projects please check out ⚡ [here](https://codonaft.com/sponsor).
Thank you for your support! 🙏🏼
---
Also thanks everyone for code contributions and bug reporting. Special thanks to [Casey Rodarmor](https://github.com/casey) for providing VimL code for quickfix populator and [Otavio Salvador](https://github.com/otavio) for [NixOS package](https://search.nixos.org/packages?show=cargo-limit)!
## License
MIT/Apache-2.0