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

node-options

v0.0.7

Published

Parse the command line arguments

Downloads

43,787

Readme

Command line argument parser Build Status Coverage Status dependency Status devDependency Status NPM version

========

This module is a command line argument parser, based on regular expression. It is able to validate the arguments based on the "properties" of an object.

#LICENSE:

This module is licensed under the Apache License v2.0

Installation

npm install node-options

Usage

var options = require('options');

// A simple use case for an http server could be that you want to be able
// to specify the port number on which your server will listen by having
// a default value in the code (e.g. 3000) or use the PORT environment
// variable, if it is present or finally specify the port number on the
// command line (e.g. --port=8080). You could also change your server
// verbosity (e.g. logging) by adding "--verbose" to the command line.
// Finaly, you want to be able to change the path from which your server
// would serve the "static" html pages.
//
var opts =  {
              "port"    : process.env.PORT | 3000,
              "verbose" : false
            };

// Remove the first two arguments, which are the 'node' binary and the name
// of your script.
var result = options.parse(process.argv.slice(2), opts);

// If an argument was passed on the command line, but was not defined in
// the "opts" object, lets print the USAGE.
if (result.errors) {
    if (opts.verbose) console.log('Unknown argument(s): "' + result.errors.join('", "') + '"');
    console.log('USAGE: [--port=3000] [--verbose] [public/path/to/static/resources]');
    process.exit(-1);
}

console.log('port=', opts.port);
console.log('verbose=', opts.verbose);
if (result.args)
    if (result.args.length === 1) {
        console.log('public=', result.args)
    } else {
        console.log('Only one non-option argument is supported by the app: '" + result.result.join('", "') + '"');
        process.exit(-2);
    }
}

Other usage

If you want to pass some arguments to another process "as-is", the parser support the double-dash as an indicator to grab all the arguments left and return them in the "result.passThrough" property.

Sample

node server.js --verbose --port=80 proxy.json -- --port=80 ./public/static/www
               ^         ^         ^             ^         ^
               |         |         |             |         |
 opt.verbose --+         |         |             |         |
 opt.port ---------------+         |             |         |
 result.args[0] -------------------+             |         |
 result.end[0] ----------------------------------+         |
 result.end[1] --------------------------------------------+

All the options needs to be first (e.g. --XXX) and they are stored in the object passed to the parse function (e.g. options.parse(arguments.argv.slice(2), OBJECT). After the options, the "free form" files, paths, text is stored into the returned object inside the property 'args' which is an array. Lastly, if a double dash is encountered everyting afterward is in the returned object property 'end'.