✔️ Todo.nvim

Todo.nvim helps you keep focused on what matters by quickly typing and ticking TODOs inside an accessible floating window.

The aim of this plugin is to emulate a convenient, accessible and visually sober todo-list without distractions.

It's like paper but digital.

✨ Features and Usage

• ✔️ Tick: Press <CR> when in normal mode to tick or untick the current line's todo

• ⌨️ Quick Typing: <CR> and o will both prepend the - [ ] prefix automatically

• 🚪 Open: Press <leader>t to open or close the todo-list

• 🔥 Exit: Press q, <leader>t, <C-o> or <C-c> to close the window.

• ➡️ Indent: Press <Tab> and <S-Tab> to easily indent in normal and visual mode

• 🔳 Minimalist Design: Clean looking floating window with padding and disabled diagnostics

• 💾 Save/Select: Save your todo-lists to a configurable folder. Selects an existing todo-list with TodoSelectCurrentBuffer.

• 🚫 Not lingering: The floating window will automatically close upon losing focus.

• 🔼 Resize: Use TodoSetHeight or TodoSetWidth to dynamically resize the floating window (overrides config.width or config.height until restart)

🎥 Demo

⚡️ Requirements

• Neovim >= 0.10.0
• for better markdown rendering (optional):
  • render-markdown

📦 Installation

Install the plugin using your favorite package manager:

lazy.nvim:

{
    "Enethen/todo.nvim",
    dependencies = {
        -- "MeanderingProgrammer/render-markdown.nvim" -- For better markdown rendering
    },
    opts =
    ---@module "todo.config"
    ---@type TodoNvim.Config
    {
        -- your configuration comes here
        -- or leave it empty to use the default settings
        -- refer to the configuration section below
    },
    cmd = {
        "TodoToggle",
        "TodoSelectCurrentBuffer",
    },
    keys = {
        { "<leader>t", function() require("todo").toggle() end, desc = "Toggles Todo-List" },
    },
}

⚙️ Configuration

---@class TodoNvim.Config
---@field disable_diagnostics boolean
---@field document_name string | fun(): string
---@field save_path string
---@field buffer_listed boolean
---@field development_logs boolean
---@field width number
---@field height number
---@field vertical_padding number
---@field horizontal_padding number
---@field border string
---@field style string
---@field default_text fun(): string[]
local defaults = {
  disable_diagnostics = true, -- disables diagnostics of markdown LSP/Linters
  document_name = M._default_name, -- can be either a string or a function
  save_path = "todo-lists/", -- Path to the saving folder, relative to the CWD
  buffer_listed = true, -- should the Todo-list buffer be listed? see :h buflisted
  width = 0.35, -- Width of the Window (percentage of the screen)
  height = 0.8, -- Height of the Window (percentage of the screen)
  vertical_padding = 3, -- Amount of padded lines (Vertical)
  horizontal_padding = 6, -- Amount of padded characters (Horizontal)
  border = "rounded", -- Border style, see h: nvim_open_win
  style = "minimal", -- Style of the window, see h: nvim_open_win
  default_text = function() -- The default text upon opening the window for the first time
    local lines = {
      "# TODO List",
      "",
      "- [ ] Item1",
    }
    return lines
  end,
}

⚡ Feature Ideas

• Famous pickers (telescope, fzf or Snacks) integration for opening saved todo-lists

🙏 Acknoledgement

This is my first Neovim plugin, which I made thanks to Teej's tutorials and following Folke's awesome README formatting and plugin's structure 😊

The idea originally came from this video from Coding With Sphere.

Since I did not find such a plugin, I decided to give it a shot!