Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added support for rustfmt before save #49

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Description

This is a vim plugin that provides [Rust][r] file detection and syntax highlighting.
This is a vim plugin that provides [Rust][r] file detection, syntax highlighting, and (optional) autoformatting.

## Installation

Expand Down Expand Up @@ -31,3 +31,8 @@ git clone --depth=1 https://github.com/rust-lang/rust.vim.git ~/.vim/bundle/rust

1. Add `NeoBundle 'rust-lang/rust.vim'` to `~/.vimrc`
2. Re-open vim or execute `:source ~/.vimrc`

## Enabling autoformat

This plugin can optionally format your code using [rustfmt][rfmt] every time a
buffer is written. Simple put `let g:rust_fmt_autosave = 1` in your `.vimrc`.
80 changes: 80 additions & 0 deletions autoload/rustfmt.vim
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
" WTF License
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't a "real" license, so I wonder if we can take it...

" Author: stephen@stephensugden.com
"
" Directly based on the go#fmt#Format plugin from fatih/vim-go

if !exists("g:rustfmt_autosave")
let g:rustfmt_autosave = 0
endif

if !exists("g:rustfmt_command")
let g:rustfmt_command = "rustfmt"
endif

if !exists("g:rustfmt_options")
let g:rustfmt_options = ""
endif

if !exists("g:rustfmt_fail_silently")
let g:rustfmt_fail_silently = 0
endif

let s:got_fmt_error = 0

function! rustfmt#Format()
let l:curw = winsaveview()
let l:tmpname = tempname()
call writefile(getline(1, '$'), l:tmpname)

let command = g:rustfmt_command . " --write-mode=replace "

let out = system(command . g:rustfmt_options . " " . l:tmpname)

"if there is no error on the temp file replace the output with the current
"file (if this fails, we can always check the outputs first line with:
"splitted =~ 'package \w\+')
if v:shell_error == 0
" remove undo point caused via BufWritePre
try | silent undojoin | catch | endtry

" Replace current file with temp file, then reload buffer
call rename(l:tmpname, expand('%'))
silent edit!
let &syntax = &syntax

" only clear quickfix if it was previously set, this prevents closing
" other quickfixes
if s:got_fmt_error
let s:got_fmt_error = 0
call setqflist([])
cwindow
endif
elseif g:rustfmt_fail_silently == 0
let splitted = split(out, '\n')
"otherwise get the errors and put them to quickfix window
let errors = []
for line in splitted
" src/lib.rs:13:5: 13:10 error: expected `,`, or `}`, found `value`
let tokens = matchlist(line, '^\(.\{-}\):\(\d\+\):\(\d\+\):\s*\(\d\+:\d\+\s*\)?\s*error: \(.*\)')
if !empty(tokens)
call add(errors, {"filename": @%,
\"lnum": tokens[2],
\"col": tokens[3],
\"text": tokens[5]})
endif
endfor
if empty(errors)
% | " Couldn't detect rustfmt error format, output errors
endif
if !empty(errors)
call setqflist(errors, 'r')
echohl Error | echomsg "rustfmt returned error" | echohl None
endif
let s:got_fmt_error = 1
cwindow
" We didn't use the temp file, so clean up
call delete(l:tmpname)
endif

call winrestview(l:curw)
endfunction
6 changes: 6 additions & 0 deletions plugin/rustfmt.vim
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
augroup rustfmt
" code formatting on save
if get(g:, "rustfmt_autosave", 1)
autocmd BufWritePre *.rs call rustfmt#Format()
endif
augroup END