Merge commit '76265755a1add77121c8f9dabb3e9bb70fe9a972' as '.vim/bundle/ale'

[etc/vim.git] / .vim / bundle / ale / doc / ale-clojure.txt

diff --git a/.vim/bundle/ale/doc/ale-clojure.txt b/.vim/bundle/ale/doc/ale-clojure.txt
new file mode 100644 (file)
index 0000000..a562d83
--- /dev/null
+++ b/.vim/bundle/ale/doc/ale-clojure.txt
@@ -0,0 +1,55 @@
+===============================================================================
+ALE Clojure Integration                                   *ale-clojure-options*
+
+
+===============================================================================
+clj-kondo                                               *ale-clojure-clj-kondo*
+
+A minimal and opinionated linter for code that sparks joy.
+
+https://github.com/borkdude/clj-kondo
+
+
+-------------------------------------------------------------------------------
+Options
+                                        *ale-options.clojure_clj_kondo_options*
+                                              *g:ale_clojure_clj_kondo_options*
+                                              *b:ale_clojure_clj_kondo_options*
+clojure_clj_kondo_options
+g:ale_clojure_clj_kondo_options
+  Type: |String|
+  Default: `'--cache'`
+
+  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*
+
+Joker is a small Clojure interpreter and linter written in Go.
+
+https://github.com/candid82/joker
+
+Linting options are not configurable by ale, but instead are controlled by a
+`.joker` file in same directory as the file (or current working directory if
+linting stdin), a parent directory relative to the file, or the users home
+directory.
+
+see https://github.com/candid82/joker#linter-mode for more information.
+
+
+===============================================================================
+  vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: