todos.nvim

A simple Neovim filetype plugin for .todo files with checkbox toggling and syntax highlighting.

Features

• Automatic filetype detection for .todo files
• Checkbox toggling with a single keypress
  • Toggle between - [ ] (unchecked) and - [x] (checked)
• Syntax highlighting with visual differentiation:
  • Unchecked items appear in default text color
  • Checked items appear dimmed with strikethrough
  • Indentation (4 spaces) is highlighted as comments

📦 Installation

Install the plugin with your preferred package manager:

Lazy

{
  "rrossmiller/todos.nvim",
  config = function()
    require("todos").setup()
  end
}

🚀 Usage

1. Create or open a file with the .todo extension
2. Write your todo items using markdown checkbox syntax:

   - [ ] Unchecked task
   - [x] Completed task
   

3. Press tt in normal mode to toggle the checkbox on the current line

⚙️ Configuration

The plugin works out of the box with no configuration needed. Just call setup():

require("todos").setup()

Default Keybindings

When a .todo file is opened:

• tt (normal mode) - Toggle checkbox between [ ] and [x]

Default Settings

• Text width is automatically set to 110 characters for .todo files

📝 Example

- [ ] Write README
- [x] Implement checkbox toggling
- [ ] Add more features
    - [ ] Nested item support
    - [x] Syntax highlighting