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

feat: rename watch → toggle, auto-compile on start, built-in opener

Browse source 
Problem: :Preview watch only registered a BufWritePost autocmd without
compiling immediately, required boilerplate to open output files after
first compilation, and was misleadingly named.

Solution: Rename watch → toggle throughout. M.toggle now compiles
immediately on activation. Add an open field to ProviderConfig: true
calls vim.ui.open(), a string[] runs the command with the output path
appended, tracked per-buffer so the file opens only once. All presets
default to { 'xdg-open' }. Health check validates opener binaries.
Guard the async compile callback against invalid buffer ids.
This commit is contained in:
Barrett Ruth 2026-03-02 23:37:44 -05:00
parent c62c930454
commit 673573044f
Signed by: barrett
GPG key ID: A6C96C9349D2FC81
12 changed files with 346 additions and 176 deletions
Download patch file Download diff file Expand all files Collapse all files

44
spec/init_spec.lua
View file

@ -9,13 +9,7 @@ describe('preview', function()
end)
describe('config', function()
it('accepts nil config', function()
assert.has_no.errors(function()
preview.get_config()
end)
end)
it('applies default values', function()
it('returns defaults before setup is called', function()
local config = preview.get_config()
assert.is_false(config.debug)
assert.are.same({}, config.providers)
@ -28,26 +22,44 @@ describe('preview', function()
assert.are.same({}, config.providers)
end)
it('accepts full provider config', function()
it('accepts full provider config via hash entry', function()
helpers.reset_config({
providers = {
typst = {
cmd = { 'typst', 'compile' },
args = { '%s' },
},
typst = {
cmd = { 'typst', 'compile' },
args = { '%s' },
},
})
local config = require('preview').get_config()
assert.is_not_nil(config.providers.typst)
end)
it('resolves array preset names to provider configs', function()
helpers.reset_config({ 'typst', 'markdown' })
local config = require('preview').get_config()
local presets = require('preview.presets')
assert.are.same(presets.typst, config.providers.typst)
assert.are.same(presets.markdown, config.providers.markdown)
end)
it('resolves latex preset under tex filetype', function()
helpers.reset_config({ 'latex' })
local config = require('preview').get_config()
local presets = require('preview.presets')
assert.are.same(presets.latex, config.providers.tex)
end)
it('resolves github preset under markdown filetype', function()
helpers.reset_config({ 'github' })
local config = require('preview').get_config()
local presets = require('preview.presets')
assert.are.same(presets.github, config.providers.markdown)
end)
end)
describe('resolve_provider', function()
before_each(function()
helpers.reset_config({
providers = {
typst = { cmd = { 'typst', 'compile' } },
},
typst = { cmd = { 'typst', 'compile' } },
})
preview = require('preview')
end)