feat: rename
This commit is contained in:
parent
c69a3957c8
commit
78a275d096
21 changed files with 191 additions and 191 deletions
46
README.md
46
README.md
|
|
@ -1,4 +1,4 @@
|
|||
# todo.nvim
|
||||
# pending.nvim
|
||||
|
||||
Edit tasks like text. `:w` saves them.
|
||||
|
||||
|
|
@ -27,13 +27,13 @@ concealed, and metadata is parsed from inline syntax on save.
|
|||
## Install
|
||||
|
||||
```
|
||||
luarocks install todo.nvim
|
||||
luarocks install pending.nvim
|
||||
```
|
||||
|
||||
**lazy.nvim:**
|
||||
|
||||
```lua
|
||||
{ 'barrettruth/todo.nvim' }
|
||||
{ 'barrettruth/pending.nvim' }
|
||||
```
|
||||
|
||||
Requires Neovim 0.10+. No external dependencies for local use. Google Calendar
|
||||
|
|
@ -41,7 +41,7 @@ sync requires `curl` and `openssl`.
|
|||
|
||||
## Usage
|
||||
|
||||
`:Todo` opens the task buffer. From there, it's just vim:
|
||||
`:Pending` opens the task buffer. From there, it's just vim:
|
||||
|
||||
| Key | Action |
|
||||
| --------- | ------------------------------- |
|
||||
|
|
@ -68,24 +68,24 @@ header.
|
|||
### Quick add
|
||||
|
||||
```vim
|
||||
:Todo add Buy groceries due:2026-03-15
|
||||
:Todo add School: Submit homework
|
||||
:Pending add Buy groceries due:2026-03-15
|
||||
:Pending add School: Submit homework
|
||||
```
|
||||
|
||||
### Archive
|
||||
|
||||
```vim
|
||||
:Todo archive " purge done tasks older than 30 days
|
||||
:Todo archive 7 " purge done tasks older than 7 days
|
||||
:Pending archive " purge done tasks older than 30 days
|
||||
:Pending archive 7 " purge done tasks older than 7 days
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
No `setup()` call required. Set `vim.g.todo` before the plugin loads:
|
||||
No `setup()` call required. Set `vim.g.pending` before the plugin loads:
|
||||
|
||||
```lua
|
||||
vim.g.todo = {
|
||||
data_path = vim.fn.stdpath('data') .. '/todo/tasks.json',
|
||||
vim.g.pending = {
|
||||
data_path = vim.fn.stdpath('data') .. '/pending/tasks.json',
|
||||
default_view = 'category', -- 'category' or 'priority'
|
||||
default_category = 'Inbox',
|
||||
date_format = '%b %d', -- strftime format for virtual text
|
||||
|
|
@ -101,7 +101,7 @@ One-way push of tasks with due dates to a dedicated Google Calendar as all-day
|
|||
events.
|
||||
|
||||
```lua
|
||||
vim.g.todo = {
|
||||
vim.g.pending = {
|
||||
gcal = {
|
||||
calendar = 'Tasks',
|
||||
credentials_path = '/path/to/client_secret.json',
|
||||
|
|
@ -110,11 +110,11 @@ vim.g.todo = {
|
|||
```
|
||||
|
||||
```vim
|
||||
:Todo sync
|
||||
:Pending sync
|
||||
```
|
||||
|
||||
On first run, a browser window opens for OAuth consent. The refresh token is
|
||||
stored at `stdpath('data')/todo/gcal_tokens.json`. Completed or deleted tasks
|
||||
stored at `stdpath('data')/pending/gcal_tokens.json`. Completed or deleted tasks
|
||||
have their calendar events removed. Due date changes update events in place.
|
||||
|
||||
## Mappings
|
||||
|
|
@ -122,25 +122,25 @@ have their calendar events removed. Due date changes update events in place.
|
|||
The plugin defines `<Plug>` mappings for custom keybinds:
|
||||
|
||||
```lua
|
||||
vim.keymap.set('n', '<leader>t', '<Plug>(todo-open)')
|
||||
vim.keymap.set('n', '<leader>T', '<Plug>(todo-toggle)')
|
||||
vim.keymap.set('n', '<leader>t', '<Plug>(pending-open)')
|
||||
vim.keymap.set('n', '<leader>T', '<Plug>(pending-toggle)')
|
||||
```
|
||||
|
||||
| Plug mapping | Action |
|
||||
| ---------------------- | --------------------- |
|
||||
| `<Plug>(todo-open)` | Open task buffer |
|
||||
| `<Plug>(todo-toggle)` | Toggle complete |
|
||||
| `<Plug>(todo-view)` | Switch view |
|
||||
| `<Plug>(todo-priority)`| Toggle priority flag |
|
||||
| `<Plug>(todo-date)` | Prompt for due date |
|
||||
| `<Plug>(pending-open)` | Open task buffer |
|
||||
| `<Plug>(pending-toggle)` | Toggle complete |
|
||||
| `<Plug>(pending-view)` | Switch view |
|
||||
| `<Plug>(pending-priority)`| Toggle priority flag |
|
||||
| `<Plug>(pending-date)` | Prompt for due date |
|
||||
|
||||
## Data format
|
||||
|
||||
Tasks are stored as JSON at `stdpath('data')/todo/tasks.json`. The schema is
|
||||
Tasks are stored as JSON at `stdpath('data')/pending/tasks.json`. The schema is
|
||||
versioned and forward-compatible — unknown fields are preserved on round-trip.
|
||||
|
||||
## Documentation
|
||||
|
||||
```vim
|
||||
:checkhealth todo
|
||||
:checkhealth pending
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue