refactor: implement setup function and move keymaps

lua/todoer/init.lua

@@ -118,15 +118,24 @@ local function remove_todo()
 	end
 end
 
--- Set up the keymaps (for now, this happens immediately on require)
+-- Setup function
-vim.keymap.set("n", "<leader>t", function() end, { desc = "+TODOs" })
+-- This function will be called by the user to configure and activate the plugin
-vim.keymap.set("i", "<CR>", press_enter, { desc = "On enter", noremap = true, expr = true })
+-- For now, it just sets up the default keymaps
-vim.keymap.set("i", "<TAB>", press_tab, { desc = "On tab", noremap = true, expr = true })
+function M.setup(opts)
-vim.keymap.set("i", "S-Tab", press_shift_tab, { desc = "On shift tab", noremap = true, expr = true })
+	-- opts is a placeholder for future configuration options
-vim.keymap.set("n", "<leader>tt", toggle_todo, { desc = "Toggle TODO" })
+	opts = opts or {}
-vim.keymap.set("n", "<leader>ta", add_todo, { desc = "Add TODO" })
+
-vim.keymap.set("n", "<leader>td", remove_todo, { desc = "Remove TODO" })
+	-- Set up the keymaps
+	vim.keymap.set("n", "<leader>t", function() end, { desc = "+TODOs" })
+	vim.keymap.set("i", "<CR>", press_enter, { desc = "On enter", noremap = true, expr = true })
+	vim.keymap.set("i", "<TAB>", press_tab, { desc = "On tab", noremap = true, expr = true })
+	vim.keymap.set("i", "S-Tab", press_shift_tab, { desc = "On shift tab", noremap = true, expr = true })
+	vim.keymap.set("n", "<leader>tt", toggle_todo, { desc = "Toggle TODO" })
+	vim.keymap.set("n", "<leader>ta", add_todo, { desc = "Add TODO" })
+	vim.keymap.set("n", "<leader>td", remove_todo, { desc = "Remove TODO" })
+
+	print("Todoer setup complete!") -- Added a print statement for confirmation
+end
 
 -- Return the module table
 return M
-

plugin/todoer.lua

@@ -1,5 +1,3 @@
--- Load the main module.
+-- Load the main module and call its setup function.
--- This will execute the code inside lua/todoer/init.lua immediately,
+-- This will execute the setup logic inside lua/todoer/init.lua immediately.
--- including setting the keymaps.
+require('todoer').setup()
-require('todoer')
-