Skip to content

Commit 11decea

Browse files
millermedeirosmillermedeiros
committed
v1.0.0
0 parents  commit 11decea

File tree

4 files changed

+190
-0
lines changed

4 files changed

+190
-0
lines changed

‎LICENSE.txt

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
2+
Version 2, December 2004
3+
4+
Copyright (C) 2004 Sam Hocevar <[email protected]>
5+
6+
Everyone is permitted to copy and distribute verbatim or modified
7+
copies of this license document, and changing it is allowed as long
8+
as the name is changed.
9+
10+
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
11+
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
12+
13+
0. You just DO WHAT THE FUCK YOU WANT TO.

‎README.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# vim-esformatter
2+
3+
makes it easier to execute [esformatter](https://github.com/millermedeiros/esformatter/)
4+
inside vim.
5+
6+
it's better than executing a simple
7+
[`:%!esformatter`](http://vimdoc.sourceforge.net/htmldoc/various.html#:!) on
8+
normal mode because it avoids replacing the buffer content if the script
9+
detected any errors, it restores the cursor position and sets the working
10+
directory to match the file (which changes the way esformatter looks for config
11+
files).
12+
13+
it was inspired by [nisaacson esformatter
14+
plugin](https://gist.github.com/nisaacson/6939960).
15+
16+
17+
## Installation
18+
19+
You will need the esformatter binary available in your path to run the command
20+
21+
```
22+
npm install -g esformatter
23+
```
24+
25+
After that you can use [Vundle](https://github.com/gmarik/Vundle.vim),
26+
[pathogen.vim](https://github.com/tpope/vim-pathogen) or manually copy the
27+
`plugin/esformatter.vim` file into your `~/.vim/plugin` folder to install it.
28+
29+
30+
## Usage
31+
32+
To format the whole file simple call `:Esformatter` while on normal mode.
33+
34+
To format just one block of code select it on visual mode and execute
35+
`:'<,'>EsformatterVisual`.
36+
37+
To make it easier you can create a mapping on your `.vimrc` file like:
38+
39+
```js
40+
" will run esformatter after pressing <leader> followed by the "e" and "s" keys
41+
nnoremap <silent> <leader>es :Esformatter<CR>
42+
vnoremap <silent> <leader>es :EsformatterVisual<CR>
43+
```
44+
45+
46+
## License
47+
48+
released under the [wtfpl](http://sam.zoy.org/wtfpl/COPYING) license

‎doc/esformatter.txt

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
*esformatter.txt* Automatically format your ECMAScript files.
2+
3+
===============================================================================
4+
USAGE *esformatter*
5+
6+
To format the whole file simple call `:Esformatter` while on normal mode.
7+
8+
To format just one block of code select it on visual mode and execute
9+
`:'<,'>EsformatterVisual`.
10+
11+
To make it easier you can create a mapping on your `.vimrc` file like:
12+
13+
```js
14+
" will run esformatter after pressing <leader> followed by the "e" and "s" keys
15+
nnoremap <silent> <leader>es :Esformatter<CR>
16+
vnoremap <silent> <leader>es :EsformatterVisual<CR>
17+
```
18+
19+
===============================================================================
20+
REPOSITORY
21+
22+
https://github.com/millermedeiros/vim-esformatter
23+
24+
25+
===============================================================================
26+
LICENSE
27+
28+
released under the wtfpl http://sam.zoy.org/wtfpl/COPYING
29+
30+

‎plugin/esformatter.vim

+99
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
" ============================================================================
2+
" File: esformatter.vim
3+
" Maintainer: Miller Medeiros <http://blog.millermedeiros.com/>
4+
" Description: Expose commands to execute the esformatter binary on normal and
5+
" visual modes.
6+
" Last Change: 2015-02-27
7+
" License: This program is free software. It comes without any warranty,
8+
" to the extent permitted by applicable law. You can redistribute
9+
" it and/or modify it under the terms of the Do What The Fuck You
10+
" Want To Public License, Version 2, as published by Sam Hocevar.
11+
" See http://sam.zoy.org/wtfpl/COPYING for more details.
12+
" ============================================================================
13+
14+
" heavily inspired by: https://gist.github.com/nisaacson/6939960
15+
16+
if !exists('g:esformatter_debug') && (exists('loaded_esformatter') || &cp)
17+
finish
18+
endif
19+
20+
let loaded_esformatter = 1
21+
22+
function! s:EsformatterNormal()
23+
" store current cursor position and change the working directory
24+
let win_view = winsaveview()
25+
let file_wd = expand('%:p:h')
26+
let current_wd = getcwd()
27+
execute ':lcd' . file_wd
28+
29+
" pass whole buffer content to esformatter
30+
let output = system('esformatter', join(getline(1,'$'), "\n"))
31+
32+
if v:shell_error
33+
echom "Error while executing esformatter! no changes made."
34+
echo output
35+
else
36+
" delete whole buffer content and append the formatted code
37+
normal! ggdG
38+
call append(0, split(output, "\n"))
39+
" need to delete the last line since append() will add an extra line
40+
execute ':$d'
41+
endif
42+
43+
" Clean up: restore previous cursor position and working directory
44+
call winrestview(win_view)
45+
execute ':lcd' . current_wd
46+
endfunction
47+
48+
49+
function! s:EsformatterVisual() range
50+
" store current cursor position and change the working directory
51+
let win_view = winsaveview()
52+
let file_wd = expand('%:p:h')
53+
let current_wd = getcwd()
54+
execute ':lcd' . file_wd
55+
56+
" get lines from the current selection and store the first line number
57+
let range_start = line("'<")
58+
let input = getline("'<", "'>")
59+
60+
" if first/last lines are empty they will be removed after the formatting so
61+
" we set a flag to restore it later
62+
let restore_first_line = 0
63+
if input[0] == ''
64+
let restore_first_line = 1
65+
endif
66+
let restore_last_line = 0
67+
if input[-1] == ''
68+
let restore_last_line = 1
69+
endif
70+
71+
let output = system('esformatter', join(input, "\n"))
72+
73+
if v:shell_error
74+
echom 'Error while executing esformatter! no changes made.'
75+
echo output
76+
else
77+
" delete the old lines
78+
normal! gvd
79+
80+
let new_lines = split(l:output, '\n')
81+
82+
if 1 == restore_first_line
83+
call insert(new_lines, '')
84+
endif
85+
if 1 == restore_last_line
86+
call add(new_lines, '')
87+
endif
88+
89+
" add new lines to the buffer
90+
call append(range_start - 1, new_lines)
91+
endif
92+
93+
" Clean up: restore previous cursor position and working directory
94+
call winrestview(win_view)
95+
execute ':lcd' . current_wd
96+
endfunction
97+
98+
command! -range=0 -complete=shellcmd Esformatter call s:EsformatterNormal()
99+
command! -range=% -complete=shellcmd EsformatterVisual call s:EsformatterVisual()

0 commit comments

Comments
 (0)