From c8e3a88434bfa7800d9d48cea39fdbc86c3da94d Mon Sep 17 00:00:00 2001
From: Barrett Ruth <62671086+barrettruth@users.noreply.github.com>
Date: Wed, 4 Mar 2026 16:33:58 -0500
Subject: [PATCH 01/12] fix: stream stderr for long-running providers, clear
errors on success (#40)
Problem: Long-running providers (e.g. `typst watch`) never exit on
compile error, so the exit callback never fired and diagnostics/quickfix
were never populated. The `typst watch` `reload` command also lacked
`--diagnostic-format short`, producing unparseable verbose output.
Solution: Add a `stderr` streaming callback to the long-running
`vim.system` call that accumulates chunks and re-parses on each new
chunk, populating diagnostics or quickfix in real time. When the
fs_event fires (successful compile), clear `stderr_acc` and the
reported errors. Add `--diagnostic-format short` to the typst `reload`
command to match the one-shot `args` format.
---
lua/preview/compiler.lua | 43 ++++++++++++++++++++++++++++++++++++++++
lua/preview/presets.lua | 2 +-
2 files changed, 44 insertions(+), 1 deletion(-)
diff --git a/lua/preview/compiler.lua b/lua/preview/compiler.lua
index c5a81c2..3f897ad 100644
--- a/lua/preview/compiler.lua
+++ b/lua/preview/compiler.lua
@@ -143,12 +143,45 @@ function M.compile(bufnr, name, provider, ctx, opts)
table.concat(reload_cmd, ' ')
)
+ local stderr_acc = {}
local obj
obj = vim.system(
reload_cmd,
{
cwd = cwd,
env = provider.env,
+ stderr = vim.schedule_wrap(function(err, data)
+ if not data or not vim.api.nvim_buf_is_valid(bufnr) then
+ return
+ end
+ stderr_acc[#stderr_acc + 1] = data
+ local errors_mode = provider.errors
+ if errors_mode == nil then
+ errors_mode = 'diagnostic'
+ end
+ if provider.error_parser and errors_mode then
+ local output = table.concat(stderr_acc)
+ if errors_mode == 'diagnostic' then
+ diagnostic.set(bufnr, name, provider.error_parser, output, ctx)
+ elseif errors_mode == 'quickfix' then
+ local ok, diags = pcall(provider.error_parser, output, ctx)
+ if ok and diags and #diags > 0 then
+ local items = {}
+ for _, d in ipairs(diags) do
+ table.insert(items, {
+ bufnr = bufnr,
+ lnum = d.lnum + 1,
+ col = d.col + 1,
+ text = d.message,
+ type = d.severity == vim.diagnostic.severity.WARN and 'W' or 'E',
+ })
+ end
+ vim.fn.setqflist(items, 'r')
+ vim.cmd('copen')
+ end
+ end
+ end
+ end),
},
vim.schedule_wrap(function(result)
if active[bufnr] and active[bufnr].obj == obj then
@@ -228,6 +261,16 @@ function M.compile(bufnr, name, provider, ctx, opts)
return
end
stop_open_watcher(bufnr)
+ stderr_acc = {}
+ local errors_mode = provider.errors
+ if errors_mode == nil then
+ errors_mode = 'diagnostic'
+ end
+ if errors_mode == 'diagnostic' then
+ diagnostic.clear(bufnr)
+ elseif errors_mode == 'quickfix' then
+ vim.fn.setqflist({}, 'r')
+ end
do_open(bufnr, output_file, provider.open)
opened[bufnr] = true
end)
diff --git a/lua/preview/presets.lua b/lua/preview/presets.lua
index f189e98..3591a21 100644
--- a/lua/preview/presets.lua
+++ b/lua/preview/presets.lua
@@ -133,7 +133,7 @@ M.typst = {
end,
open = true,
reload = function(ctx)
- return { 'typst', 'watch', ctx.file }
+ return { 'typst', 'watch', '--diagnostic-format', 'short', ctx.file }
end,
}
From 3e6ba580e4e3c8dc544c0994659757ed12066c3f Mon Sep 17 00:00:00 2001
From: Barrett Ruth <62671086+barrettruth@users.noreply.github.com>
Date: Wed, 4 Mar 2026 17:23:06 -0500
Subject: [PATCH 02/12] fix: quickfix support for long-running providers (#41)
* fix(compiler): open quickfix in background, retain focus on source buffer
* fix(compiler): use cwindow and win_gotoid for quickfix focus management
* fix: unused var warning and update typst reload test for short format
* fix: remove testing files
---
README.html | 963 ---------------------------------------
README.md | 4 +-
lua/preview/compiler.lua | 16 +-
spec/presets_spec.lua | 4 +-
4 files changed, 17 insertions(+), 970 deletions(-)
delete mode 100644 README.html
diff --git a/README.html b/README.html
deleted file mode 100644
index b6600fc..0000000
--- a/README.html
+++ /dev/null
@@ -1,963 +0,0 @@
-
-
-
-
-
-
- README
-
-
-
-
-preview.nvim
-Universal document previewer for Neovim
-An extensible framework for compiling and previewing any
-documents (LaTeX, Typst, Markdown, etc.)—diagnostics included.
-Features
-
-- Async compilation via
vim.system()
-- Built-in presets for Typst, LaTeX (latexmk, pdflatex, tectonic),
-Markdown, GitHub-flavored Markdown, AsciiDoc, and Quarto
-- Compiler errors as native
vim.diagnostic
-- User events for extensibility (
PreviewCompileStarted,
-PreviewCompileSuccess,
-PreviewCompileFailed)
-
-Requirements
-
-Installation
-Install with your package manager of choice or via luarocks:
-luarocks install preview.nvim
-Documentation
-:help preview.nvim
-FAQ
-Q: How do I define a custom provider?
-require('preview').setup({
- rst = {
- cmd = { 'rst2html' },
- args = function(ctx)
- return { ctx.file, ctx.output }
- end,
- output = function(ctx)
- return ctx.file:gsub('%.rst$', '.html')
- end,
- },
-})
Q: How do I override a preset?
-require('preview').setup({
- typst = { env = { TYPST_FONT_PATHS = '/usr/share/fonts' } },
-})
Q: How do I automatically open the output file?
-Set open = true on your provider (all built-in presets
-have this enabled) to open the output with vim.ui.open()
-after the first successful compilation in toggle/watch mode. For a
-specific application, pass a command table:
-require('preview').setup({
- typst = { open = { 'sioyek', '--new-instance' } },
-})