Parses command line arguments. Port & rewrite of the node library minimist

Parses command line arguments. Port & rewrite of the node library minimist

deno_minimist .Parses command line arguments. Port & rewrite of the node library minimist

deno_minimist

💾 Parses command line arguments.

Port & rewrite to deno & typescript of the node library minimist.

example

// parse.ts
import parseArgs from 'https://deno.land/x/[email protected]/mod.ts';

parseArgs(Deno.args);
$ deno run ./examples/parse.ts -a beep -b boop
{ _: [], a: 'beep', b: 'boop' }
$ deno run ./examples/parse.ts -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' }

API

import parseArgs from 'https://deno.land/x/[email protected]/mod.ts';

parseArgs(Deno.args);

const argv = parseArgs(args, opts={})

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

argv._ contains all the arguments that didn't have an option 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._.

options can be:

  • opts.string - a string or array of strings argument names to always treat as strings

  • opts.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 - an object mapping string names to strings or arrays of string argument names to use as aliases

  • opts.default - an object mapping string argument names to default values

  • opts.stopEarly - when true, populate argv._ with everything after the first non-option

  • opts['--'] - when true, populate argv._ with everything before the -- and argv['--'] with everything after the --. Here's an example:

import parseArgs from 'https://deno.land/x/[email protected]/mod.ts';

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

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

  • opts.unknown - 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.

Relevant changes compared to minimist

  • An explicit TypeError is raised if the input is falsy.

  • --constructor option is supported.

  • Added few tests.

  • Improved accuracy and ergonomics of typescript types.

  • The returned payload is an object created using Object.create(null), hence does not have instance methods like toString:

import parseArgs from 'https://deno.land/x/[email protected]/mod.ts';

parse(Deno.args).toString(); // BAD - `TypeError: parse(...).toString is not a function`
parse(Deno.args) + "";       // BAD - `TypeError: parse(...).toString is not a function`

Object.prototype.toString.call(parse(Deno.args)); // OK `[object Object]`

JSON.stringify(parse(['--foo'])); // OK `{"_":[],"foo":true}`

Download Details:

Author: FaberVitale

Source Code: https://github.com/FaberVitale/deno_minimist

deno nodejs node javascript

Bootstrap 5 Complete Course with Examples

Bootstrap 5 Tutorial - Bootstrap 5 Crash Course for Beginners

Nest.JS Tutorial for Beginners

Hello Vue 3: A First Look at Vue 3 and the Composition API

Building a simple Applications with Vue 3

Deno Crash Course: Explore Deno and Create a full REST API with Deno

How to Build a Real-time Chat App with Deno and WebSockets

Convert HTML to Markdown Online

HTML entity encoder decoder Online

AEM Querybuilder for JavaScript (Browser, Node, Deno)

Helix Querybuilder .AEM Querybuilder for JavaScript (Browser, Node, Deno)

NKeys for JavaScript - Node.js, Browsers, and Deno

A public-key signature system based on Ed25519 for the NATS ecosystem system for JavaScript. The nkeys.js library works in Deno, Node.js, and the browser!

Javascript module for easily generating mazes,compatible with both Deno and Node

A work-in-progress Javascript maze generator module, compatible with both Deno and Node.

Deno Tutorial for Beginners: Deno vs. Node: Better Than NodeJS?

Deno is released, it’s time to find out if it can prove a worthy competition for Node.js. What is Deno? Why Deno can be considered an alternative to Node? The main differences between Deno and Node. Write a simple Deno app.

What is Deno? The Node.JS Killer? The Deno-minator to Node?

What is Deno? The Node.JS Killer? The Deno-minator to Node? Deno is the new hype and will it be better than node.js? Deno is a secure runtime for JavaScript and TypeScript that is based on the V8 JavaScript engine and the Rust programming language that addresses Node’s shortcomings