@hammerhq/hargs NPM

@hammerhq/hargs

✨ A simple argument parsing system with 0 dependencies

A friendly fork of vercel/arg

📦 Installation

$ npm install @hammerhq/hargs

🚀 Usage

hargs(IOptionDefinition, argv?);

IOptionDefinition: Where options are defined to be used when separating arguments. Structure:

{
    // Option definitions
    "--option": String,
    "--option2": Boolean,
    "--option3": MyCustomFunction,

    // Aliases
    "-o": "--option",
}

argv?: Arguments to parse. Default is process.argv.slice(2) (string[]).

🛠️ Example

/* es6 */
import { hargs } from "@hammerhq/hargs";

/* commonJS */
const { hargs } = require("@hammerhq/hargs");

const argv = ["--foo=bar", "-p", "2", "--foo", "baz", "test", "1", "2", "-h"];

hargs(
	{
		"--help": Boolean,
		"--page": Number,
		"--foo": [String],

		"-p": "--page",
		"-h": "--help",
	},
	argv,
);
/*
{
  _unknown: [ 'test', '1', '2' ],
  '--foo': [ 'bar', 'baz' ],
  '--page': 2,
  '--help': false
}
 */

🧦 Looking For Contributors

We are looking for contributors to actively work on Hammer and to contribute to the repos. There is still lots of work to do. If you are interested in contributing, please join our Discord server. (There will be a surprise for early contributors!)