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

fncli

v0.6.1

Published

cli framework using function signatures

Downloads

33

Readme

fncli -- cli framework using function signatures

require('fncli')(
  // Pass a main function. Parameters become arguments or options
  function (name, {greeting="Hello", shout=false}) {

  }
);

This would result in the following interface:

usage: script [options] name
options:
  --greeting=<value>
  --shout

Sub-command style

require('fncli')({
  // Pass an object with functions. Function names become
  // subcommands.
  hello(name, {greeting="Hello", shout=false}) {

  },
  goodbye({shout=false}) {

  }
});

Aliases, short options

Single-letter options become short options. Aliases use ES6 syntax for assigning to new variable names.

In this example, the -s option and --shout are aliases.

require('fncli')(
  function (// Description of command
    name, // Description of name
    {
      greeting="Hello", // Description of greeting
      s: shout=false
    }) {
      // Use `shout` in here
  }
);

Repeating parameters

Rest parameters allow zero or more arguments to be passed.

require('fncli')(
  function (
    ...names,
    ) {

  }
);

Including descriptions

Descriptions of commands, arguments and options can be accomplished using comments.

require('fncli')(
  function (// Description of command
    name, // Description of name
    {
      greeting="Hello", // Description of greeting
      shout=false
    }) {

  }
);

This would result in the following interface:

error: Missing required argument
usage: script [options] name

Description of command

args:
  name    Description of name

options:
  --greeting=<value>   Description of greeting
  --shout=<value>

Usage errors

Throwing "error:" messages will show usage and the error.

require('fncli')(
  function (
    ...names, // At least one
    ) {
    if (names.length < 1) {
      throw "error: pass at least one name";
    }
  }
);

Config argument

The fncli function accepts an object as an optional second parameter, with:

  • argv to process that instead of process.argv.
  • help: true to add a --help option that prints the usage.

NB: help is likely to default to true in the future.

Argument handing

An argument of -- is skipped, and following arguments are not treated as options.

Until -- is seen, options are allowed after arguments. Eg, passing foo bar -x will set an x option to true, or be an error if there is no -x option.