cargo-limit
The continued development of cargo-limit is made possible thanks to the support of awesome backers β€οΈ
If you'd like to join them, please consider contributing with Crypto or Patreon.
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' 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 in your text editor on affected lines
This tool is especially useful in combination with cargo-watch.
Initially this project was just a workaround for this issue.
Check out ποΈ Rustacean Station podcast episode for more.
Installation
From crates.io
cargo install cargo-limit
From git
cargo install --force --git https://github.com/alopatindev/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. β these auto-open text editor for warnings as well, not just errors.
π‘ 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 error1
is default0
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
- empty (
""
) means don't run external app "_cargo-limit-open-in-nvim"
is default
Text Editor/IDE integrations
π‘ Neovim Plugin ποΈ
Enable the plugin in your init.vim
. For instance for vim-plug:
Plug 'alopatindev/cargo-limit', { 'do': 'cargo install cargo-limit nvim-send' }
and install it with
nvim +PlugInstall +UpdateRemotePlugins +qa
Optionally: F2 to save, F2 again to jump to next affected line
function! SaveAllFilesOrOpenNextLocation()
let l:all_files_are_saved = 1
for i in getbufinfo({'bufmodified': 1})
if i.name != ''
let l:all_files_are_saved = 0
break
endif
endfor
if l:all_files_are_saved
call g:CargoLimitOpenNextLocation()
else
execute 'wa'
endif
endfunction
nmap <F2> :call SaveAllFilesOrOpenNextLocation()<cr>
vmap <F2> <esc>:call SaveAllFilesOrOpenNextLocation()<cr>v
imap <F2> <esc>:call SaveAllFilesOrOpenNextLocation()<cr>i
π‘ Test the plugin! ποΈ
- Open two terminals (or tmux windows, etc.)
cd your/project/directory
in both of them- Run
nvim
in one of them - Run
cargo lrun
in the other - In case of compiling errors
nvim
opens new or existing tabs with the files on affected lines and columns - Fix the error, save the file and
nvim
will jump to the next error location 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.}
.
nvim
: Current Directory should be Project (sub)directory
3. Before running - that's required so cargo-limit could figure out 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
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
endfunction
Populate a QuickFix List
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
endfunction
π‘ Other Text Editors/IDEs ποΈ
cargo-limit can run external app/script and provide affected locations to stdin in the following JSON format:
{
"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! ποΈ
- Install
jq
- Create
open-in-gedit.sh
:
#!/bin/bash
jq --raw-output '.files |= unique_by(.path) | .files[] | [
"gedit",
.path,
"+" + (.line | tostring) + ":" + (.column | tostring),
"&"
] | join(" ")' | bash
chmod +x open-in-gedit.sh
- Set
CARGO_EDITOR=/path/to/open-in-gedit.sh
environment variable - Run
cargo lrun
in your project directory - In case of compiling errors
open-in-gedit.sh
will open files ingedit
on affected lines and columns cargo llrun
(cargo llcheck
, etc.) will open them in case of warnings as well.
Similar Projects/Inspirations
- bacon is a background rust code checker
- cargo-firstpage shows only the first page of rustc output
- ograc like cargo, but backwards
Support
Thank you for making π a better place by supporting Free/Libre and Open Source Software development! β€οΈ
Also thanks everyone for code contributions and bug reporting. Special thanks to Casey Rodarmor for providing VimL code for quickfix populator and Otavio Salvador for NixOS package!
Wanna Contribute?
Please check out issues and kanban board. You can also make a package for your favorite OS distribution.
License
MIT/Apache-2.0