Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/niuiic/todo.nvim
Simple but powerful todo manager based on text.
https://github.com/niuiic/todo.nvim
neovim plugin todo
Last synced: about 1 month ago
JSON representation
Simple but powerful todo manager based on text.
- Host: GitHub
- URL: https://github.com/niuiic/todo.nvim
- Owner: niuiic
- License: mit
- Created: 2024-07-20T15:30:56.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-07-26T08:07:46.000Z (about 1 month ago)
- Last Synced: 2024-07-26T10:54:38.771Z (about 1 month ago)
- Topics: neovim, plugin, todo
- Language: Lua
- Homepage:
- Size: 24.4 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - niuiic/todo.nvim - Simple but powerful todo manager based on text. (Utility / Cursorline)
README
# todo.nvim
Simple but powerful todo manager based on text.
[More neovim plugins](https://github.com/niuiic/awesome-neovim-plugins)
## Dependencies
- [niuiic/core.nvim](https://github.com/niuiic/core.nvim)
- [BurntSushi/ripgrep](https://github.com/BurntSushi/ripgrep)
## Usage
- features
- get todo under cursor
- `require("todo").get_cur_todo`
- `@return todo.Todo | nil`
- search all todos
- `require("todo").search_all`
- `@param map_items (fun(items: todo.TelescopeSearchItem[]): todo.TelescopeSearchItem[]) | nil`
- do filter, sort, etc with `map_items`
- search upstream todos
- `require("todo").search_upstream`
- `@param map_items (fun(items: todo.TelescopeSearchItem[]): todo.TelescopeSearchItem[]) | nil`
- search downstream todos
- `require("todo").search_downstream`
- `@param map_items (fun(items: todo.TelescopeSearchItem[]): todo.TelescopeSearchItem[]) | nil`
- custom decorate
- custom parser
- default format: `[status] (id:dependencies){tags}: content`
- `dependencies` and `tags` are separated with `,`.
- `tags` is optional, which may be used to indicate importance, urgency, type, etc.
- `status` map
- " " = "TODO"
- x = "DONE"
- v = "VERIFY"
- w = "WORKING"
- b = "BLOCKED"
## Config
- class Todo
```lua
---@class todo.Todo
---@field path string
---@field lnum number
---@field status string
---@field id string
---@field dependencies string[]
---@field tags string[]
---@field content string
```
- class TelescopeSearchItem
```lua
---@class todo.TelescopeSearchItem
---@field label string
---@field todo todo.Todo
```
- default config
```lua
local config = {
---@type fun(): string
root_dir = function()
local core = require("core")
return core.file.root_path()
end,
---@type string
rg_pattern = [[\[.+\] \(.+\)\{?.*\}?: .*]],
---@type fun(text: string): todo.Todo | nil
parse = function(text)
local status, id, dependencies, tags, content =
string.match(text, "^.*%[([vbwx%s])%] %(([^:]+):?([^%)]*)%){?([^{}]*)}?: (.*)$")
if status ~= nil then
local status_map = {
[" "] = "TODO",
x = "DONE",
v = "VERIFY",
w = "WORKING",
b = "BLOCKED",
}
return {
status = status_map[status],
id = id,
dependencies = dependencies and vim.split(dependencies, ",") or {},
tags = tags and vim.split(tags, ",") or {},
content = content,
}
end
end,
---@type fun(todo: todo.Todo): [string, string][]
badges = function(todo)
local core = require("core")
local tags = core.lua.list.reduce(todo.tags, function(prev, tag)
return prev == "" and tag or prev .. "," .. tag
end, "")
local dependencies = core.lua.list.reduce(todo.dependencies, function(prev, dep)
return prev == "" and dep or prev .. "," .. dep
end, "")
local roundStart = { "", "TodoRound" }
local roundEnd = { "", "TodoRound" }
local space = { " ", "TodoSpace" }
local badges = {
{ todo.id, "TodoId" },
{ todo.status, "TodoStatus" },
{ tags, "TodoTag" },
{ dependencies, "TodoDependency" },
}
local result = {}
core.lua.list.each(badges, function(badge)
if badge[1] ~= "" then
table.insert(result, roundStart)
table.insert(result, badge)
table.insert(result, roundEnd)
table.insert(result, space)
end
end)
return result
end,
}
```
- default hl
```lua
local function set_hl()
local bg = vim.api.nvim_get_hl(0, { name = "CursorLine" }).bg
vim.api.nvim_set_hl(0, "TodoId", {
fg = "#E0AF68",
bg = bg,
italic = true,
})
vim.api.nvim_set_hl(0, "TodoStatus", {
fg = "#0DB9D7",
bg = bg,
italic = true,
})
vim.api.nvim_set_hl(0, "TodoTag", {
fg = "#00FFCC",
bg = bg,
italic = true,
})
vim.api.nvim_set_hl(0, "TodoDependency", {
fg = "#FF06C1",
bg = bg,
italic = true,
})
vim.api.nvim_set_hl(0, "TodoRound", {
fg = bg,
})
end
```