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

cli-dispatch

v1.3.0

Published

Dispatches or looks up actions in a directory from the given parameters.

Downloads

3,082

Readme

cli-dispatch v1.3.0

CircleCI codecov js-standard-style

Dispatches or looks up actions in a direactory from the given parameters.

Install

npm install cli-dispatch

Usage

First you need to set up the main script and actions/ directoty in the following structure:

bin/
├── main.js
└── actions
    ├── version.js
    ├── foo.js
    └── bar.js

In main.js:

const dispatch = require('cli-dispatch')
const minimisted = require('minimisted')

minimisted(function ({_: [action], v, version}) {
  if (v || version) {
    action = 'version'
  }

  dispatch(action, arguments[0]).on('no-action', () => {
    console.log(`No such action: ${action}`)
    process.exit(1)
  })
})

actions/version.js

module.exports = () => console.log('my-command v1.0.0')

actions/foo.js

module.exports = () => console.log('foo!')

actions/bar.js

module.exports = argv => console.log(`Hello, ${argv.name}!`)

Then, main.js works as the following:

$ node main.js -v
my-command v1.0.0
$ node main.js foo
foo!
$ node main.js bar --name John
Hello, John!
$ node main.js baz
No such action: baz

API

const dispatch = require('cli-dispatch')

dispatch(action, argv, options)

  • @param {string} action The name of the action
  • @param {object} argv The arguments which is passed to
  • @param {object} options The options
  • @param {string} [options.actions] The directory where this function look for the actions. Default is [the caller's directory]/actions. For example, if your main.js is in /foo/bar and you call dispatch in main.js, then it look for the actions under /foo/bar/actions
  • @return {CliDispatch} custom object

This dispatches the action by the given action name and returns the custom CliDispatch class instance. If the action file is not found, then the instance emits the no-action event.

argv is passed to the action function.

lookup(action, options)

  • @param {string} action The name of the action
  • @param {object} options The options
  • @param {string} [options.actions] The directory where this function look for the actions. Default is [the caller's directory]/actions. For example, if your main.js is in /foo/bar and you call dispatch in main.js, then it look for the actions under /foo/bar/actions

This looks up the action function by the given action name and returns that function.

License

MIT