You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

97 lines
4.3 KiB
Org Mode

7 years ago
#+TITLE: weechat-slack
#+AUTHOR: Tony Olagbaiye
#+EMAIL: frony0@gmail.com
7 years ago
#+DATE: 2018-05-09
#+DESCRIPTION: Weechat plugin for Slack
#+KEYWORDS: weechat slack c api
#+LANGUAGE: en
#+OPTIONS: H:3 num:nil toc:nil \n:nil @:t ::t |:t ^:t -:t f:t *:t <:t
#+OPTIONS: TeX:t LaTeX:nil skip:nil d:nil todo:t pri:t tags:not-in-toc
7 years ago
#+EXPORT_EXCLUDE_TAGS: exclude
#+STARTUP: showall
[[https://travis-ci.org/bqv/weechat-slack][file:https://api.travis-ci.org/bqv/weechat-slack.svg?branch=master]]
[[https://coveralls.io/github/bqv/weechat-slack?branch=master][file:https://coveralls.io/repos/github/bqv/weechat-slack/badge.svg?branch=master]]
[[https://github.com/bqv/weechat-slack/issues][file:https://img.shields.io/github/issues/bqv/weechat-slack.svg]]
[[https://github.com/bqv/weechat-slack/issues?q=is:issue+is:closed][file:https://img.shields.io/github/issues-closed/bqv/weechat-slack.svg]]
[[https://github.com/bqv/weechat-slack/blob/master/LICENSE][file:https://img.shields.io/github/license/bqv/weechat-slack.svg]]
[[https://github.com/bqv/weechat-extras/][file:https://img.shields.io/badge/weechat--extras-slack-yellow.svg]]
7 years ago
| Status: | Under Development |
7 years ago
| Location: | [[http://github.com/bqv/weechat-slack]] |
| Version: | 0.1.0 |
7 years ago
* Description
A weechat plugin in C to extend the chat client to
support Slack workspaces via the RTM and Web APIs.
* Dependencies
- libwebsockets (static, submodule)
- json-c (static, submodule)
- weechat (>= v1.4)
* Building
#+begin_src sh
git clone git://github.com/bqv/weechat-slack.git
cd weechat-slack
make
make install
#+end_src
Do *NOT* run make install as root, it installs the plugin to your
local weechat plugins directory
* Development
I use emacs for development of this, although I am also a fan of vim.
My debug build process involves static analysis with clang and cppcheck,
and dynamic analysis with address-sanitizer and leak-sanitizer.
My debug evaluation process involves gdb/mi run with the arguments
=-ex "handle SIGPIPE nostop noprint pass" --args weechat -a 2>asan.log=
since part of weechat and it's default plugins use SIGPIPE as control.
I have no real requests for style of pull requests besides a wish that
you keep vaguely to the style I have adopted for this project.
Happy coding!
7 years ago
* Tasks
** DONE [#A] Implement basic functionality (milestone v0.1)
** TODO [#A] Implement essential api endpoints and events (milestone v0.2)
- [X] +Implement handling api message =message.me_message= (see [[http://github.com/bqv/weechat-slack/issues/5][#5]])+
- [X] +Implement sending request =chat.meMessage= (see [[http://github.com/bqv/weechat-slack/issues/5][#5]])+
- [ ] Implement handling api message =message.thread_broadcast=
- [X] +Implement handling api message =message.bot_message= (see [[http://github.com/bqv/weechat-slack/issues/2][#2]])+
- [ ] Implement handling api message =message.message_changed=
- [ ] Implement handling api message =message.message_deleted=
- [ ] Implement handling api message =message.message_replied=
** TODO [#B] Implement completion engine (milestone v0.3)
- [ ] Tab completion for slack emoji (see [[http://github.com/bqv/weechat-slack/issues/3][#3]])
- [ ] Tab completion for display/user names (see [[http://github.com/bqv/weechat-slack/issues/1][#1]])
- [ ] Sort nick-completion by recent (see [[http://github.com/bqv/weechat-slack/issues/4][#4]])
** TODO [#B] Implement debian packaging (milestone v0.4)
- [ ] Switch to system libwebsockets package (dynamically link) (see [[http://github.com/bqv/weechat-slack/issues/7][#7]])
- [ ] Create configure build step (cmake? autotools?)
** TODO [#C] Implement remaining api endpoints and events (milestone v0.5)
- [ ] Complete api endpoint set
- [ ] Complete api event set
** TODO [#C] Implement full weechat functionality (milestone v0.6)
- [ ] Hook buffer closes
- [ ] Relay compatibility
** TODO [#D] Close all issues (milestone v1.0)
7 years ago
* Contributing
*Your contributions are always welcome!*
Please submit a pull request or create an issue
to add a new or missing feature.
* License
weechat-slack is licensed under the Mozilla Public
License Version 2.0 available [[https://www.mozilla.org/en-US/MPL/2.0/][here]] and in LICENSE.