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

optometrist

v1.0.1

Published

Simple argument parsing via process.argv and process.env.

Downloads

8

Readme

optometrist

Option setting via flags, environment variables, and defaults (in that order).

Why yet another options parser?

Most of the others out there have way too much configuration to cut through, and for whatever reason environment varibles never got that popular among Nodeists.

Installation

npm install optometrist

Methods

optometrist.get(schema)

Given a schema object, returns an object containing settings. They're retrieved in the following order of prioirty:

  1. Flags
  2. Environment variables
  3. Schema-provided defaults.

The schema object follows this structure:

{
  'key': {
    'description': 'It\'s a key.',
    'required': true
  },
  'otherKey': {
    'description': 'Please spell "key."',
    'default': 'something'
  }
}

If you include a 'required' key and it can't be found in any of the three locations, Optometrist will throw. This is convenient for use with optometrist.usage(), as below.

JSON.parse is used to coerce flags and environment variables back into Javascript objects.

Environment variable and flag names are converted to camel case for your convenience. So if you define a setting in your schema with a name like 'howManyRomans', it'lll be looked up in the environment as HOW_MANY_ROMANS and in the flags as --how-many-romans.

Flags should use the syntax --flag=value.

optometrist.usage(name, description, schema)

Returns a string containing usage information for the schema. Useful for writing a command-line application.

Actually, all you have to do is:

var schema = {
  foo: {
    required: true
  }
};

var settings;

try {

  settings = optometrist.get(schema);
  console.log('You provided', foo, 'for foo.');

} catch(e) {
  
  console.log(optometrist.usage('myapp', 'Does cool stuff!', schema);
  process.exit(1);

}

If the user fails to supply a value for foo, they'll get the following:


Does cool stuff!
Usage: myapp options

Options:

  --foo

Any of the parameters can also be set by environment variables:

  FOO

Error: Missing required option foo

optometrist.merge(dst, [src1], [src2], ...)

Nonrecursively merge keys from src1, src2, etc., into dst. Provided as a convenience.

Development

git clone https://github.com/casetext/optometrist
cd optometrist
npm install
npm test

Copyright

© 2014, J2H2, Inc. Licensed under ISC.