nvim-todoist.lua
nvim-todoist.lua copied to clipboard
smolck
Todoist plugin for Neovim in pure Lua, inspired by https://github.com/romgrk/todoist.nvim, which you should use instead
NOTE: This was more of an idea I put into code because todoist.nvim wasn't working for me. But, I don't really plan to maintain it, and it's not really all that usable anyways, so if you're looking for a Todoist plugin, just use https://github.com/romgrk/todoist.nvim instead.
nvim-todoist.lua - Todoist plugin for Neovim
Setup + Installation
Requirements
Use your plugin manager of choice, like vim-plug or packer.nvim. Here's an example with vim-plug:
" Dependency
Plug 'nvim-lua/plenary.nvim'
Plug 'smolck/nvim-todoist.lua'
Just make sure that no matter what package manager you use, you install plenary.nvim along with this plugin.
After you've done that, make sure to add this to your init.vim (after the Plug lines):
lua << EOF
require'nvim-todoist'.neovim_stuff.use_defaults()
EOF
If you don't do that, none of this plugin's functions, like :Todoist, will work!
API Token
First, get your Todoist API token from https://todoist.com/prefs/integrations. After that, set the $TODOIST_API_KEY environmental variable to
that token.
Usage
Call :Todoist from within Neovim, and you'll be greeted by a floating window with your Inbox tasks. Alternatively, you can call :Todoist <project name>, e.g. :Todoist Welcome, to view tasks from a specific project.
Mappings
| Command | Default Mapping | Result |
|---|---|---|
:TodoistMoveCursorDown/:TodoistMoveCursorUp |
j/k |
Moves up and down between tasks |
:TodoistToggleTask |
x |
Closes/opens task under cursor |
:TodoistDeleteTask |
dd |
Deletes task under cursor |
:TodoistRefresh |
r |
Fetches latest tasks/projects & updates todoist buffer |
:TodoistCreateTask |
c |
Creates a new task after asking for content & date |
Contributing
Just create an issue or open a PR! Contributions are welcome and appreciated ;)
smolck