https://github.com/jmcshane/hubot-command-counter
Hubot middleware to count the number of times a command is matched
https://github.com/jmcshane/hubot-command-counter
hubot hubot-scripts npm-package
Last synced: 5 months ago
JSON representation
Hubot middleware to count the number of times a command is matched
- Host: GitHub
- URL: https://github.com/jmcshane/hubot-command-counter
- Owner: jmcshane
- Created: 2017-02-10T15:01:30.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-02-05T14:11:17.000Z (over 8 years ago)
- Last Synced: 2025-10-25T04:55:14.884Z (8 months ago)
- Topics: hubot, hubot-scripts, npm-package
- Language: CoffeeScript
- Size: 9.77 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hubot Command Counter
This module implements the Hubot middleware pattern to count the number of times each command is called. It uses the brain to store this information so that it can be persisted if desired.
## Installation
In order to install the hubot counter, first install the package:
npm install --save hubot-command-counter
Then, add the counter to the `external-scripts.json` file at the root of your project.
[
"hubot-command-counter"
]
## Configuration
If you are using a brain that requires the save event in order to persist the brain data, set the environment variable `HUBOT_COMMAND_COUNTER_SAVE_PERIOD`. This will trigger the brain save event with this period value in seconds. If this value is not set, the save event is not triggered by this middleware.
## Listener Configuration
Within hubot, there are not good ways to identify listeners. In order to get better identifiers, an option parameter was added to all the `robot.*` functions. This middleware users the hubot built-in `id` option that will allow each command to be named nicely.
robot.respond /test post please ignore/, {id: test-post}, (msg) ->
## Accessing Counts
Once the commands are aliased as above, these counts can be accessed using the following command
count-middleware
If no id is provided, the counts for all recorded commands will be listed.