Merge branch 'google:master' into master

Author: flwyd

README.md

@@ -31,6 +31,7 @@ helpfiles in the `doc/` directory. The helpfiles are also available via
 * Shell (shfmt)
 * [Vue](http://vuejs.org) (prettier)
 * Nix (nixpkgs-fmt)
+* Swift ([swift-format](https://github.com/apple/swift-format))
 
 # Commands
 
@@ -95,6 +96,7 @@ augroup autoformat_settings
   " Alternative: autocmd FileType python AutoFormatBuffer autopep8
   autocmd FileType rust AutoFormatBuffer rustfmt
   autocmd FileType vue AutoFormatBuffer prettier
+  autocmd FileType swift AutoFormatBuffer swift-format
 augroup END
 ```
 

autoload/codefmt/buildifier.vim

@@ -39,7 +39,15 @@ function! codefmt#buildifier#GetFormatter() abort
   " @flag(buildifier)
   " @throws ShellError
   function l:formatter.Format() abort
+    let l:lint_flag = s:plugin.Flag('buildifier_lint_mode')
     let l:cmd = [ s:plugin.Flag('buildifier_executable') ]
+    if !empty(l:lint_flag)
+      let l:cmd += ["--lint=" . l:lint_flag]
+    endif
+    let l:warnings_flag = s:plugin.Flag('buildifier_warnings')
+    if !empty(l:warnings_flag)
+      let l:cmd += ["--warnings=" . l:warnings_flag]
+    endif
     let l:fname = expand('%:p')
     if !empty(l:fname)
       let l:cmd += ['-path', l:fname]

autoload/codefmt/clangformat.vim

@@ -129,6 +129,11 @@ function! codefmt#clangformat#GetFormatter() abort
   ""
   " Reformat buffer with clang-format, only targeting [ranges] if given.
   function l:formatter.FormatRanges(ranges) abort
+    if  line('$') == 1 && getline(1) == ''
+      " If the buffer is completely empty, there's nothing to do
+      return
+    endif
+
     let l:Style_value = s:plugin.Flag('clang_format_style')
     if type(l:Style_value) is# type('')
       let l:style = l:Style_value

autoload/codefmt/isort.vim

@@ -0,0 +1,51 @@
+" Copyright 2020 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: isort
+function! codefmt#isort#GetFormatter() abort
+  let l:formatter = {
+      \ 'name': 'isort',
+      \ 'setup_instructions': 'Install isort ' .
+          \ '(https://pypi.python.org/pypi/isort/).'}
+
+  function l:formatter.IsAvailable() abort
+    return executable(s:plugin.Flag('isort_executable'))
+  endfunction
+
+  function l:formatter.AppliesToBuffer() abort
+    return &filetype is# 'python'
+  endfunction
+
+  ""
+  " Reformat the current buffer with isort or the binary named in
+  " @flag(isort_executable)
+  "
+  " We implement Format(), and not FormatRange{,s}(), because isort doesn't
+  " provide a hook for formatting a range
+  function l:formatter.Format() abort
+    let l:executable = s:plugin.Flag('isort_executable')
+
+    call codefmt#formatterhelpers#Format([
+        \ l:executable,
+        \ '-'])
+  endfunction
+
+  return l:formatter
+endfunction

autoload/codefmt/swiftformat.vim

@@ -0,0 +1,50 @@
+" Copyright 2022 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: swift-format
+function! codefmt#swiftformat#GetFormatter() abort
+  let l:formatter = {
+      \ 'name': 'swift-format',
+      \ 'setup_instructions': 'Install swift-format from ' .
+          \ '(https://github.com/apple/swift-format).'}
+
+  function l:formatter.IsAvailable() abort
+    return executable(s:plugin.Flag('swift_format_executable'))
+  endfunction
+
+  function l:formatter.AppliesToBuffer() abort
+    return &filetype is# 'swift'
+  endfunction
+
+  ""
+  " Reformat the current buffer with swift-format or the binary named in
+  " @flag(swift_format_executable)
+  "
+  " We implement Format(), and not FormatRange{,s}(), because swift-format doesn't
+  " provide a hook for formatting a range
+
+  function l:formatter.Format() abort
+    let l:executable = s:plugin.Flag('swift_format_executable')
+
+    call codefmt#formatterhelpers#Format([
+        \ l:executable])
+  endfunction
+
+  return l:formatter
+endfunction

doc/codefmt.txt

@@ -48,6 +48,7 @@ The current list of defaults by filetype is:
   * python: autopep8, black, yapf
   * rust: rustfmt
   * sh: shfmt
+  * swift: swift-format
 
 ==============================================================================
 CONFIGURATION                                                 *codefmt-config*
@@ -93,6 +94,10 @@ Default: 'yapf' `
 The path to the black executable.
 Default: 'black' `
 
+                                                    *codefmt:isort_executable*
+The path to the isort executable.
+Default: 'isort' `
+
                                                        *codefmt:gn_executable*
 The path to the gn executable.
 Default: 'gn' `
@@ -101,6 +106,34 @@ Default: 'gn' `
 The path to the buildifier executable.
 Default: 'buildifier' `
 
+                                                *codefmt:buildifier_lint_mode*
+The lint_mode for buildifier. passed to buildifier --lint parameter.
+
+Options:
+"" (empty): Use default from buildifier.
+"Off": Do not fix issues.
+"Fix": Fix issues automatically during formatting.
+"Warn": Format only if there are no issues; if there are issues, it will cause
+  an error and do no formatting.
+Default: '' `
+
+                                                 *codefmt:buildifier_warnings*
+The warnings options passed to buildifier to modify the defaults. Whatever is
+specified is added to the commandline after "--warnings=". For example, if you
+add this to your config:
+>
+  Glaive codefmt buildifier_warnings='-module-docstring,+unsorted-dict-items'
+<
+Then buildifier will omit the "module-docstring" warning, but add
+"unsorted-dict-items" (which is ignored by default). This works also in
+fix-mode, in which case dictionary items will be resorted upon buffer save.
+
+Options:
+"" (empty): Use default warnings from buildifier.
+"-some-warning": Remove 'some-warning' from the warning set.
+"+some-warning": Add 'some-warning' to the warning set.
+Default: '' `
+
                                               *codefmt:google_java_executable*
 The path to the google-java executable.  Generally, this should have the form:
 `java -jar /path/to/google-java`
@@ -134,6 +167,10 @@ Command line arguments to feed prettier. Either a list or callable that takes
 no args and returns a list with command line arguments.
 Default: [] `
 
+                                             *codefmt:swift_format_executable*
+The path to the swift-format executable.
+Default: 'swift-format' `
+
                                                  *codefmt:prettier_executable*
 The path to the prettier executable. String, list, or callable that takes no
 args and returns a string or a list. The default uses npx if available, so

instant/flags.vim

@@ -88,6 +88,10 @@ call s:plugin.Flag('yapf_executable', 'yapf')
 " The path to the black executable.
 call s:plugin.Flag('black_executable', 'black')
 
+""
+" The path to the isort executable.
+call s:plugin.Flag('isort_executable', 'isort')
+
 ""
 " The path to the gn executable.
 call s:plugin.Flag('gn_executable', 'gn')
@@ -96,6 +100,33 @@ call s:plugin.Flag('gn_executable', 'gn')
 " The path to the buildifier executable.
 call s:plugin.Flag('buildifier_executable', 'buildifier')
 
+""
+" The lint_mode for buildifier. passed to buildifier --lint parameter.
+"
+" Options:
+" - "" (empty): Use default from buildifier.
+" - "Off": Do not fix issues.
+" - "Fix": Fix issues automatically during formatting.
+" - "Warn": Format only if there are no issues; if there are issues, it will
+"   cause an error and do no formatting.
+call s:plugin.Flag('buildifier_lint_mode', '')
+
+""
+" The warnings options passed to buildifier to modify the defaults. Whatever is
+" specified is added to the commandline after "--warnings=". For example, if you
+" add this to your config: >
+"   Glaive codefmt buildifier_warnings='-module-docstring,+unsorted-dict-items'
+" <
+" Then buildifier will omit the "module-docstring" warning, but add
+" "unsorted-dict-items" (which is ignored by default). This works also in
+" fix-mode, in which case dictionary items will be resorted upon buffer save.
+"
+" Options:
+" - "" (empty): Use default warnings from buildifier.
+" - "-some-warning": Remove 'some-warning' from the warning set.
+" - "+some-warning": Add 'some-warning' to the warning set.
+call s:plugin.Flag('buildifier_warnings', '')
+
 ""
 " The path to the google-java executable.  Generally, this should have the
 " form:
@@ -131,6 +162,10 @@ call s:plugin.Flag('shfmt_executable', 'shfmt')
 " takes no args and returns a list with command line arguments.
 call s:plugin.Flag('prettier_options', [])
 
+""
+" The path to the swift-format executable.
+call s:plugin.Flag('swift_format_executable', 'swift-format')
+
 ""
 " @private
 function s:LookupPrettierExecutable() abort

plugin/register.vim

@@ -42,6 +42,7 @@
 "   * python: autopep8, black, yapf
 "   * rust: rustfmt
 "   * sh: shfmt
+"   * swift: swift-format
 
 
 let [s:plugin, s:enter] = maktaba#plugin#Enter(expand('<sfile>:p'))
@@ -70,7 +71,9 @@ call s:registry.AddExtension(codefmt#ktfmt#GetFormatter())
 call s:registry.AddExtension(codefmt#luaformatterfiveone#GetFormatter())
 call s:registry.AddExtension(codefmt#nixpkgs_fmt#GetFormatter())
 call s:registry.AddExtension(codefmt#autopep8#GetFormatter())
+call s:registry.AddExtension(codefmt#isort#GetFormatter())
 call s:registry.AddExtension(codefmt#black#GetFormatter())
 call s:registry.AddExtension(codefmt#yapf#GetFormatter())
 call s:registry.AddExtension(codefmt#rustfmt#GetFormatter())
 call s:registry.AddExtension(codefmt#shfmt#GetFormatter())
+call s:registry.AddExtension(codefmt#swiftformat#GetFormatter())

vroom/clangformat.vroom

@@ -181,3 +181,10 @@ current buffer.
 
 The -assume-filename arg passed above is also related, used by the clang-format
 tool to detect any custom style rules particular to the current file.
+
+
+Bug #102. When the buffer is empty, clang-format does _not_ return a cursor
+position
+
+  @clear
+  :FormatCode clang-format

vroom/swiftformat.vroom

@@ -0,0 +1,52 @@
+The built-in swift-format formatter knows how to format swift code.
+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 swift-format formatter expects the swift-format executable to be installed on your
+system.
+
+  % f()
+  :FormatCode swift-format
+  ! swift-format .*
+  $ f()
+
+You can format any buffer with swift-format specifying the formatter explicitly.
+
+  @clear
+  % func f(a: String,b:Int)->String{
+  | return "a" }
+  :FormatCode swift-format
+  ! swift-format .*2>.*
+  $ func f(a: String, b: Int) -> String {
+  $   return "a"
+  $ }
+  func f(a: String, b: Int) -> String {
+    return "a"
+  }
+  @end
+
+The swift filetype will use the swift-format formatter by default.
+
+  @clear
+  % f()
+
+  :set filetype=swift
+  :FormatCode
+  ! swift-format .*
+  $ f()
+
+  :set filetype=
+