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

bot-command-loader

v1.1.5

Published

Allows easy loading and changing of commands for a bot application.

Downloads

2

Readme

Easily create and load bot commands. Simply create a directory and place your command files inside, specifying a single config, help, and run property as your exports (Examples - 1). Each FILE inside your commands folder represents a single command (file name is not required to be the command name, as your properties specify such). Each FOLDER inside your commands folder represents a command group (folder name matches the group name).

Installation

npm i bot-command-loader

Usage

  1. function buildList(cmdDirPath, defCmdPrefix): creates and returns a list of commands for the directory reading to add to. Takes the path to your command directory and your preferred default prefix as parameters.
  2. function createManager(cmdDirPath, defCmdPrefix): creates and returns a default manager to allow quick setup of parsing messages for commands and their required info. Takes the path to your command directory and your preferred default prefix as parameters.

Examples

1 (Ex. Command File Setup)

exports.config = {
  enabled: true,
  aliases: [],
  default: false,
  dm_usable: true;
};

exports.help = {
  name: 'ping',
  description: 'Ping/Pong command. I wonder what this does? /sarcasm',
  usage: 'ping'
};

exports.run = {
  discord: function(cmdParams) {
    var message = cmdParams['message'];
    message.channel.send('Ping?').then(function(msg) {
      msg.edit(`Pong! (${msg.createdTimestamp - message.createdTimestamp}ms)`);
    });
  }
};

2 (Ex. Function Calls)

const CommandManager = require('bot-command-loader').createManager('./commands', '>');
const CommandList = require('bot-command-loader').buildList('./commands', '>');