fix(nvim): improve async safety, cross-platform support, and docs

Author: mbhall88

docs/editor_integration.md

@@ -81,7 +81,7 @@ A modern Lua-based plugin for Neovim 0.10+ that provides asynchronous, non-block
 
 #### Features
 - Fast formatting using `vim.system`.
-- Automatic fallback to `uvx snakefmt` if `snakefmt` is not in your environment.
+- Automatic fallback to `uv run --with snakefmt snakefmt` if `snakefmt` is not in your environment.
 - Configurable line length and auto-format on save.
 
 #### Installation (with [lazy.nvim](https://github.com/folke/lazy.nvim))

lua/snakefmt/init.lua

@@ -12,7 +12,7 @@ function M.setup(opts)
       group = group,
       pattern = { "*.smk", "Snakefile" },
       callback = function()
-        M.format()
+        M.format(true)
       end,
       desc = "Auto-format with snakefmt on save",
     })
@@ -32,14 +32,15 @@ function M.setup(opts)
   end, { desc = "Show snakefmt execution info" })
 end
 
-function M.format()
+function M.format(sync)
   local cmd = paths.get_snakefmt_bin(config.options)
   if not cmd then
     vim.notify("snakefmt: binary not found and uvx fallback failed", vim.log.levels.ERROR)
     return
   end
 
   local bufnr = vim.api.nvim_get_current_buf()
+  local changedtick = vim.api.nvim_buf_get_changedtick(bufnr)
   local content = vim.api.nvim_buf_get_lines(bufnr, 0, -1, false)
   local stdin = table.concat(content, "\n") .. "\n"
 
@@ -51,12 +52,30 @@ function M.format()
   end
   table.insert(full_cmd, "-")
 
+  if sync then
+    local obj = vim.system(full_cmd, { stdin = stdin }):wait()
+    if obj.code == 0 then
+      local formatted = vim.split(obj.stdout, "\n")
+      if formatted[#formatted] == "" then
+        table.remove(formatted)
+      end
+      vim.api.nvim_buf_set_lines(bufnr, 0, -1, false, formatted)
+    else
+      vim.notify("snakefmt error: " .. obj.stderr, vim.log.levels.ERROR)
+    end
+    return
+  end
+
   vim.system(full_cmd, { stdin = stdin }, function(obj)
     vim.schedule(function()
       if not vim.api.nvim_buf_is_valid(bufnr) then
         return
       end
 
+      if vim.api.nvim_buf_get_changedtick(bufnr) ~= changedtick then
+        return
+      end
+
       if obj.code == 0 then
         local formatted = vim.split(obj.stdout, "\n")
         if formatted[#formatted] == "" then

lua/snakefmt/paths.lua

@@ -9,18 +9,31 @@ function M.get_snakefmt_bin(config_opts)
   -- 2. Local Environment ($VIRTUAL_ENV)
   local venv = os.getenv("VIRTUAL_ENV")
   if venv then
-    local path = venv .. "/bin/snakefmt"
-    if vim.fn.executable(path) == 1 then
-      return { path }
+    local candidates = {
+      venv .. "/bin/snakefmt",
+      venv .. "/Scripts/snakefmt.exe",
+      venv .. "/Scripts/snakefmt",
+    }
+    for _, path in ipairs(candidates) do
+      if vim.fn.executable(path) == 1 then
+        return { path }
+      end
     end
   end
 
   -- 3. Project Environment (.venv)
   local project_venv = vim.fn.finddir(".venv", ".;")
   if project_venv ~= "" then
-    local path = vim.fn.fnamemodify(project_venv, ":p") .. "bin/snakefmt"
-    if vim.fn.executable(path) == 1 then
-      return { path }
+    local venv_base = vim.fn.fnamemodify(project_venv, ":p")
+    local candidates = {
+      venv_base .. "bin/snakefmt",
+      venv_base .. "Scripts/snakefmt.exe",
+      venv_base .. "Scripts/snakefmt",
+    }
+    for _, path in ipairs(candidates) do
+      if vim.fn.executable(path) == 1 then
+        return { path }
+      end
     end
   end