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

gallows

v1.0.0

Published

Gallows is a lightweight command execution framework. It allows you to define a set of commands, each with their own validation, execution, and example. Commands can then be invoked with specified attributes and a body.

Downloads

122

Readme

Gallows

Gallows is a lightweight command execution framework. It allows you to define a set of commands, each with their own validation, execution, and example. Commands can then be invoked with specified attributes and a body.

Usage

To use Gallows, you define your commands, then execute them:

gallows([
  // Define your commands here
]).execute(
  // Execute commands here
)

Each command has the following properties:

  • name: The name of the command
  • validate(attributes, body): A function that validates the command's attributes and body
  • execute(attributes, body): A function that executes the command with the provided attributes and body and returns the result
  • example: An object with attributes and body properties, demonstrating how to use the command
  • description: A description of what the command does

When executing commands, you provide the following arguments:

  • action: The name of the command to execute
  • attributes: An object containing the attributes for the command
  • body: The body of the command

Here's an example of how to define and execute a command:

gallows([
  {
    name: 'echo',
    validate: (attributes, body) => {
      return body !== undefined;
    },
    execute: (attributes, body) => {
      // Execute the 'echo' command with the provided body
      return body;
    },
    example: {
      attributes: {},
      body: 'Hello, Gallows!'
    },
    description: 'Echoes the provided message'
  }
]).execute(
  'echo',
  {},
  'Hello, Gallows!'
)

The execute function will return the result of the command.

Command Overloading

Gallows supports command overloading, which means that you can define multiple commands with the same name. When executing a command, the first command that passes the validate function will be executed. This allows you to provide different implementations of the same command based on the provided attributes and body.

Here's an example of command overloading:

gallows([
  {
    name: 'echo',
    validate: (attributes, body) => body !== undefined,
    execute: (attributes, body) => body,
    example: {
      attributes: {},
      body: 'Hello, Gallows!'
    },
    description: 'Echoes the provided message'
  },
  {
    name: 'echo',
    validate: (attributes, body) => attributes.message !== undefined,
    execute: (attributes, body) => `Echo: ${attributes.message}`,
    example: {
      attributes: { message: 'Hello, world!' },
      body: ''
    },
    description: 'Echoes the provided message'
  }
]).execute(
  'echo',
  { message: 'Hello, world!' },
  ''
)

In this example, the second echo command will be executed, as its validate function matches the provided attributes.

Feel free to add more commands to your Gallows project!