Add cljfmt fixer for clojure files (#4860)

dense-analysis · Nov 17, 2024 · defb0ea · defb0ea
1 parent 5cc6b93
commit defb0ea
Show file tree

Hide file tree

Showing 7 changed files with 46 additions and 0 deletions.
diff --git a/autoload/ale/fix/registry.vim b/autoload/ale/fix/registry.vim
@@ -672,6 +672,11 @@ let s:default_registry = {
 \       'suggested_filetypes': ['ruby'],
 \       'description': 'A formatter for Ruby source code',
 \   },
+\   'cljfmt': {
+\       'function': 'ale#fixers#cljfmt#Fix',
+\       'suggested_filetypes': ['clojure'],
+\       'description': 'formatter and linter for clojure files',
+\   },
 \}
 
 " Reset the function registry to the default entries.

diff --git a/autoload/ale/fixers/cljfmt.vim b/autoload/ale/fixers/cljfmt.vim
@@ -0,0 +1,14 @@
+" Author: rudolf ordoyne <[email protected]>
+" Description: Support for cljfmt https://github.com/weavejester/cljfmt
+
+call ale#Set('clojure_cljfmt_executable', 'cljfmt')
+
+function! ale#fixers#cljfmt#Fix(buffer) abort
+    let l:executable = ale#Var(a:buffer, 'clojure_cljfmt_executable')
+
+    return {
+    \   'command': ale#Escape(l:executable) . ' fix %t',
+    \   'read_temporary_file': 1,
+    \}
+endfunction
+
diff --git a/doc/ale-clojure.txt b/doc/ale-clojure.txt
@@ -16,6 +16,18 @@ g:ale_clojure_clj_kondo_options               *g:ale_clojure_clj_kondo_options*
 
   This variable can be changed to modify options passed to clj-kondo.
 
+===============================================================================
+cljfmt                                                     *ale-clojure-cljfmt*
+
+cljfmt is a linter and fixer for Clojure code, with defaults adhering to the
+Clojure Style Guide (see https://guide.clojure.style/ )
+
+https://github.com/weavejester/cljfmt
+
+Linting options are not configurable by ale, but instead are controlled by
+Leiningen, or a cljfmt file in the current or parent directories.
+
+see https://github.com/weavejester/cljfmt#Configuration for more information.
 
 ===============================================================================
 joker                                                       *ale-clojure-joker*

diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
@@ -112,6 +112,7 @@ Notes:
   * `foodcritic`!!
 * Clojure
   * `clj-kondo`
+  * `cljfmt`
   * `joker`
 * CloudFormation
   * `cfn-python-lint`

diff --git a/doc/ale.txt b/doc/ale.txt
@@ -2946,6 +2946,7 @@ documented in additional help files.
     foodcritic............................|ale-chef-foodcritic|
   clojure.................................|ale-clojure-options|
     clj-kondo.............................|ale-clojure-clj-kondo|
+    cljfmt................................|ale-clojure-cljfmt|
     joker.................................|ale-clojure-joker|
   cloudformation..........................|ale-cloudformation-options|
     cfn-python-lint.......................|ale-cloudformation-cfn-python-lint|

diff --git a/supported-tools.md b/supported-tools.md
@@ -121,6 +121,7 @@ formatting.
   * [foodcritic](http://www.foodcritic.io/) :floppy_disk:
 * Clojure
   * [clj-kondo](https://github.com/borkdude/clj-kondo)
+  * [cljfmt](https://github.com/weavejester/cljfmt)
   * [joker](https://github.com/candid82/joker)
 * CloudFormation
   * [cfn-python-lint](https://github.com/awslabs/cfn-python-lint)

diff --git a/test/fixers/test_cljfmt_fixer_callback.vader b/test/fixers/test_cljfmt_fixer_callback.vader
@@ -0,0 +1,12 @@
+Before:
+  call ale#assert#SetUpFixerTest('clojure', 'cljfmt')
+
+After:
+  call ale#assert#TearDownFixerTest()
+
+Execute(The cljfmt callback should return the correct default values):
+  AssertFixer {
+  \    'command': ale#Escape('cljfmt') . ' fix %t',
+  \    'read_temporary_file': 1,
+  \}
+