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

chatcommand-parser

v0.1.3

Published

A package to parse commands in text chats (IRC, Slack, ...)

Downloads

5

Readme

Chatcommand Parser

A package to parse commands in text chats (IRC, Slack, ...)

Installation

npm install chatcommand-parser

Usage

Creating commands

var parser = require("chatcommand-parser");

var p = new parser.Parser("!"); //You can optionally pass a prefix string to prefix every command with, defaults to "!"
p.addCommand("test");
p.addCommand("test2");
p.addCommand("test3");

//Add arguments
p["test2"].addArgument(parser.argument.int("integer")); //Add an int type argument named 'integer'
p["test2"].addArgument("testarg"); // Defaults to the 'word' type argument - gets everything up to a space

p["test3"].addArgument(parser.argument.list("lst", "one", "two", "three");
p["test3"].addArgument(parser.argument.all("all")).setRequired(false);

//Reference the arguments with p["test3"]["lst"] for example

//Create commands with an object

var p2 = new parser.Parser({
  test: { // !test command
    integer: ["int"], //int type argument named 'integer'
    wordarg: ["word"],
    listarg: ["list?", "one", "two", "three"], //Optional list type argument
    allarg: ["all"]
  }
});

Parsing commands

var parsed = p.parse(text);
if (!parsed) return; //Returns null if no matching command found
if (parsed.command == "test") { //If, for example, text == "!test"
  //Matched the 'test' command
}
if (parsed.command == "test2") { //text == "!test2 2 test"
  //Get the argument values
  console.log(parsed.args.integer); //Prints '2'
  console.log(parsed.args.testarg); //Prints 'test'
}