barrett/preview.nvim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

refactor(compiler): replace 7 state tables with unified BufState

Browse source 
Problem: `compiler.lua` tracked per-buffer state across 7 separate
module-level tables, causing scattered cleanup, triplicated
error-handling blocks, accumulating `BufUnload` autocmds on every
compile, and a race condition where `active[bufnr]` (cleared
asynchronously on process exit) was used as the toggle on/off gate.

Solution: Consolidate all per-buffer state into a single `state` table
holding a `preview.BufState` record per buffer. Extract `handle_errors`
and `clear_errors` helpers. Move `BufUnload` lifecycle entirely into
`M.toggle` with `unload_autocmd` tracking to prevent accumulation.
Toggle now gates on `s.watching` (synchronous boolean) and reopens a
closed viewer when watching is active rather than stopping.
This commit is contained in:
Barrett Ruth 2026-03-05 23:54:07 -05:00
parent d102c9525b
commit e59b5eb241
Signed by: barrett
GPG key ID: A6C96C9349D2FC81
2 changed files with 266 additions and 281 deletions
Download patch file Download diff file Expand all files Collapse all files

498
lua/preview/compiler.lua
View file

@ -3,45 +3,102 @@ local M = {}
local diagnostic = require('preview.diagnostic') local diagnostic = require('preview.diagnostic')
local log = require('preview.log') local log = require('preview.log')
---@type table<integer, preview.Process> ---@class preview.BufState
local active = {} ---@field watching boolean
---@field process? table
---@field is_reload? boolean
---@field provider? string
---@field output? string
---@field viewer? table
---@field viewer_open? boolean
---@field open_watcher? uv.uv_fs_event_t
---@field debounce? uv.uv_timer_t
---@field bwp_autocmd? integer
---@field unload_autocmd? integer
---@type table<integer, integer> ---@type table<integer, preview.BufState>
local watching = {} local state = {}
---@type table<integer, true>
local opened = {}
---@type table<integer, string>
local last_output = {}
---@type table<integer, table>
local viewer_procs = {}
---@type table<integer, uv.uv_fs_event_t>
local open_watchers = {}
local debounce_timers = {}
local DEBOUNCE_MS = 500 local DEBOUNCE_MS = 500
---@param bufnr integer ---@param bufnr integer
local function stop_open_watcher(bufnr) ---@return preview.BufState
local w = open_watchers[bufnr] local function get_state(bufnr)
if w then if not state[bufnr] then
w:stop() state[bufnr] = { watching = false }
w:close()
open_watchers[bufnr] = nil
end end
return state[bufnr]
end
---@param bufnr integer
local function stop_open_watcher(bufnr)
local s = state[bufnr]
if not (s and s.open_watcher) then
return
end
s.open_watcher:stop()
s.open_watcher:close()
s.open_watcher = nil
end end
---@param bufnr integer ---@param bufnr integer
local function close_viewer(bufnr) local function close_viewer(bufnr)
local obj = viewer_procs[bufnr] local s = state[bufnr]
if obj then if not (s and s.viewer) then
local kill = obj.kill return
kill(obj, 'sigterm') end
viewer_procs[bufnr] = nil s.viewer:kill('sigterm')
s.viewer = nil
end
---@param bufnr integer
---@param name string
---@param provider preview.ProviderConfig
---@param ctx preview.Context
---@param output string
local function handle_errors(bufnr, name, provider, ctx, output)
local errors_mode = provider.errors
if errors_mode == nil then
errors_mode = 'diagnostic'
end
if not (provider.error_parser and errors_mode) then
return
end
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')
local win = vim.fn.win_getid()
vim.cmd.cwindow()
vim.fn.win_gotoid(win)
end
end
end
---@param bufnr integer
---@param provider preview.ProviderConfig
local function clear_errors(bufnr, provider)
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')
vim.cmd.cwindow()
end end
end end
@ -54,7 +111,23 @@ local function do_open(bufnr, output_file, open_config)
elseif type(open_config) == 'table' then elseif type(open_config) == 'table' then
local open_cmd = vim.list_extend({}, open_config) local open_cmd = vim.list_extend({}, open_config)
table.insert(open_cmd, output_file) table.insert(open_cmd, output_file)
viewer_procs[bufnr] = vim.system(open_cmd) log.dbg('opening viewer for buffer %d: %s', bufnr, table.concat(open_cmd, ' '))
local proc
proc = vim.system(
open_cmd,
{},
vim.schedule_wrap(function()
local s = state[bufnr]
if s and s.viewer == proc then
log.dbg('viewer exited for buffer %d, resetting viewer_open', bufnr)
s.viewer = nil
s.viewer_open = nil
else
log.dbg('viewer exited for buffer %d (stale proc, ignoring)', bufnr)
end
end)
)
get_state(bufnr).viewer = proc
end end
end end
@ -90,10 +163,30 @@ local function resolve_reload_cmd(provider, ctx)
return nil return nil
end end
---@param bufnr integer
---@param s preview.BufState
local function stop_watching(bufnr, s)
s.watching = false
M.stop(bufnr)
stop_open_watcher(bufnr)
close_viewer(bufnr)
s.viewer_open = nil
if s.bwp_autocmd then
vim.api.nvim_del_autocmd(s.bwp_autocmd)
s.bwp_autocmd = nil
end
if s.debounce then
s.debounce:stop()
s.debounce:close()
s.debounce = nil
end
end
---@param bufnr integer ---@param bufnr integer
---@param name string ---@param name string
---@param provider preview.ProviderConfig ---@param provider preview.ProviderConfig
---@param ctx preview.Context ---@param ctx preview.Context
---@param opts? {oneshot?: boolean}
function M.compile(bufnr, name, provider, ctx, opts) function M.compile(bufnr, name, provider, ctx, opts)
opts = opts or {} opts = opts or {}
@ -109,7 +202,9 @@ function M.compile(bufnr, name, provider, ctx, opts)
vim.cmd('silent! update') vim.cmd('silent! update')
end end
if active[bufnr] then local s = get_state(bufnr)
if s.process then
log.dbg('killing existing process for buffer %d before recompile', bufnr) log.dbg('killing existing process for buffer %d before recompile', bufnr)
M.stop(bufnr) M.stop(bufnr)
end end
@ -127,7 +222,7 @@ function M.compile(bufnr, name, provider, ctx, opts)
end end
if output_file ~= '' then if output_file ~= '' then
last_output[bufnr] = output_file s.output = output_file
end end
local reload_cmd local reload_cmd
@ -155,74 +250,20 @@ function M.compile(bufnr, name, provider, ctx, opts)
return return
end end
stderr_acc[#stderr_acc + 1] = data stderr_acc[#stderr_acc + 1] = data
local errors_mode = provider.errors handle_errors(bufnr, name, provider, ctx, table.concat(stderr_acc))
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')
local win = vim.fn.win_getid()
vim.cmd.cwindow()
vim.fn.win_gotoid(win)
end
end
end
end), end),
}, },
vim.schedule_wrap(function(result) vim.schedule_wrap(function(result)
if active[bufnr] and active[bufnr].obj == obj then local cs = state[bufnr]
active[bufnr] = nil if cs and cs.process == obj then
cs.process = nil
end end
if not vim.api.nvim_buf_is_valid(bufnr) then if not vim.api.nvim_buf_is_valid(bufnr) then
return return
end end
if result.code ~= 0 then if result.code ~= 0 then
log.dbg('long-running process failed for buffer %d (exit code %d)', bufnr, result.code) log.dbg('long-running process failed for buffer %d (exit code %d)', bufnr, result.code)
local errors_mode = provider.errors handle_errors(bufnr, name, provider, ctx, (result.stdout or '') .. (result.stderr or ''))
if errors_mode == nil then
errors_mode = 'diagnostic'
end
if provider.error_parser and errors_mode then
local output = (result.stdout or '') .. (result.stderr or '')
if errors_mode == 'diagnostic' then
diagnostic.set(bufnr, name, provider.error_parser, output, ctx)
elseif errors_mode == 'quickfix' then
local ok, diagnostics = pcall(provider.error_parser, output, ctx)
if ok and diagnostics and #diagnostics > 0 then
local items = {}
for _, d in ipairs(diagnostics) 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')
local win = vim.fn.win_getid()
vim.cmd.cwindow()
vim.fn.win_gotoid(win)
end
end
end
vim.api.nvim_exec_autocmds('User', { vim.api.nvim_exec_autocmds('User', {
pattern = 'PreviewCompileFailed', pattern = 'PreviewCompileFailed',
data = { data = {
@ -236,7 +277,7 @@ function M.compile(bufnr, name, provider, ctx, opts)
end) end)
) )
if provider.open and not opts.oneshot and not opened[bufnr] and output_file ~= '' then if provider.open and not opts.oneshot and not s.viewer_open and output_file ~= '' then
local pre_stat = vim.uv.fs_stat(output_file) local pre_stat = vim.uv.fs_stat(output_file)
local pre_mtime = pre_stat and pre_stat.mtime.sec or 0 local pre_mtime = pre_stat and pre_stat.mtime.sec or 0
local out_dir = vim.fn.fnamemodify(output_file, ':h') local out_dir = vim.fn.fnamemodify(output_file, ':h')
@ -244,7 +285,7 @@ function M.compile(bufnr, name, provider, ctx, opts)
stop_open_watcher(bufnr) stop_open_watcher(bufnr)
local watcher = vim.uv.new_fs_event() local watcher = vim.uv.new_fs_event()
if watcher then if watcher then
open_watchers[bufnr] = watcher s.open_watcher = watcher
watcher:start( watcher:start(
out_dir, out_dir,
{}, {},
@ -252,8 +293,12 @@ function M.compile(bufnr, name, provider, ctx, opts)
if err or vim.fn.fnamemodify(filename or '', ':t') ~= out_name then if err or vim.fn.fnamemodify(filename or '', ':t') ~= out_name then
return return
end end
if opened[bufnr] then local cs = state[bufnr]
stop_open_watcher(bufnr) if not cs then
return
end
if cs.viewer_open then
log.dbg('watcher fired for buffer %d but viewer already open', bufnr)
return return
end end
if not vim.api.nvim_buf_is_valid(bufnr) then if not vim.api.nvim_buf_is_valid(bufnr) then
@ -262,41 +307,27 @@ function M.compile(bufnr, name, provider, ctx, opts)
end end
local new_stat = vim.uv.fs_stat(output_file) local new_stat = vim.uv.fs_stat(output_file)
if not (new_stat and new_stat.mtime.sec > pre_mtime) then if not (new_stat and new_stat.mtime.sec > pre_mtime) then
log.dbg(
'watcher fired for buffer %d but mtime not newer (%d <= %d)',
bufnr,
new_stat and new_stat.mtime.sec or 0,
pre_mtime
)
return return
end end
stop_open_watcher(bufnr) log.dbg('watcher opening viewer for buffer %d', bufnr)
cs.viewer_open = true
stderr_acc = {} stderr_acc = {}
local errors_mode = provider.errors clear_errors(bufnr, provider)
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')
vim.cmd.cwindow()
end
do_open(bufnr, output_file, provider.open) do_open(bufnr, output_file, provider.open)
opened[bufnr] = true
end) end)
) )
end end
end end
active[bufnr] = { obj = obj, provider = name, output_file = output_file, is_reload = true } s.process = obj
s.provider = name
vim.api.nvim_create_autocmd('BufUnload', { s.is_reload = true
buffer = bufnr,
once = true,
callback = function()
M.stop(bufnr)
stop_open_watcher(bufnr)
if not provider.detach then
close_viewer(bufnr)
end
last_output[bufnr] = nil
end,
})
vim.api.nvim_exec_autocmds('User', { vim.api.nvim_exec_autocmds('User', {
pattern = 'PreviewCompileStarted', pattern = 'PreviewCompileStarted',
@ -318,31 +349,18 @@ function M.compile(bufnr, name, provider, ctx, opts)
local obj local obj
obj = vim.system( obj = vim.system(
cmd, cmd,
{ { cwd = cwd, env = provider.env },
cwd = cwd,
env = provider.env,
},
vim.schedule_wrap(function(result) vim.schedule_wrap(function(result)
if active[bufnr] and active[bufnr].obj == obj then local cs = state[bufnr]
active[bufnr] = nil if cs and cs.process == obj then
cs.process = nil
end end
if not vim.api.nvim_buf_is_valid(bufnr) then if not vim.api.nvim_buf_is_valid(bufnr) then
return return
end end
local errors_mode = provider.errors
if errors_mode == nil then
errors_mode = 'diagnostic'
end
if result.code == 0 then if result.code == 0 then
log.dbg('compilation succeeded for buffer %d', bufnr) log.dbg('compilation succeeded for buffer %d', bufnr)
if errors_mode == 'diagnostic' then clear_errors(bufnr, provider)
diagnostic.clear(bufnr)
elseif errors_mode == 'quickfix' then
vim.fn.setqflist({}, 'r')
vim.cmd.cwindow()
end
vim.api.nvim_exec_autocmds('User', { vim.api.nvim_exec_autocmds('User', {
pattern = 'PreviewCompileSuccess', pattern = 'PreviewCompileSuccess',
data = { bufnr = bufnr, provider = name, output = output_file }, data = { bufnr = bufnr, provider = name, output = output_file },
@ -353,42 +371,21 @@ function M.compile(bufnr, name, provider, ctx, opts)
r.inject(output_file) r.inject(output_file)
r.broadcast() r.broadcast()
end end
cs = state[bufnr]
if if
provider.open provider.open
and not opts.oneshot and not opts.oneshot
and not opened[bufnr] and cs
and not cs.viewer_open
and output_file ~= '' and output_file ~= ''
and vim.uv.fs_stat(output_file) and vim.uv.fs_stat(output_file)
then then
cs.viewer_open = true
do_open(bufnr, output_file, provider.open) do_open(bufnr, output_file, provider.open)
opened[bufnr] = true
end end
else else
log.dbg('compilation failed for buffer %d (exit code %d)', bufnr, result.code) log.dbg('compilation failed for buffer %d (exit code %d)', bufnr, result.code)
if provider.error_parser and errors_mode then handle_errors(bufnr, name, provider, ctx, (result.stdout or '') .. (result.stderr or ''))
local output = (result.stdout or '') .. (result.stderr or '')
if errors_mode == 'diagnostic' then
diagnostic.set(bufnr, name, provider.error_parser, output, ctx)
elseif errors_mode == 'quickfix' then
local ok, diagnostics = pcall(provider.error_parser, output, ctx)
if ok and diagnostics and #diagnostics > 0 then
local items = {}
for _, d in ipairs(diagnostics) 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')
local win = vim.fn.win_getid()
vim.cmd.cwindow()
vim.fn.win_gotoid(win)
end
end
end
vim.api.nvim_exec_autocmds('User', { vim.api.nvim_exec_autocmds('User', {
pattern = 'PreviewCompileFailed', pattern = 'PreviewCompileFailed',
data = { data = {
@ -402,19 +399,9 @@ function M.compile(bufnr, name, provider, ctx, opts)
end) end)
) )
active[bufnr] = { obj = obj, provider = name, output_file = output_file } s.process = obj
s.provider = name
vim.api.nvim_create_autocmd('BufUnload', { s.is_reload = false
buffer = bufnr,
once = true,
callback = function()
M.stop(bufnr)
if not provider.detach then
close_viewer(bufnr)
end
last_output[bufnr] = nil
end,
})
vim.api.nvim_exec_autocmds('User', { vim.api.nvim_exec_autocmds('User', {
pattern = 'PreviewCompileStarted', pattern = 'PreviewCompileStarted',
@ -424,39 +411,34 @@ end
---@param bufnr integer ---@param bufnr integer
function M.stop(bufnr) function M.stop(bufnr)
local proc = active[bufnr] local s = state[bufnr]
if not proc then if not (s and s.process) then
return return
end end
log.dbg('stopping process for buffer %d', bufnr) log.dbg('stopping process for buffer %d', bufnr)
---@type fun(self: table, signal: string|integer) local obj = s.process
local kill = proc.obj.kill obj:kill('sigterm')
kill(proc.obj, 'sigterm')
local timer = vim.uv.new_timer() local timer = vim.uv.new_timer()
if timer then if timer then
timer:start(5000, 0, function() timer:start(5000, 0, function()
timer:close() timer:close()
if active[bufnr] and active[bufnr].obj == proc.obj then local cs = state[bufnr]
kill(proc.obj, 'sigkill') if cs and cs.process == obj then
active[bufnr] = nil obj:kill('sigkill')
cs.process = nil
end end
end) end)
end end
end end
function M.stop_all() function M.stop_all()
for bufnr, _ in pairs(active) do for bufnr, s in pairs(state) do
M.stop(bufnr) stop_watching(bufnr, s)
end if s.unload_autocmd then
for bufnr, _ in pairs(watching) do vim.api.nvim_del_autocmd(s.unload_autocmd)
M.unwatch(bufnr) end
end state[bufnr] = nil
for bufnr, _ in pairs(open_watchers) do
stop_open_watcher(bufnr)
end
for bufnr, _ in pairs(viewer_procs) do
close_viewer(bufnr)
end end
require('preview.reload').stop() require('preview.reload').stop()
end end
@ -467,76 +449,77 @@ end
---@param ctx_builder fun(bufnr: integer): preview.Context ---@param ctx_builder fun(bufnr: integer): preview.Context
function M.toggle(bufnr, name, provider, ctx_builder) function M.toggle(bufnr, name, provider, ctx_builder)
local is_longrunning = type(provider.reload) == 'table' or type(provider.reload) == 'function' local is_longrunning = type(provider.reload) == 'table' or type(provider.reload) == 'function'
local s = get_state(bufnr)
if is_longrunning then if s.watching then
if active[bufnr] then local output = s.output
M.stop(bufnr) if not s.viewer_open and provider.open and output and vim.uv.fs_stat(output) then
vim.notify('[preview.nvim]: watching stopped', vim.log.levels.INFO) log.dbg('toggle reopen viewer for buffer %d', bufnr)
s.viewer_open = true
do_open(bufnr, output, provider.open)
else else
M.compile(bufnr, name, provider, ctx_builder(bufnr)) log.dbg('toggle off for buffer %d', bufnr)
vim.notify('[preview.nvim]: watching with "' .. name .. '"', vim.log.levels.INFO) stop_watching(bufnr, s)
vim.notify('[preview.nvim]: watching stopped', vim.log.levels.INFO)
end end
return return
end end
if watching[bufnr] then log.dbg('toggle on for buffer %d', bufnr)
M.unwatch(bufnr) s.watching = true
vim.notify('[preview.nvim]: watching stopped', vim.log.levels.INFO)
return if s.unload_autocmd then
vim.api.nvim_del_autocmd(s.unload_autocmd)
end end
s.unload_autocmd = vim.api.nvim_create_autocmd('BufUnload', {
local au_id = vim.api.nvim_create_autocmd('BufWritePost', {
buffer = bufnr,
callback = function()
if debounce_timers[bufnr] then
debounce_timers[bufnr]:stop()
else
debounce_timers[bufnr] = vim.uv.new_timer()
end
debounce_timers[bufnr]:start(
DEBOUNCE_MS,
0,
vim.schedule_wrap(function()
local ctx = ctx_builder(bufnr)
M.compile(bufnr, name, provider, ctx)
end)
)
end,
})
watching[bufnr] = au_id
log.dbg('watching buffer %d with provider "%s"', bufnr, name)
vim.notify('[preview.nvim]: watching with "' .. name .. '"', vim.log.levels.INFO)
vim.api.nvim_create_autocmd('BufUnload', {
buffer = bufnr, buffer = bufnr,
once = true, once = true,
callback = function() callback = function()
M.unwatch(bufnr) M.stop(bufnr)
stop_open_watcher(bufnr) stop_open_watcher(bufnr)
if not provider.detach then if not provider.detach then
close_viewer(bufnr) close_viewer(bufnr)
end end
opened[bufnr] = nil state[bufnr] = nil
end, end,
}) })
if not is_longrunning then
s.bwp_autocmd = vim.api.nvim_create_autocmd('BufWritePost', {
buffer = bufnr,
callback = function()
local ds = state[bufnr]
if not ds then
return
end
if ds.debounce then
ds.debounce:stop()
else
ds.debounce = vim.uv.new_timer()
end
ds.debounce:start(
DEBOUNCE_MS,
0,
vim.schedule_wrap(function()
M.compile(bufnr, name, provider, ctx_builder(bufnr))
end)
)
end,
})
log.dbg('watching buffer %d with provider "%s"', bufnr, name)
end
vim.notify('[preview.nvim]: watching with "' .. name .. '"', vim.log.levels.INFO)
M.compile(bufnr, name, provider, ctx_builder(bufnr)) M.compile(bufnr, name, provider, ctx_builder(bufnr))
end end
---@param bufnr integer ---@param bufnr integer
function M.unwatch(bufnr) function M.unwatch(bufnr)
local au_id = watching[bufnr] local s = state[bufnr]
if not au_id then if not s then
return return
end end
vim.api.nvim_del_autocmd(au_id) stop_watching(bufnr, s)
if debounce_timers[bufnr] then
debounce_timers[bufnr]:stop()
debounce_timers[bufnr]:close()
debounce_timers[bufnr] = nil
end
watching[bufnr] = nil
log.dbg('unwatched buffer %d', bufnr) log.dbg('unwatched buffer %d', bufnr)
end end
@ -585,7 +568,8 @@ end
---@param bufnr integer ---@param bufnr integer
---@return boolean ---@return boolean
function M.open(bufnr, open_config) function M.open(bufnr, open_config)
local output = last_output[bufnr] local s = state[bufnr]
local output = s and s.output
if not output then if not output then
log.dbg('no last output file for buffer %d', bufnr) log.dbg('no last output file for buffer %d', bufnr)
return false return false
@ -601,26 +585,20 @@ end
---@param bufnr integer ---@param bufnr integer
---@return preview.Status ---@return preview.Status
function M.status(bufnr) function M.status(bufnr)
local proc = active[bufnr] local s = state[bufnr]
if proc then if not s then
return { return { compiling = false, watching = false }
compiling = not proc.is_reload,
watching = watching[bufnr] ~= nil or proc.is_reload == true,
provider = proc.provider,
output_file = proc.output_file,
}
end end
return { compiling = false, watching = watching[bufnr] ~= nil } return {
compiling = s.process ~= nil and not s.is_reload,
watching = s.watching,
provider = s.provider,
output_file = s.output,
}
end end
M._test = { M._test = {
active = active, state = state,
watching = watching,
opened = opened,
last_output = last_output,
debounce_timers = debounce_timers,
viewer_procs = viewer_procs,
open_watchers = open_watchers,
} }
return M return M

49
spec/compiler_spec.lua
View file

@ -8,8 +8,13 @@ describe('compiler', function()
compiler = require('preview.compiler') compiler = require('preview.compiler')
end) end)
local function process_done(bufnr)
local s = compiler._test.state[bufnr]
return not s or s.process == nil
end
describe('compile', function() describe('compile', function()
it('spawns a process and tracks it in active table', function() it('spawns a process and tracks it in state', function()
local bufnr = helpers.create_buffer({ 'hello' }, 'text') local bufnr = helpers.create_buffer({ 'hello' }, 'text')
vim.api.nvim_buf_set_name(bufnr, '/tmp/preview_test.txt') vim.api.nvim_buf_set_name(bufnr, '/tmp/preview_test.txt')
vim.bo[bufnr].modified = false vim.bo[bufnr].modified = false
@ -23,15 +28,16 @@ describe('compiler', function()
} }
compiler.compile(bufnr, 'echo', provider, ctx) compiler.compile(bufnr, 'echo', provider, ctx)
local active = compiler._test.active local s = compiler._test.state[bufnr]
assert.is_not_nil(active[bufnr]) assert.is_not_nil(s)
assert.are.equal('echo', active[bufnr].provider) assert.is_not_nil(s.process)
assert.are.equal('echo', s.provider)
vim.wait(2000, function() vim.wait(2000, function()
return active[bufnr] == nil return process_done(bufnr)
end, 50) end, 50)
assert.is_nil(active[bufnr]) assert.is_nil(compiler._test.state[bufnr].process)
helpers.delete_buffer(bufnr) helpers.delete_buffer(bufnr)
end) end)
@ -61,7 +67,7 @@ describe('compiler', function()
assert.is_true(fired) assert.is_true(fired)
vim.wait(2000, function() vim.wait(2000, function()
return compiler._test.active[bufnr] == nil return process_done(bufnr)
end, 50) end, 50)
helpers.delete_buffer(bufnr) helpers.delete_buffer(bufnr)
@ -124,7 +130,7 @@ describe('compiler', function()
vim.notify = orig vim.notify = orig
assert.is_true(notified) assert.is_true(notified)
assert.is_nil(compiler._test.active[bufnr]) assert.is_true(process_done(bufnr))
helpers.delete_buffer(bufnr) helpers.delete_buffer(bufnr)
end) end)
@ -186,7 +192,7 @@ describe('compiler', function()
compiler.compile(bufnr, 'falsecmd', provider, ctx) compiler.compile(bufnr, 'falsecmd', provider, ctx)
vim.wait(2000, function() vim.wait(2000, function()
return compiler._test.active[bufnr] == nil return process_done(bufnr)
end, 50) end, 50)
assert.is_false(parser_called) assert.is_false(parser_called)
@ -218,7 +224,7 @@ describe('compiler', function()
compiler.compile(bufnr, 'qfcmd', provider, ctx) compiler.compile(bufnr, 'qfcmd', provider, ctx)
vim.wait(2000, function() vim.wait(2000, function()
return compiler._test.active[bufnr] == nil return process_done(bufnr)
end, 50) end, 50)
local qflist = vim.fn.getqflist() local qflist = vim.fn.getqflist()
@ -255,7 +261,7 @@ describe('compiler', function()
compiler.compile(bufnr, 'truecmd', provider, ctx) compiler.compile(bufnr, 'truecmd', provider, ctx)
vim.wait(2000, function() vim.wait(2000, function()
return compiler._test.active[bufnr] == nil return process_done(bufnr)
end, 50) end, 50)
assert.are.equal(0, #vim.fn.getqflist()) assert.are.equal(0, #vim.fn.getqflist())
@ -298,7 +304,7 @@ describe('compiler', function()
compiler.stop(bufnr) compiler.stop(bufnr)
vim.wait(2000, function() vim.wait(2000, function()
return compiler._test.active[bufnr] == nil return process_done(bufnr)
end, 50) end, 50)
helpers.delete_buffer(bufnr) helpers.delete_buffer(bufnr)
@ -329,11 +335,12 @@ describe('compiler', function()
} }
compiler.compile(bufnr, 'testprov', provider, ctx) compiler.compile(bufnr, 'testprov', provider, ctx)
assert.is_not_nil(compiler._test.last_output[bufnr]) local s = compiler._test.state[bufnr]
assert.are.equal('/tmp/preview_test_open.pdf', compiler._test.last_output[bufnr]) assert.is_not_nil(s)
assert.are.equal('/tmp/preview_test_open.pdf', s.output)
vim.wait(2000, function() vim.wait(2000, function()
return compiler._test.active[bufnr] == nil return process_done(bufnr)
end, 50) end, 50)
helpers.delete_buffer(bufnr) helpers.delete_buffer(bufnr)
@ -341,7 +348,7 @@ describe('compiler', function()
end) end)
describe('toggle', function() describe('toggle', function()
it('registers autocmd and tracks in watching table', function() it('starts watching and sets watching flag', function()
local bufnr = helpers.create_buffer({ 'hello' }, 'text') local bufnr = helpers.create_buffer({ 'hello' }, 'text')
vim.api.nvim_buf_set_name(bufnr, '/tmp/preview_test_watch.txt') vim.api.nvim_buf_set_name(bufnr, '/tmp/preview_test_watch.txt')
@ -351,7 +358,7 @@ describe('compiler', function()
end end
compiler.toggle(bufnr, 'echo', provider, ctx_builder) compiler.toggle(bufnr, 'echo', provider, ctx_builder)
assert.is_not_nil(compiler._test.watching[bufnr]) assert.is_true(compiler.status(bufnr).watching)
helpers.delete_buffer(bufnr) helpers.delete_buffer(bufnr)
end) end)
@ -366,10 +373,10 @@ describe('compiler', function()
end end
compiler.toggle(bufnr, 'echo', provider, ctx_builder) compiler.toggle(bufnr, 'echo', provider, ctx_builder)
assert.is_not_nil(compiler._test.watching[bufnr]) assert.is_true(compiler.status(bufnr).watching)
compiler.toggle(bufnr, 'echo', provider, ctx_builder) compiler.toggle(bufnr, 'echo', provider, ctx_builder)
assert.is_nil(compiler._test.watching[bufnr]) assert.is_false(compiler.status(bufnr).watching)
helpers.delete_buffer(bufnr) helpers.delete_buffer(bufnr)
end) end)
@ -389,10 +396,10 @@ describe('compiler', function()
end end
compiler.toggle(bufnr, 'echo', provider, ctx_builder) compiler.toggle(bufnr, 'echo', provider, ctx_builder)
assert.is_not_nil(compiler._test.watching[bufnr]) assert.is_true(compiler.status(bufnr).watching)
compiler.stop_all() compiler.stop_all()
assert.is_nil(compiler._test.watching[bufnr]) assert.is_false(compiler.status(bufnr).watching)
helpers.delete_buffer(bufnr) helpers.delete_buffer(bufnr)
end) end)