Toggle specific TODO item

[malko42]

While there is already a CheckboxToggle function provided by obsidian sometimes you know exactly what you want instead of cycling over a list of todo items.

What I came up with are those functions which turn either the line where the cursor is or the selected lines into TODO items.

local M = {}

M._add_checkbox = function(character, line_num)
	local line = vim.api.nvim_buf_get_lines(0, line_num - 1, line_num, false)[1]

	local checkbox_pattern = "^%s*- %[.] "
	local checkbox = character or " "

	if not string.match(line, checkbox_pattern) then
		local unordered_list_pattern = "^(%s*)[-*+] (.*)"
		if string.match(line, unordered_list_pattern) then
			line = string.gsub(line, unordered_list_pattern, "%1- [ ] %2")
		else
			line = string.gsub(line, "^(%s*)", "%1- [ ] ")
		end
	end
	local capturing_checkbox_pattern = "^(%s*- %[).(%] )"
	line = string.gsub(line, capturing_checkbox_pattern, "%1" .. checkbox .. "%2")

	-- 0-indexed
	vim.api.nvim_buf_set_lines(0, line_num - 1, line_num, true, { line })
end

M._remove_checkbox = function(line_num)
	local line = vim.api.nvim_buf_get_lines(0, line_num - 1, line_num, false)[1]
	local checkbox_pattern = "^%s*- %[.]. "
	local capturing_checkbox_pattern = "^(%s*-) %[.%] (.*)"
	line = string.gsub(line, capturing_checkbox_pattern, "%1 %2")
	line = string.gsub(line, checkbox_pattern, "")
	-- 0-indexed
	vim.api.nvim_buf_set_lines(0, line_num - 1, line_num, true, { line })
end

M.toggle_checkbox = function(character)
	-- Check if we are in visual line mode
	local mode = vim.api.nvim_get_mode().mode

	local toggle_or_remove = function(character, line_num)
		if (character == nil) then
			-- Remove checkbox
			M._remove_checkbox(line_num)
		else
			-- Add checkbox
			M._add_checkbox(character, line_num)
		end
	end

	if mode == 'V' or mode == 'v' then
		-- Get the range of selected lines
		vim.cmd([[execute "normal! \<ESC>"]])
		local vstart = vim.fn.getcharpos("'<")
		local vend = vim.fn.getcharpos("'>")

		local line_start = vstart[2]
		local line_end = vend[2]

		-- Iterate over each line in the range and apply the transformation
		for line_num = line_start, line_end do
			toggle_or_remove(character, line_num)
		end
	else
		-- Normal mode
		-- Allow line_num to be optional, defaulting to the current line if not provided (normal mode)
		local line_num = unpack(vim.api.nvim_win_get_cursor(0))
		toggle_or_remove(character, line_num)
	end
end

Here's how I, for example, use them:

vim.keymap.set({"n", "v"}, "<leader>nd", function() M.toggle_checkbox("x") end, { desc="Todo done", noremap = true })
vim.keymap.set({"n", "v"}, "<leader>nc", function() M.toggle_checkbox("o") end, { desc="Todo canceled", noremap = true })
vim.keymap.set({"n", "v"}, "<leader>nu", function() M.toggle_checkbox(" ") end, { desc="Todo undone", noremap = true })
vim.keymap.set({"n", "v"}, "<leader>ni", function() M.toggle_checkbox("~") end, { desc="Todo in progress", noremap = true })
vim.keymap.set({"n", "v"}, "<leader>nr", function() M.toggle_checkbox() end, { desc="Remove todo", noremap = true })

I can then select multiple lines and easily turn them into undone todos or remove their checkboxes

Hope that helps!