A Lita extension to ignore a user's non-command messages upon request
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
locales
spec
.codeclimate.yml
.gitignore
.rubocop.yml
.travis.yml
Gemfile
LICENSE
README.md
Rakefile
lita-ignore-me.gemspec

README.md

lita-ignore-me

RubyGems Build Status Code Climate

lita-ignore-me is a Lita extension that allows a user to tell the robot that he or she wishes to be ignored unless addressing the robot directly. This means that routes that are triggered that are not commands are not executed.

Installation

Add lita-ignore-me to your Lita plugin's gemspec:

spec.add_runtime_dependency "lita-ignore-me"

Usage

There is no additional configuration necessary. There are two commands added for a user to manage whether the robot will listen to or ignore that user in the current room: ignore me and listen to me.

Assuming there is some handler that echoes messages that start with 'echo' installed and configured, a conversation might look like this:

Chad: echo I don't like to be echoed.
Lita: I don't like to be echoed.
Chad: @Lita: ignore me
Lita: Okay Chad, I'll ignore you in #room unless you address me directly.
Chad: echo I don't like to be echoed.
Chad: lita help
Lita: *prints help*
Chad: @Lita: listen to me
Lita: Okay Chad, I'm listening to you in #room.
Chad: echo I expect to be echoed.
Lita: I expect to be echoed.

You can also request that the robot ignore you or listen to you in a different room by specifying the room name (e.g., ignore me in #some-room). In the case of Slack, this allows you to send a message to the robot directly, without the need to clutter the target room with extra messages.

License

MIT