cympfh / slack-memo-vim

Simple memo manager with Vim using Slack.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

slack-memo.vim

Simple memo manager with Vim using Slack.

Screenshots

Screenshot

Usage

Post a memo on Slack.

:SlackMemoPost

List memos on Slack.

:SlackMemoList

List memos on Slack with CtrlP.

:SlackMemoCtrlP

List search result memos on Slack

:SlackMemoSearch search query

Keymaps in the memo list

The following keymaps are available in the buffer of the memo list. It does not work with CtrlP.

key description
Enter or o Open memo on cursor.
Esc or q Close memo list window.
d Delete memo on cursor.
y Yank memo on cursor.
r Update list window.

You can udpate it by saving memo opened in buffer.

Install

It's easy to install using plugin manager.
Depending on your plugin manager, please add the following to .vimrc.

Install with dein

call dein#add('tsuyoshiwada/slack-memo-vim', {'depends': 'mattn/webapi-vim'})

Install with NeoBundle

NeoBundle 'tsuyoshiwada/slack-memo-vim', {'depends': 'mattn/webapi-vim'}

Requirements

Setup

You need a token to use Slack Web API.
Please set your token on g:slack_memo_token. and set channel Id in g:slack_memo_channel.

let g:slack_memo_token = '<YOUR_TOKEN>'
let g:slack_memo_channel = '<YOUR_MEMO_CHANNEL_ID>'

If you do not know the Id right away, you can easily check with the channel.list tester.

Setup is complete!

Tips

Example keymap

You can post / list easily with the following keymap.

nnoremap smp :SlackMemoPost<CR>
nnoremap sml :SlackMemoList<CR>

GFM TODO list

Support GFM TODO list. Posting following memo will be displayed with emoji on Slack.

* [x] Done1
* [x] Done2
* [ ] TODO...

Contributing

Reporting issue

Contributing to code

  • Fork it.
  • Commit your changes and give your commit message.
  • Push to your fork on GitHub.
  • Open a Pull Request.

Credit

License

See the LICENSE.

TODO

  • Support CtrlP.
  • Support sort list.
  • Support vertical split list window.
  • Support open memo in new tab.
  • Delete multiple memos.
  • List more than 1000 memos.

About

Simple memo manager with Vim using Slack.

License:Other


Languages

Language:Vim Script 100.0%