https://github.com/smolck/nvim-todoist.lua

Todoist plugin for Neovim in pure Lua, inspired by https://github.com/romgrk/todoist.nvim, which you should use instead
https://github.com/smolck/nvim-todoist.lua

floating-window lua neovim neovim-plugin nvim

Last synced: 21 days ago
JSON representation

Todoist plugin for Neovim in pure Lua, inspired by https://github.com/romgrk/todoist.nvim, which you should use instead

• Host: GitHub
• URL: https://github.com/smolck/nvim-todoist.lua
• Owner: smolck
• Created: 2020-08-14T15:18:11.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-06-08T13:11:17.000Z (over 3 years ago)
• Last Synced: 2023-03-05T02:13:39.461Z (over 1 year ago)
• Topics: floating-window, lua, neovim, neovim-plugin, nvim
• Language: Lua
• Homepage:
• Size: 38.1 KB
• Stars: 22
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
> 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

* [Neovim 0.5.0 (nightly)](https://github.com/neovim/neovim/releases/tag/nightly)

Use your plugin manager of choice, like [vim-plug](junegunn/vim-plug) or

[packer.nvim](wbthomason/packer.nvim). Here's an example with vim-plug:

```vim

" 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](https://github.com/nvim-lua/plenary.nvim) along with this plugin.

After you've done that, make sure to add this to your `init.vim` (after the `Plug` lines):

```vim

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 `, 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 ;)