Allow using cljfmt for formatting

Author: tonsky

CHANGELOG.md

@@ -12,6 +12,10 @@ Syntax has been significantly reworked.
 - Metadata highlights following form as `meta.metadata`
 - Allow reader-invisible forms like comma, newline, reader comment and meta almost everywhere between meaningful forms
 
+Other changes:
+
+- Allow using `cljfmt` for formatting (requires `cljfmt` binary on `$PATH`)
+
 ### 3.8.0 - Aug 8, 2024
 
 - `clojure_sublimed_reindent` command that reindents entire buffer if selection is empty and only selected lines if not

Clojure Sublimed.sublime-settings

@@ -48,6 +48,9 @@
   // E.g. (set! *warn-on-reflection* true)
   "eval_shared": "",
 
+  // formatter, "sublimed" or "cljfmt". Latter requires `cljfmt` to be on $PATH
+  "formatter": "sublimed",
+
   // reformat file on save, false by default
   "format_on_save": false
 }

README.md

@@ -33,11 +33,15 @@ Want to put your parser to test? Check out [syntax_test_edn.edn](./test_syntax/s
 
 # Formatter/indenter
 
-Clojure Sublimed includes optional support for [Simple Clojure Formatting rules](https://tonsky.me/blog/clojurefmt/). It doesn’t require REPL connection, any Clojure runtime or external tools.
+Clojure Sublimed includes support for both [Simple Clojure Formatting rules](https://tonsky.me/blog/clojurefmt/) and [cljfmt](https://github.com/weavejester/cljfmt/).
+
+Simple Clojure Formatting doesn’t require REPL connection, any Clojure runtime or external tools. It is enabled by default.
+
+`cljfmt` requires `cljfmt` binary to be on `$PATH`. Enable it by setting `"formatter": "cljfmt"` in Clojure Sublimed settings.
 
 To reformat whole file, run `Clojure Sublimed: Reindent`. If you have non-empty selection, it will only reformat selected lines.
 
-To enable reindenting/formatting on save, add `format_on_save: true` to settings. ([See how to edit settings](#editing-settings))
+To enable reindenting/formatting on save, add `"format_on_save": true` to settings. ([See how to edit settings](#editing-settings))
 
 To enable correct indentations as you type code, rebind `Enter` to `Clojure Sublimed: Insert Newline`:
 

cs_cljfmt.py

@@ -0,0 +1,41 @@
+import os, sublime, subprocess
+
+def indent_lines(view, selections, edit):
+    regions = [region for region in selections if not region.empty()]
+    if not regions:
+      regions = [sublime.Region(0, view.size())]
+    replacements = []
+    for region in regions:
+      text = view.substr(region)
+      try:
+        cmd = 'cljfmt.exe' if 'windows' == sublime.platform() else 'cljfmt'
+        cwd = None
+        if file := view.file_name():
+          cwd = os.path.dirname(file)
+        elif folders := view.window().folders():
+          cwd = folders[0]
+
+        proc = subprocess.run([cmd, 'fix', '-'],
+                 input = text,
+                 text = True,
+                 capture_output = True,
+                 check = True,
+                 cwd = cwd)
+      except FileNotFoundError:
+        sublime.error_message(f'`{cmd}` is not on $PATH')
+        raise
+      if 'Failed' not in proc.stderr:
+        replacements.append((region, proc.stdout))
+
+    if replacements:
+      selections = [(view.rowcol(r.a), view.rowcol(r.b)) for r in selections]
+      change_id_sel = view.change_id()
+      for region, string in replacements:
+        transformed_region = view.transform_region_from(region, change_id_sel)
+        view.replace(edit, transformed_region, string)
+
+      selections.clear()
+      for ((rowa, cola), (rowb, colb)) in selections:
+        a = view.text_point(rowa, cola)
+        b = view.text_point(rowb, colb)
+        selections.add(sublime.Region(a, b))

cs_indent.py

@@ -1,5 +1,5 @@
 import sublime, sublime_plugin
-from . import cs_common, cs_parser
+from . import cs_cljfmt, cs_common, cs_parser
 
 def search_path(node, pos):
     """
@@ -119,20 +119,26 @@ def indent_lines(view, selections, edit):
 
 class ClojureSublimedReindentBufferOnSave(sublime_plugin.EventListener):
     def on_pre_save(self, view):
-        if cs_common.setting("format_on_save", False) and view.syntax().name == 'Clojure (Sublimed)':
+        if cs_common.setting("format_on_save", False) and ('Clojure' in view.syntax().name or 'EDN' in view.syntax().name):
             view.run_command('clojure_sublimed_reindent_buffer')
 
 class ClojureSublimedReindentBufferCommand(sublime_plugin.TextCommand):
     def run(self, edit):
         view = self.view
         with cs_common.Measure("Reindent Buffer {} chars", view.size()):
-            indent_lines(view, [sublime.Region(0, view.size())], edit)
+            if 'cljfmt' == cs_common.setting('formatter'):
+                cs_cljfmt.indent_lines(view, [sublime.Region(0, view.size())], edit)
+            else:
+                indent_lines(view, [sublime.Region(0, view.size())], edit)
 
 class ClojureSublimedReindentLinesCommand(sublime_plugin.TextCommand):
     def run(self, edit):
         view = self.view
         with cs_common.Measure("Reindent Lines {}", view.sel()):
-            indent_lines(view, view.sel(), edit)
+            if 'cljfmt' == cs_common.setting('formatter'):
+                cs_cljfmt.indent_lines(view, view.sel(), edit)
+            else:
+                indent_lines(view, view.sel(), edit)
 
 class ClojureSublimedReindentCommand(sublime_plugin.TextCommand):
     def run(self, edit):