Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fixes: #51 This commit adds a google-java-formatter. Some notes: - Mostly a port from the internal version. - I fixed a bug along the way, where if you didn't have clangformat installed, codefmt would error-out during tab-complete. - I fixed a typo in buildifier. - And some minor updates to the README
- Loading branch information
1 parent
c38bd84
commit cad3527
Showing
7 changed files
with
159 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
" Copyright 2017 Google Inc. All rights reserved. | ||
" | ||
" Licensed under the Apache License, Version 2.0 (the "License"); | ||
" you may not use this file except in compliance with the License. | ||
" You may obtain a copy of the License at | ||
" | ||
" http://www.apache.org/licenses/LICENSE-2.0 | ||
" | ||
" Unless required by applicable law or agreed to in writing, software | ||
" distributed under the License is distributed on an "AS IS" BASIS, | ||
" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
" See the License for the specific language governing permissions and | ||
" limitations under the License. | ||
|
||
|
||
let s:plugin = maktaba#plugin#Get('codefmt') | ||
|
||
"" | ||
" @private | ||
" Formatter: google-java-format | ||
function! codefmt#googlejava#GetFormatter() abort | ||
let l:formatter = { | ||
\ 'name': 'google-java-format', | ||
\ 'setup_instructions': 'Install google-java formatter ' . | ||
\ "(https://github.com/google/google-java-format). \n" . | ||
\ 'Enable with "Glaive codefmt google_java_executable=' . | ||
\ '"java -jar /path/to/google-java-format-1.2-all-deps.jar" ' . | ||
\ 'in your vimrc' } | ||
|
||
function l:formatter.IsAvailable() abort | ||
let l:exec = s:plugin.Flag('google_java_executable') | ||
if executable(l:exec) | ||
return 1 | ||
elseif !empty(l:exec) && l:exec isnot# 'google-java-format' | ||
" The user has specified a custom formatter command. Hope it works. | ||
" /shrug. | ||
return 1 | ||
else | ||
return 0 | ||
endif | ||
endfunction | ||
|
||
function l:formatter.AppliesToBuffer() abort | ||
return &filetype is# 'java' | ||
endfunction | ||
|
||
"" | ||
" Reformat the current buffer using java-format, only targeting {ranges}. | ||
function l:formatter.FormatRanges(ranges) abort | ||
if empty(a:ranges) | ||
return | ||
endif | ||
" Split the command on spaces, except when there's a proceeding \ | ||
let l:cmd = split(s:plugin.Flag('google_java_executable'), '\\\@<! ') | ||
for [l:startline, l:endline] in a:ranges | ||
call maktaba#ensure#IsNumber(l:startline) | ||
call maktaba#ensure#IsNumber(l:endline) | ||
endfor | ||
let l:ranges_str = join(map(a:ranges, 'v:val[0] . ":" . v:val[1]'), ',') | ||
let l:cmd += ['--lines', l:ranges_str, '-'] | ||
|
||
let l:input = join(getline(1, line('$')), "\n") | ||
let l:result = maktaba#syscall#Create(l:cmd).WithStdin(l:input).Call() | ||
let l:formatted = split(l:result.stdout, "\n") | ||
call maktaba#buffer#Overwrite(1, line('$'), l:formatted) | ||
endfunction | ||
|
||
let s:google_java_format = l:formatter | ||
return l:formatter | ||
endfunction | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
The built-in google-java formatter knows how to format Java BUILD files. If you | ||
aren't familiar with basic codefmt usage yet, see main.vroom first. | ||
|
||
We'll set up codefmt and configure the vroom environment, then jump into some | ||
examples. | ||
|
||
:source $VROOMDIR/setupvroom.vim | ||
|
||
:let g:repeat_calls = [] | ||
:function FakeRepeat(...)<CR> | ||
| call add(g:repeat_calls, a:000)<CR> | ||
:endfunction | ||
:call maktaba#test#Override('repeat#set', 'FakeRepeat') | ||
|
||
:call codefmt#SetWhetherToPerformIsAvailableChecksForTesting(0) | ||
|
||
|
||
The google-java formatter expects a google-java executable to be installed on | ||
your system. | ||
|
||
% class Foo { public String getFoo() { return "bar"; } } | ||
:FormatCode google-java-format | ||
! google-java-format .* | ||
$ class Foo { | ||
$ public String getFoo() { | ||
$ return "bar"; | ||
$ } | ||
$ } | ||
|
||
The name or path of the google-java executable can be configured via the | ||
google_java_executable flag if the default of "google-java" doesn't work. | ||
|
||
:Glaive codefmt google_java_executable='java -jar /path/to/google-java.jar' | ||
:FormatCode google-java-format | ||
! java -jar /path/to/google-java.jar .* | ||
$ class Foo { | ||
$ public String getFoo() { | ||
$ return "bar"; | ||
$ } | ||
$ } | ||
:Glaive codefmt google_java_executable='google-java-format' | ||
|
||
The java filetype will use the google-java formatter by default. | ||
|
||
@clear | ||
% class Foo { public String getFoo() { return "bar"; } } | ||
|
||
:set filetype=java | ||
:FormatCode | ||
! google-java-format .* | ||
$ class Foo { | ||
$ public String getFoo() { | ||
$ return "bar"; | ||
$ } | ||
$ } | ||
|
||
:set filetype= |