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

@jwerre/minimist

v2.1.2

Published

Parse argument options.

Downloads

37

Readme

Minimist

Parse argument options.

This is a direct copy of Substack's minimist v1.2.6 who's github account was deleted for some reason.

Example

parse.js

import parseArgs from '@jwerre/minimist';
const argv = parseArgs(process.argv.slice(2));
console.log(argv);
$ node ./parse.js -a beep -b boop
{ _: [], a: 'beep', b: 'boop' }
$ node ./parse.js -x 3 -y 4 -n5 -abc --beep=boop foo bar baz
{
  _: [ 'foo', 'bar', 'baz' ],
  x: 3,
  y: 4,
  n: 5,
  a: true,
  b: true,
  c: true,
  beep: 'boop'
}

Options

Return an argument object argv populated with the array arguments from args.

argv._ contains all the arguments that didn't have any options associated with them. Numeric-looking arguments will be returned as numbers unless opts.string or opts.boolean is set for that argument name. Any arguments after -- will not be parsed and will end up in argv._.

| Param | Type | Description | | -------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | args | Array | Command line argument to parse. Typeicaly in the form of process.argv.slice(2) | | opts | Object | Parsing options. | | opts.string | String | A string or array of strings argument names to always treat as strings | | opts.boolean | Boolean | A boolean, string or array of strings to always treat as booleans. if true will treat all double hyphenated arguments without equal signs as boolean (e.g. affects --foo, not -f or --foo=bar) | | opts.alias | Object | An object mapping string names to strings or arrays of string argument names to use as aliases | | opts.default | Object | An object mapping string argument names to default values | | opts.stopEarly | Boolean | When true, populate argv._ with everything before the -- and argv['--'] with everything after the --. See example below. | | opts.unknown | function | a function which is invoked with a command line parameter not defined in the opts configuration object. If the function returns false, the unknown option is not added to argv. |

stopEarly example

parseArgs('one two three -- four five --six'.split(' '), { '--': true });
// { _: [ 'one', 'two', 'three' ], '--': [ 'four', 'five', '--six' ] }

Note that with opts['--'] set, parsing for arguments still stops after the --.

Install

npm install @jwerre/minimist

Difference between V1 and V2

The only different between the version 1 and 2 is that version 2 uses the ES6 Module definition.

Version 1

npm install @jwerre/[email protected]
const parseArgs = require('@jwerre/minimist');
const argv = parseArgs(process.argv.slice(2));
console.log(argv);

Version 2

npm install @jwerre/minimist@2
import parseArgs from '@jwerre/minimist';
const argv = parseArgs(process.argv.slice(2));
console.log(argv);