jleechpe / erc-gitter

ERC module for Gitter (irc.gitter.im)

ERC-Gitter

ERC-Gitter is an ERC module with the goal of incorporating the features present in Gitter Chatrooms.

Features

• Proper sending and viewing of multiline messages include code-blocks.
• Inline markdown formatting using markdown-mode.
• Link detection for github issues (#IssueNo), and cross-repo issues (user/repo#IssueNo).

Planned

• Recognition of @name and @/all notices used in Gitter web-client.
• Support for @name completion.

Currently unsupported

• Code and quote block markup. ERC receives messages on a line-by-line basis. Matching these lines to detect code and quote blocks would require finding github block markers (```) or text starting with 4 spaces (normal code block) and then fontifying until end of block (next ```, end of 4+ space indent, change of user).

  These lines also include the entire IRC message string (sender, server, PRIVMSG), which should not be fontified in the process.

  Any assistance in reliably detecting these blocks is appreciated.

Installation

This package has the following dependencies:

• ERC (bundled with emacs)
• Markdown-Mode (available in MELPA)

Git Development package

To install the development package, follow the usual steps:

Clone this repository

https://github.com/jleechpe/erc-gitter.git

Add the directory to your load path

(add-to-list 'load-path "/path/to/erc-gitter/")

Require the package

(require 'erc-gitter)

Usage

Add erc-gitter to the list of erc-modules and update the list of modules.

(add-to-list 'erc-modules 'gitter)
(erc-update-modules)

Alternately, enable the module directly via M-x erc-gitter-enable.

Contributing

Please contribute. Doing any of the following will help

• Open an issue
• Submit a pull request
• Discuss the package on Gitter

erc-gitter's Issues

Add support for history log

Hi, thanks for the project! I was wondering if it's possible to have access to the history log in a similar way to the one that is done here: https://github.com/erickpintor/gitterlog

Test issue

Testing notification view.

Integrate gitter's @name with erc's name:

Allow for cross-repo issue linking

Currently only #Issue works, allow for <user>/<repo>#Issue as well.

Handle incoming code blocks sent from ERC.

This was sent via ERC (use ^M to ensure sent as a block, otherwise no block highlight or guarantee of order)

Warning (erc-response): :[email protected] PRIVMSG #jleechpe/erc-gitter :```
Warning (erc-response): This is a test
Warning (erc-response): ```

This was sent from the web client

Warning (erc-response): :[email protected] PRIVMSG #jleechpe/erc-gitter :```
Warning (erc-response): :[email protected] PRIVMSG #jleechpe/erc-gitter :test2
Warning (erc-response): :[email protected] PRIVMSG #jleechpe/erc-gitter :```

Highlight (or deemphasize) messages from gitter

Add to melpa

Mirror gitter messages on another buffer

Or something like that. Just make them somehow available without drowning out conversation.

Mardown hightlighting

I remember you mentioned this, so I thought this might help:

(with-temp-buffer
  (insert text)
  (markdown-mode)
  (font-lock-fontify-region (point-min) (point-max))
  (buffer-string))

Gitter keymap to allow compose-mode (ala web)

Setup Gitter Login method

Set up a function to simplify login to Gitter over ERC (obtain /NICK and /PASS from https://irc.gitter.im)

Should be able to use w3m or eww to browse the page and log in, then take the returned information to perform the login while connecting.

Offer to save the credentials for future use (if ERC does not automatically)