Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/romgrk/todoist.nvim
A todoist extension for neovim
https://github.com/romgrk/todoist.nvim
neovim neovim-plugin todoist vim vim-plugin
Last synced: 11 days ago
JSON representation
A todoist extension for neovim
- Host: GitHub
- URL: https://github.com/romgrk/todoist.nvim
- Owner: romgrk
- Created: 2020-05-22T22:36:05.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T16:08:07.000Z (over 1 year ago)
- Last Synced: 2024-05-30T16:43:30.307Z (28 days ago)
- Topics: neovim, neovim-plugin, todoist, vim, vim-plugin
- Language: JavaScript
- Homepage:
- Size: 405 KB
- Stars: 159
- Watchers: 5
- Forks: 9
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Lists
- awesome-stars - romgrk/todoist.nvim - A todoist extension for neovim (JavaScript)
- awesome-stars - romgrk/todoist.nvim - A todoist extension for neovim (JavaScript)
README
# todoist.nvim
> A hopefully usable todoist extension for neovim
For integration with vim-clap (fuzzy finder) [see below](#integration-with-clap).
#### Install
Find your API key here: https://todoist.com/prefs/integrations
For security reasons, it is recommended to use [pass](https://www.passwordstore.org/) to store it:
```bash
$ pass insert Todoist/API
Enter password for Todoist/API: XXXXXXXXX
```
Export it in your `~/.config/environment.d/*.conf`/`~/.profile`/`~/.bashrc`
```bash
export TODOIST_API_KEY="$(pass Todoist/API)"
```
```vim
Plug 'romgrk/todoist.nvim', { 'do': ':TodoistInstall' }
```
If you don't use [vim-plug](https://github.com/junegunn/vim-plug), run the `TodoistInstall`
command manually to complete the installation.
#### Requirements
- neovim 0.4.0
- nodejs 10.0.0
- `npm install -g neovim@latest` (**NOTE**: needs to be at v4.9.0 at least!)
Make sure your nodejs provider works (`:checkhealth` to confirm).
## Usage
`:Todoist [project_name]` (default: `Inbox`. Creates project if it doesn't exist)
### Mappings
|Keys|Effect|
|---|---|
|`x`|Toggle current task completion|
|`cc`|Change current task text|
|`cd`|Change current task date ([date formats](https://get.todoist.help/hc/en-us/articles/205325931-Due-Dates-Times))|
|`p1`|Make task Priority 1|
|`p2`|Make task Priority 2|
|`p3`|Make task Priority 3|
|`p4`|Make task Priority 4|
|`DD`|Delete current task|
|`O`|Add new task before|
|`o`|Add new task after|
|`<`|Unindent|
|`>`|Indent|
|`r`|Refresh|
|`pcc`|Change current project color|
|`pcn`|Change current project name|
|`pdd`|Archive current project *premium users only :/*|
|`pDD`|Delete current project|
### Options
Below are the default options:
```vim
let todoist = {
\ 'icons': {
\ 'unchecked': ' [ ] ',
\ 'checked': ' [x] ',
\ 'loading': ' […] ',
\ 'error': ' [!] ',
\ },
\ 'defaultProject': 'Inbox',
\ 'useMarkdownSyntax': v:true,
\}
```
If you have a [NerdFont](https://www.nerdfonts.com/) installed, you can use the icons
below, that will render like in the gif above.
```vim
let todoist = {
\ 'icons': {
\ 'unchecked': ' ',
\ 'checked': ' ',
\ 'loading': ' ',
\ 'error': ' ',
\ },
\}
```
### Integration with Clap
This plugin implements a [vim-clap](https://github.com/liuchengxu/vim-clap) provider
for selecting your projects.
```vim
Clap todoist
```
