Idea to include global.argv / minimist?

[smeijer]

This library is a timesaver! What do you think of the idea to also add passed-in arguments to the global, using something like minimist?

The change:

global.argv = require('minimist')(process.argv.slice(2));

Run script:

$ zx sync.js --username smeijer

Usage:

let username = argv.username || await question('What is your username? ')

[rauschma]

Another argument parsing library to consider (I personally prefer it over minimist): https://github.com/vercel/arg

[antonmedv]

The problem with it what there are too many alternatives, and everybody wants a different one.

• yargs ~57M/week
• minimist ~41M/week
• arg ~7M/week
• meow ~15M/week
• countless others ~100M/week

[smeijer]

I was thinking about limiting the integration to expose the arguments under global.argv, in the most basic form. Arguments would be exposed as strings when a value was provided (zx script.js --username smeijer), or booleans when not (zx script.js -xyz). We could consider detecting numbers, and parsing those, but that already makes it tricky.

Whenever the user needs more (like support for --help, or type coercion), they can install their library of choice.

For this project, I think the best option would be the simplest/smallest library.

[mainrs]

We could consider detecting numbers, and parsing those, but that already makes it tricky.

No need for that. If a script uses the API it already knows if an argument should be a number. Stuff like that should be handled by the script writer. A simple string/boolean case should be enough.

Maybe instead of going for popularity of a parsing package one could argue that the smallest one with the fastest loading time might be the best to choose. Just another way to look at the discussion.

[smeijer]

My thoughts exactly

[ethanmick]

Using zx for the first time and really enjoying it. This use case just came up as I wanted to add a little more configuration for other users who may use it. A simple way to get flagged arguments would be very nice. Maybe some inspiration can be taken from the Go flag package; simple, and if people still need more power than can install another one.

[brandonpittman]

Another argument parsing library to consider (I personally prefer it over minimist): vercel/arg

arg is definitely the closest to the metal and inline with zx's vision.

[smeijer]

The difference I see between minimist and arg, is that minimist doesn't require any options/setup to be useful. While arg needs initialization.

As arg requires setup, one might as well just add the import statement as well.

[antonmedv]

Done! Minimist in v2.