Skip to content

feat: support nested checkboxes #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
dkarter wants to merge 2 commits into
base: dorian/rms-71-implement-bullet-list-renumbering
Choose a base branch
from
Draft

feat: support nested checkboxes #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a72969b
feat: support nested checkboxes
dkarter Jun 3, 2026
721a8cf
fix: stop checkbox propagation at separators
dkarter Jun 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
249 changes: 245 additions & 4 deletions lua/bullets/actions.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,8 @@ local function prefix_width(bullet)
return #bullet.indent + #bullet.marker + #bullet.spacing
end

local current_prefix

local function next_prefix(bullet)
local marker = next_marker(bullet)
if not marker then
Expand All @@ -249,7 +251,7 @@ local function next_prefix(bullet)
return bullet.indent .. pad_right(prefix, #bullet.marker + #bullet.closure + #bullet.spacing)
end

local function current_prefix(bullet)
function current_prefix(bullet)
if bullet.type == "std" or bullet.type == "static" then
return bullet.indent .. bullet.marker .. bullet.spacing
end
Expand All @@ -258,6 +260,103 @@ local function current_prefix(bullet)
return bullet.indent .. pad_right(prefix, #bullet.marker + #bullet.closure + #bullet.spacing)
end

local function checkbox_markers()
local markers = {}
local configured = config.options.checkbox_markers or ""

for index = 0, vim.fn.strchars(configured) - 1 do
table.insert(markers, vim.fn.strcharpart(configured, index, 1))
end

return markers
end

local function checkbox_marker_index(marker, markers)
for index, configured in ipairs(markers) do
if marker == configured then
return index
end
end

if marker == " " then
return 1
end

local checked = markers[#markers]
if checked and (marker:lower() == checked:lower() or marker:lower() == "x") then
return #markers
end

return nil
end

local function parse_checkbox_text(text)
local marker, spacing, rest = text:match("^%[([^%]]+)%](%s*)(.*)$")
if not marker then
return nil
end

local markers = checkbox_markers()
local index = checkbox_marker_index(marker, markers)
if not index then
return nil
end

return {
marker = marker,
spacing = spacing,
rest = rest,
index = index,
markers = markers,
}
end

local function checkbox_unchecked_marker()
return checkbox_markers()[1]
end

local function checkbox_checked_marker(markers)
return markers[#markers]
end

local function checkbox_state(checkbox)
if checkbox.index == 1 then
return "unchecked"
end
if checkbox.index == #checkbox.markers then
return "checked"
end

return "partial"
end

local function checkbox_text(marker, checkbox)
return "[" .. marker .. "]" .. checkbox.spacing .. checkbox.rest
end

local function set_checkbox_marker(lnum, bullet, checkbox, marker)
vim.api.nvim_buf_set_lines(0, lnum - 1, lnum, false, { current_prefix(bullet) .. checkbox_text(marker, checkbox) })
end

local function checkbox_continuation_prefix(bullet, prefix)
local checkbox = parse_checkbox_text(bullet.text)
local unchecked = checkbox and checkbox_unchecked_marker()
if not unchecked then
return prefix
end

return prefix .. "[" .. unchecked .. "]" .. checkbox.spacing
end

local function is_empty_bullet_text(text)
if text == "" then
return true
end

local checkbox = parse_checkbox_text(text)
return checkbox and checkbox.rest == ""
end

local function indent_unit()
if not vim.o.expandtab then
return "\t"
Expand Down Expand Up @@ -445,8 +544,19 @@ local function change_line_level(lnum, direction)
return false
end

local checkbox = parse_checkbox_text(bullet.text)
if checkbox then
next_bullet.marker = bullet.marker
next_bullet.type = bullet.type
next_bullet.closure = bullet.closure
next_bullet.spacing = bullet.spacing
end

local prefix = current_prefix(next_bullet)
vim.api.nvim_buf_set_lines(0, lnum - 1, lnum, false, { prefix .. bullet.text })
if checkbox then
prefix = prefix .. "[" .. checkbox.marker .. "]" .. checkbox.spacing
end
vim.api.nvim_win_set_cursor(0, { lnum, #prefix })
return true
end
Expand Down Expand Up @@ -508,6 +618,9 @@ local function delete_empty_bullet(lnum, bullet)
:gsub("\t$", "")
:gsub(string.rep(" ", vim.o.shiftwidth > 0 and vim.o.shiftwidth or vim.o.tabstop) .. "$", "")
local prefix = next_prefix(promoted)
if prefix then
prefix = checkbox_continuation_prefix(bullet, prefix)
end
vim.api.nvim_set_current_line(prefix or "")
vim.api.nvim_win_set_cursor(0, { lnum, #(prefix or "") })
return true
Expand Down Expand Up @@ -739,7 +852,7 @@ function M.insert_new_bullet()
return ""
end

if bullet.text == "" and delete_empty_bullet(lnum, bullet) then
if is_empty_bullet_text(bullet.text) and delete_empty_bullet(lnum, bullet) then
return ""
end

Expand All @@ -757,6 +870,8 @@ function M.insert_new_bullet()
return ""
end

prefix = checkbox_continuation_prefix(bullet, prefix)

local lines, cursor_index = spaced_lines(prefix)
insert_lines(lnum, lines, cursor_index)

Expand All @@ -783,9 +898,135 @@ function M.renumber_selection(first, last)
end
end

function M.toggle_checkbox() end
local function checkbox_item(lnum)
local bullet, line = bullet_at(lnum)
if not bullet then
return nil, line
end

local checkbox = parse_checkbox_text(bullet.text)
if not checkbox then
return { lnum = lnum, bullet = bullet, checkbox = nil }, line
end

return { lnum = lnum, bullet = bullet, checkbox = checkbox, children = {} }, line
end

local function checkbox_tree(first, last)
local items = {}
local stack = {}

for lnum = first, last do
local item = checkbox_item(lnum)
if item and item.checkbox then
local indent = #item.bullet.indent
while #stack > 0 and #stack[#stack].bullet.indent >= indent do
table.remove(stack)
end
if #stack > 0 then
table.insert(stack[#stack].children, item)
end
table.insert(stack, item)
table.insert(items, item)
end
end

return items
end

local function partial_marker(markers, checked, total)
if checked == 0 then
return markers[1]
end
if checked == total then
return checkbox_checked_marker(markers)
end

local index = math.floor((checked / total) * (#markers - 2)) + 2
index = math.max(2, math.min(#markers - 1, index))
return markers[index]
end

local function recompute_items(items)
for index = #items, 1, -1 do
local item = items[index]
if #item.children > 0 then
local checked = 0
for _, child in ipairs(item.children) do
if checkbox_state(child.checkbox) == "checked" then
checked = checked + 1
end
end

local marker = partial_marker(item.checkbox.markers, checked, #item.children)
item.checkbox.marker = marker
item.checkbox.index = checkbox_marker_index(marker, item.checkbox.markers)
set_checkbox_marker(item.lnum, item.bullet, item.checkbox, marker)
elseif checkbox_state(item.checkbox) == "partial" then
local marker = item.checkbox.markers[1]
item.checkbox.marker = marker
item.checkbox.index = 1
set_checkbox_marker(item.lnum, item.bullet, item.checkbox, marker)
end
end
end

local function checkbox_range(lnum)
local first = first_bullet_line(lnum)
local last = last_bullet_line(lnum)
return first > 0 and first or lnum, last > 0 and last or lnum
end

local function set_descendant_checkboxes(lnum, bullet, marker)
local line_count = vim.api.nvim_buf_line_count(0)
for row = lnum + 1, line_count do
local descendant_bullet, line = bullet_at(row)
if line:match("^%s*$") then
break
end

if descendant_bullet then
if #descendant_bullet.indent <= #bullet.indent then
break
end

local item = checkbox_item(row)
if item.checkbox then
item.checkbox.marker = marker
item.checkbox.index = checkbox_marker_index(marker, item.checkbox.markers)
set_checkbox_marker(row, item.bullet, item.checkbox, marker)
end
elseif not wrapped_owner(row, line) then
break
end
end
end

function M.toggle_checkbox()
local lnum = vim.api.nvim_win_get_cursor(0)[1]
local item = checkbox_item(lnum)
if not item or not item.checkbox then
return
end

local markers = item.checkbox.markers
local marker = checkbox_state(item.checkbox) == "checked" and markers[1] or checkbox_checked_marker(markers)
item.checkbox.marker = marker
item.checkbox.index = checkbox_marker_index(marker, markers)
set_checkbox_marker(lnum, item.bullet, item.checkbox, marker)

function M.recompute_checkboxes() end
if config.options.nested_checkboxes then
set_descendant_checkboxes(lnum, item.bullet, marker)
local first, last = checkbox_range(lnum)
recompute_items(checkbox_tree(first, last))
end
end

function M.recompute_checkboxes()
local lnum = vim.api.nvim_win_get_cursor(0)[1]
local first, last = checkbox_range(lnum)
recompute_items(checkbox_tree(first, last))
end

function M.demote()
return change_current_line_level("demote")
Expand Down
30 changes: 24 additions & 6 deletions test/checkboxes_spec.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
local helpers = require("test.helpers")
local it = pending

describe("checkboxes", function()
describe("inserting checkboxes", function()
Expand Down Expand Up @@ -106,6 +105,25 @@ describe("checkboxes", function()
}, helpers.get_lines())
end)

it("does not toggle checkboxes after a blank separator", function()
helpers.new_buffer({
"# Hello there",
"- [ ] first bullet",
" - [ ] second bullet",
"",
" - [ ] separate bullet",
})
helpers.feedkeys("ggj")
vim.cmd("ToggleCheckbox")
assert.are.same({
"# Hello there",
"- [X] first bullet",
" - [X] second bullet",
"",
" - [ ] separate bullet",
}, helpers.get_lines())
end)

it("toggle a bullet and calculate completion", function()
helpers.new_buffer({
"# Hello there",
Expand Down Expand Up @@ -179,7 +197,7 @@ describe("checkboxes", function()
end)

it("adds and toggles bullets using UTF characters", function()
vim.g.bullets_checkbox_markers = "✗○◐●✓"
require("bullets").setup({ checkbox_markers = "✗○◐●✓" })
-- Ensure <C-t> produces tabs (not spaces) regardless of user config
vim.opt.expandtab = false
helpers.new_buffer({
Expand Down Expand Up @@ -215,7 +233,7 @@ describe("checkboxes", function()
end)

it("recomputes checkboxes recursively on RecomputeCheckboxes", function()
vim.g.bullets_checkbox_markers = " .¼½¾X"
require("bullets").setup({ checkbox_markers = " .¼½¾X" })
helpers.new_buffer({
"# Hello there",
"- [ ] EXPECTED: ¼",
Expand Down Expand Up @@ -268,7 +286,7 @@ describe("checkboxes", function()
end)

it("recomputes checkboxes correctly on reindents", function()
vim.g.bullets_checkbox_markers = " /X"
require("bullets").setup({ checkbox_markers = " /X" })
helpers.new_buffer({
"# Hello there",
"- [X] parent bullet",
Expand All @@ -285,7 +303,7 @@ describe("checkboxes", function()
}, helpers.get_lines())

-- Phase 2: press CR on the new empty bullet, which should dedent/remove it
vim.g.bullets_delete_last_bullet_if_empty = 2
require("bullets").setup({ checkbox_markers = " /X", delete_last_bullet_if_empty = 2 })
helpers.feedkeys("A<CR>")
vim.cmd("RecomputeCheckboxes")
assert.are.same({
Expand All @@ -297,7 +315,7 @@ describe("checkboxes", function()
end)

it("handles skip-level checkbox trees", function()
vim.g.bullets_checkbox_markers = " /X"
require("bullets").setup({ checkbox_markers = " /X" })
helpers.new_buffer({
"# Hello there",
"- [X] parent bullet (EXPECTED: /)",
Expand Down