npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ferd

v0.5.0

Published

A modular Slackbot

Downloads

19

Readme

A modular slackbot

Build Status

Ferd is a modular Slack Bot. It abstracts away the complexity of the Slack Real-Time Messaging API. Use this repo as an open source project to build your own bots, or check out FerdX for some fun.

To Run

Uses ES6. Runs using node --harmony

var ferdModule = require('ferdModule');
var Ferd = require('ferd');

var ferd = new Ferd(); //create new ferd instance
ferd.addModule(ferdModule); //inject module into ferd
ferd.login(); //bot starts listening
ferd.logout(); //bot stops listening

Creating Ferd Modules

To create modules, use the following syntax:

/* All variables in this closure are accessible by all bots using this module */
var randomYo = ["whats up? ", "hey ", "yo "];
var getRandomYo = function() {
  return randomYo[Math.floor(Math.random() * randomYo.length)];
};

module.exports = function(ferd) {
  /* All variables in this closure are accessible to all listeners in this module */
  var yoCount = 0;

  /* Listens to all messages */
  ferd.listen(/(.*) is (.*)/, function(response) {
    var sender = response.getMessageSender();
    response.send("No, " + sender.name + ", you " + "aren't " + response.match[2]);
  });

  /* Listens to messages tagged with bot's name or mentions bot */
  var listener = ferd.respond(/yo/i, function(response) {
    var sender = response.getMessageSender();
    response.send(getRandomYo() + sender.name);
    yoCount++;
  });

  /* Stops listening on specific listener */
  ferd.ignore(listener);

  /* Say 'hello' to join session and 'goodbye' to leave session.
   * Use to create poker and trivia games.
   */
  ferd.session(/hello/, /goodbye/, function(response) {
    response.send("I hear you... " + response.getMessageSender().name);
  });

  /*  Get all mentions of `yo` since bot's initialization */
  ferd.listen(/how many yo?/ function(response) {
    response.send(yoCount);
  });
};

Slack types

For more information on Slack types, check out https://api.slack.com/types.

Contributing

For contributing, see the contributing guidelines.

Style Guide

If you're contributing, make sure to check out the style guide.

Team

License

MIT