feat: improve default formatters

Closes #304
mhartington · Sep 24, 2024 · 01d9761 · 01d9761
1 parent 26efb55
commit 01d9761
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -102,7 +102,9 @@ require("formatter").setup {
     ["*"] = {
       -- "formatter.filetypes.any" defines default configurations for any
       -- filetype
-      require("formatter.filetypes.any").remove_trailing_whitespace
+      require("formatter.filetypes.any").remove_trailing_whitespace,
+      -- Remove trailing whitespace without 'sed'
+      -- require("formatter.filetypes.any").substitute_trailing_whitespace,
     }
   }
 }

diff --git a/doc/formatter.txt b/doc/formatter.txt
@@ -117,7 +117,10 @@ Setup:
       ["*"] = {
         -- "formatter.filetypes.any" defines default configurations for any
         -- filetype
-        require("formatter.filetypes.any").remove_trailing_whitespace
+        require("formatter.filetypes.any").remove_trailing_whitespace,
+
+        -- Remove trailing whitespace without 'sed'
+        -- require("formatter.filetypes.any").substitute_trailing_whitespace,
       }
     }
   }

diff --git a/lua/formatter/filetypes/any.lua b/lua/formatter/filetypes/any.lua
@@ -6,7 +6,16 @@ local util = require "formatter.util"
 M.remove_trailing_whitespace = util.withl(defaults.sed, "[ \t]*$")
 
 M.substitute_trailing_whitespace = function()
-    vim.cmd([[silent! :keeppatterns %s/\[ \t]+$//ge]])
+  local line, col = unpack(vim.api.nvim_win_get_cursor(0))
+
+  vim.cmd [[silent! :keeppatterns %s/[ \t]\+$//ge]]
+
+  -- Restore cursor position without going out of bounds
+  local lastline = vim.fn.line "$"
+  if line > lastline then
+    line = lastline
+  end
+  vim.api.nvim_win_set_cursor(0, { line, col })
 end
 
 return M