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

type-args

v0.2.1

Published

The node.js command line options parser which plays well with TypeScript.

Downloads

822

Readme

type-args

NPM version Build Status Test Coverage Dependency Status DevDependency Status License PR Welcome

The node.js options parser that plays well with TypeScript. To fetch the TypeScript interface from the option rules is extremely hard. However, type-args tries its best to make coding experience of command line option parsing more intelligent.

This is a minimalist implementation. And its algorithms are optimized. It's without annoying command interfaces.

Installation

Install this package with npm.

npm i type-args -s

Usage

Define your parsing rules

const rules = {
  'help': {
    alias: 'h',
    desc: 'display help.',
    type: 'boolean'
  },
  'version': {
    alias: 'v',
    desc: 'display version.',
    type: 'boolean'
  },
  'verbose': {
    alias: 'V',
    desc: 'verbose output.',
    type: 'boolean',
    default: true
  },
  'files': {
    alias: 'f',
    desc: 'the files to be transformed',
    type: 'string[]'
  }
}

The parsing rule is an object with camel cased flag names as keys, and descriptor objects as values. The descriptor object has 4 values.

  • alias, single character string as the shortcut of the flag.
  • desc, a string represents the description of the options.
  • type, 'boolean' | 'number' | 'string' | 'number[]' | 'string[]'.
  • default, the default value of the option.

Parsing ARGV

import { parse } from 'type-args';

const [options, args, unknownOptions] = parse(process.argv, rules);
  • options is an object of parsed values.
  • args is an array of non option tokens.
  • unknownOptions is an array of undefined flags passed from argv.

Merging saved options

You can pass unlimited amount of saved options. Imagine you are the author of a large framework. You read options from package.json, from the .rcfile and user command line arguments. You may want merging those together with precedence like this:

default value < package.json < .rcfile < user command line arguments

type-args does what you want by accepting the ...third arguments.

License

MIT © Zhang Kai Yu