JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 30
  • Score
    100M100P100Q55319F
  • License MIT

Hubot page for user @mention aliases

Package Exports

  • hubot-group-alias

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (hubot-group-alias) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Hubot Group Alias

Group Alias is a simple [Hubot][hubot] plugin which allows you to define new "@mentions" which are automatically expanded by your bot. For example, you could define @dev, @design to send a message to all members of your teams.

Configuration

  1. All this package to your package.json. Do this by running this command:

    npm i --save hubot-group-alias

  2. Add "hubot-group-alias" to external-scripts.json:

    [
"...",
"hubot-group-alias",
"..."
]

  3. Set the HUBOT_GROUP_ALIAS variable.

     heroku config:add HUBOT_GROUP_ALIAS=...

HUBOUT_GROUP_ALIAS Format

The format for configuration is easy:

alias1=user1,user2;alias2=user1

That is:

  • Separate different aliases by ;.
  • Define an alias with =.
  • Separate users by ,.
  • Users (and aliases) should not have @.
  • Aliases are case insensitive.

Note: When set in a shell environment, you may want to put '' around your alias definition so that any ; don't try to break the command.

Autocomplete Abilities

By default, most chat apps don't support autocomplete for bots. :( However, Hubot Group Alias includes the ability to use custom emoji in order to allow apps autocomplete. This should work with most chat clients, though please file an issue if there is a different emoji syntax I've missed. To use this feature, all you need to do is add the emoji to your particular chatroom, with the same name as the alias. The script matches the following forms of the alias dev:

  • @dev
  • (dev)
  • :dev:
  • ::dev::

Usage

For example: If you set the configuration as: dev=Alice,Bob,Eve And the message sent is: Disgruntled PO: Hey @dev, there's a standup in 5 min. Then this message will be sent by Hubot: Hubot: Hey @Alice @Bob @Eve, there's a standup in 5 min.