Add cljstyle formatter

Author: agentydragon

README.md

@@ -12,7 +12,8 @@ helpfiles in the `doc/` directory. The helpfiles are also available via
 
 * [Bazel](https://www.github.com/bazelbuild/bazel) BUILD files (buildifier)
 * C, C++ (clang-format)
-* [Clojure](https://clojure.org/) ([zprint](https://github.com/kkinnear/zprint))
+* [Clojure](https://clojure.org/) ([zprint](https://github.com/kkinnear/zprint),
+  [cljstyle](https://github.com/greglook/cljstyle))
 * CSS, Sass, SCSS, Less (js-beautify)
 * Dart (dartfmt)
 * Fish ([fish_indent](https://fishshell.com/docs/current/commands.html#fish_indent))

autoload/codefmt/cljstyle.vim

@@ -0,0 +1,49 @@
+" Copyright 2019 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: cljstyle
+function! codefmt#cljstyle#GetFormatter() abort
+  let l:formatter = {
+        \ 'name': 'cljstyle',
+        \ 'setup_instructions':
+        \ 'Install cljstyle (https://github.com/greglook/cljstyle) ' .
+        \ 'and configure the cljstyle_executable flag'}
+
+  function l:formatter.IsAvailable() abort
+    return executable(s:plugin.Flag('cljstyle_executable'))
+  endfunction
+
+  function l:formatter.AppliesToBuffer() abort
+    return &filetype is# 'clojure'
+  endfunction
+
+  ""
+  " Reformat the current buffer with cljstyle.
+  "
+  " We implement Format(), and not FormatRange{,s}(), because cljstyle doesn't
+  " provide a hook for formatting a range
+  function l:formatter.Format() abort
+    let l:cmd = [s:plugin.Flag('cljstyle_executable'), 'pipe']
+
+    call codefmt#formatterhelpers#Format(l:cmd)
+  endfunction
+
+  return l:formatter
+endfunction

instant/flags.vim

@@ -176,3 +176,7 @@ call s:plugin.Flag('nixpkgs_fmt_executable', 'nixpkgs-fmt')
 ""
 " The path to the luaformatterfiveone executable.
 call s:plugin.Flag('luaformatterfiveone_executable', 'luaformatterfiveone')
+
+""
+" The path to the cljstyle executable.
+call s:plugin.Flag('cljstyle_executable', 'cljstyle')

plugin/register.vim

@@ -27,6 +27,7 @@ call s:registry.AddExtension(codefmt#prettier#GetFormatter())
 call s:registry.AddExtension(codefmt#rustfmt#GetFormatter())
 call s:registry.AddExtension(codefmt#jsbeautify#GetFormatter())
 call s:registry.AddExtension(codefmt#clangformat#GetFormatter())
+call s:registry.AddExtension(codefmt#cljstyle#GetFormatter())
 call s:registry.AddExtension(codefmt#gofmt#GetFormatter())
 call s:registry.AddExtension(codefmt#dartfmt#GetFormatter())
 call s:registry.AddExtension(codefmt#black#GetFormatter())

vroom/cljstyle.vroom

@@ -0,0 +1,59 @@
+The cljstyle formatter knows how to format Clojure.
+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 cljstyle formatter expects the cljstyle executable to be installed on your
+system.
+
+  :FormatCode cljstyle
+  ! cljstyle .*
+  $ no-op
+
+The name or path of the cljstyle executable can be configured via the
+cljstyle_executable flag if the default of "cljstyle" doesn't work.
+
+  :Glaive codefmt cljstyle_executable='/usr/local/bin/cljstyle'
+  :FormatCode cljstyle
+  ! /usr/local/bin/cljstyle .*
+  $ no-op
+  :Glaive codefmt cljstyle_executable='cljstyle'
+
+You can format an entire buffer with :FormatCode.
+
+  @clear
+  % (defn x [] (cond nil 1 :else 2))<CR>
+  |(defn y [] (cond nil 3 :else 4))
+
+  :FormatCode cljstyle
+  ! cljstyle .*
+  $ (defn x
+  $   []
+  $   (cond nil 1
+  $         :else 2))
+  $ (defn y
+  $   []
+  $   (cond nil 3
+  $         :else 4))
+  (defn x
+    []
+    (cond nil 1
+          :else 2))
+  (defn y
+    []
+    (cond nil 3
+          :else 4))
+  @end
+
+Formatting a specific line range is not supported.