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

refactor: rename build to compile and watch to toggle in public API

Browse source 
Problem: the code used build/watch while the help file already
documented compile/toggle, creating a confusing mismatch.

Solution: rename M.build() to M.compile() and M.watch() to M.toggle()
in init.lua, update handler keys in commands.lua, and update the test
file to match.
This commit is contained in:
Barrett Ruth 2026-03-04 13:10:34 -05:00
parent 4732696a62
commit 7a7c407d97
Signed by: barrett
GPG key ID: A6C96C9349D2FC81
3 changed files with 12 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

8
lua/preview/commands.lua
View file

@ -1,8 +1,8 @@
local M = {}
local handlers = {
build = function()
require('preview').build()
compile = function()
require('preview').compile()
end,
stop = function()
require('preview').stop()
@ -10,8 +10,8 @@ local handlers = {
clean = function()
require('preview').clean()
end,
watch = function()
require('preview').watch()
toggle = function()
require('preview').toggle()
end,
open = function()
require('preview').open()

8
lua/preview/init.lua
View file

@ -39,10 +39,10 @@
---@class preview
---@field setup fun(opts?: table)
---@field build fun(bufnr?: integer)
---@field compile fun(bufnr?: integer)
---@field stop fun(bufnr?: integer)
---@field clean fun(bufnr?: integer)
---@field watch fun(bufnr?: integer)
---@field toggle fun(bufnr?: integer)
---@field open fun(bufnr?: integer)
---@field status fun(bufnr?: integer): preview.Status
---@field statusline fun(bufnr?: integer): string
@ -144,7 +144,7 @@ function M.build_context(bufnr)
end
---@param bufnr? integer
function M.build(bufnr)
function M.compile(bufnr)
bufnr = bufnr or vim.api.nvim_get_current_buf()
local name = M.resolve_provider(bufnr)
if not name then
@ -176,7 +176,7 @@ function M.clean(bufnr)
end
---@param bufnr? integer
function M.watch(bufnr)
function M.toggle(bufnr)
bufnr = bufnr or vim.api.nvim_get_current_buf()
local name = M.resolve_provider(bufnr)
if not name then

8
spec/commands_spec.lua
View file

@ -14,10 +14,10 @@ describe('commands', function()
end)
describe('dispatch', function()
it('does not error on :Preview with no provider', function()
it('does not error on :Preview compile with no provider', function()
require('preview.commands').setup()
assert.has_no.errors(function()
vim.cmd('Preview build')
vim.cmd('Preview compile')
end)
end)
@ -42,10 +42,10 @@ describe('commands', function()
end)
end)
it('does not error on :Preview watch with no provider', function()
it('does not error on :Preview toggle with no provider', function()
require('preview.commands').setup()
assert.has_no.errors(function()
vim.cmd('Preview watch')
vim.cmd('Preview toggle')
end)
end)
end)