From 7a7c407d97d9115c05cc162e050c3e2b48dddc77 Mon Sep 17 00:00:00 2001
From: Barrett Ruth <br.barrettruth@gmail.com>
Date: Wed, 4 Mar 2026 13:10:34 -0500
Subject: [PATCH] refactor: rename build to compile and watch to toggle in
 public API

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.
---
 lua/preview/commands.lua | 8 ++++----
 lua/preview/init.lua     | 8 ++++----
 spec/commands_spec.lua   | 8 ++++----
 3 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/lua/preview/commands.lua b/lua/preview/commands.lua
index c91f4de..eec51c9 100644
--- a/lua/preview/commands.lua
+++ b/lua/preview/commands.lua
@@ -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()
diff --git a/lua/preview/init.lua b/lua/preview/init.lua
index acceea5..421ba65 100644
--- a/lua/preview/init.lua
+++ b/lua/preview/init.lua
@@ -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
diff --git a/spec/commands_spec.lua b/spec/commands_spec.lua
index 32da224..9b63f87 100644
--- a/spec/commands_spec.lua
+++ b/spec/commands_spec.lua
@@ -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)