format: reorganise and clean up formatting

Author: practicalli-johnny

config.edn

@@ -1,16 +1,118 @@
-{;; User configuration for Clojure LSP
+;; --------------------------------------------------
+;; Clojure LSP user level (global) configuration
+;; https://clojure-lsp.io/settings/
+;;
+;; Complete config.edn example with default settings
+;; https://github.com/clojure-lsp/clojure-lsp/blob/master/docs/all-available-settings.edn
+;; --------------------------------------------------
+
+
+{;; --------------------------------------------------
+ ;; Project analysis
+
+ ;; auto-resolved for deps.edn, project.clj or bb.edn projects
+ :source-paths   #{"src" "test"}
+
+ ;; Include :extra-paths and :extra-deps from project & user level aliases in LSP classpath
+ :source-aliases #{:dev :test :env/dev :env/test :lib/reloaded}
+
+ ;; Define a custom project classpath command, e.g. Clojure CLI
+ ;; :project-specs [{:project-path "deps.edn"
+ ;;                  :classpath-cmd ["clojure" "-M:env/dev:env/test" "-Spath"]}]
+ :project-specs  []
+
+ ;; Additional LSP configurations to load from classpath
+ ;; https://clojure-lsp.io/settings/#classpath-config-paths
+ :classpath-config-paths []
+
+ ;; Ignore Clojure files within the specified directories
+ ;; - i.e ignore build artefacts placed in target or resources directories
+ :ignore-classpath-directories     false
+
+ ;; Watch for classpath changes
+ :notify-references-on-file-change true
+ :compute-external-file-changes    true
+
+ ;; Approach for linking dependencies
+ :dependency-scheme :zip
+
+ ;; generate and analyze stubs for specific namespaces on the project classpath
+ ;; typically for closed source dependencies, e.g. datomic.api
+ ;; https://clojure-lsp.io/settings/#stub-generation
+ :stubs {:generation {:namespaces   #{}
+                      :output-dir   ".lsp/.cache/stubs"
+                      :java-command "java"}
+         :extra-dirs []}
+
+ ;; Java Sources from Ubuntu package openjdk-17-source
+ :java
+ {:jdk-source-uri       "file:///usr/lib/jvm/openjdk-17/lib/src.zip" ;;
+  :home-path            nil ;; jdk-source-uri takes precedence
+  :download-jdk-source? false}
+
+ ;; End of Project analysis
+ ;; --------------------------------------------------
+
+
+ ;; --------------------------------------------------
+ ;; Linter configuration
+
+ :linters
 
- ;; Add develop folder to default source paths
- :source-paths ["src" "test" "develop"]
+ ;; clj-kondo Linter rules
+ ;; https://github.com/clj-kondo/clj-kondo/blob/master/doc/config.md#enable-optional-linters
+ {:clj-kondo {:level             :on
+              :report-duplicates true
+              :ns-exclude-regex  ""}}
 
- :source-aliases #{:env/dev :env/test}
+ ;; asynchronously lint project files after startup, for features like List project errors
+ :lint-project-files-after-startup? true
 
- ;; Use meta data when defining private functions
+ ;; copy clj-kondo hooks configs exported by libs on classpath during startup
+ :copy-kondo-configs? true
+
+ ;; End of Linter configuration
+ ;; --------------------------------------------------
+
+
+ ;; --------------------------------------------------
+ ;; Refactor code
+
+ ;; namespaces
+ :clean {:automatically-after-ns-refactor true
+         :ns-inner-blocks-indentation     :next-line
+         :ns-import-classes-indentation   :next-line
+         :sort {:ns      false
+                :require false
+                :import  false
+                :import-classes {:classes-per-line 3} ;; -1 for all in single line
+                :refer {:max-line-length 80}}}
+
+ ;; Automatically add ns form to new Clojure/Script files
+ :auto-add-ns-to-new-files? true
+
+ ;; use ^private metadata rather than defn-
  :use-metadata-for-privacy? true
 
- ;; Snippets with $current-form only work when used in front of a form
- ;; otherwise the snippet will not appear in the auto-complete drop-down
- ;; Custom Snippets
+ ;; Keep parens around single argument functions in thread macro
+ :keep-parens-when-threading? false
+
+ ;; End of Refactor code
+ ;; --------------------------------------------------
+
+ ;; --------------------------------------------------
+ ;; Clojure formatting configuration - cljfmt
+
+ ;; location of cljfmt configuration for formatting
+ ;; Path relative to project root or an absolute path
+ :cljfmt-config-path "cljfmt.edn"
+
+ ;; Specify cljfmt configuration within Clojure LSP configuration file
+ :cljfmt {}
+
+ ;; End of Clojure formatting configuration - cljfmt
+ ;; --------------------------------------------------
+
  ;; --------------------------------------------------
  ;; LSP snippets
  ;; https://clojure-lsp.io/features/#snippets
@@ -49,7 +151,7 @@
    "#_{:clj-kondo/ignore [:redefined-var]}
    (comment
      $0
-   #_()) ;; End of rich comment"}
+   #_()) ; End of rich comment"}
 
   {:name "rich-comment-hotload"
    :detail "Rich comment library hotload"
@@ -60,7 +162,7 @@
       (require '[clojure.tools.deps.alpha.repl :refer [add-libs]])
       (add-libs '{${1:domain/library-name} {:mvn/version \"${2:1.0.0}\"}$3})
       $0
-    #_()) ;; End of rich comment block"}
+    #_()) ; End of rich comment block"}
 
   ;; Core functions
   {:name "def"
@@ -186,3 +288,48 @@
 
  ;; End of LSP snippets
  ;; --------------------------------------------------
+
+ ;; --------------------------------------------------
+ ;; Visual LSP components
+
+ :code-lens {:segregate-test-references true}
+
+ ;; LSP semantic tokens server support for syntax highlighting
+ :semantic-tokens? true
+
+ ;; Documentation artefacts
+ :document-formatting?       true
+ :document-range-formatting? true
+
+ :hover {:hide-file-location? false
+         :arity-on-same-line? false
+         :clojuredocs         true}
+
+ ;; End of Visual LSP components
+ ;; --------------------------------------------------
+
+ ;; --------------------------------------------------
+ ;; LSP general configuration options
+
+ ;; Exit clojure-lsp if any errors found, e.g. classpath scan failure
+ :api {:exit-on-errors? true}
+
+ ;; Synchronise whole buffer `:full` or only related changes `:incremental`
+ :text-document-sync-kind :full
+
+ ;; End of LSP general configuration options
+ ;; --------------------------------------------------
+
+ ;; --------------------------------------------------
+ ;; File locations
+
+ ;; project analysis cache to speed clojure-lsp startup
+ ;; relative path to project root or absolute path
+ :cache-path ".lsp/.cache"
+
+ ;; Absolute path
+ :log-path "/tmp/clojure-lsp.*.out"
+
+ ;; End of file locations
+ ;; --------------------------------------------------
+ }