@lando/argv

ARGV

A very simple module called argv that allows you to:

• Check whether certain flags exist in process.argv
• Get the value of a flag in process.argv

Installation

# With npm
npm install @lando/argv

# With yarn
yarn add @lando/argv

Usage

This module has two functions hasOption and getOption.

hasOption

Checks to see if a flag exists in process.argv.

const argv = require('argv');

// Will return Boolean
const hasDebug = argv.hasOption('--debug'));

getOption

Returns the value of the flag. If the flag is a switch then it will return true|false by default. If the flag has a string value it will return that string value.

// File: myscript.js
const argv = require('argv');

console.log(argv.getOption('--debug'));

The above code will produce the following:

node myscript.js --debug
> true

node myscript.js --debug "trill"
> trill

hyperdrive list --debug=trill
> trill

You also can replace the default Boolean value with the defaultValue option.

// File: myscript.js
const argv = require('argv');

console.log(argv.getOption('--debug', {defaultValue: 'the-truth-is-out-there'}));

node myscript.js --debug
> the-truth-is-out-there

Issues, Questions and Support

If you have a question or would like some community support we recommend you join us on Slack. Note that this is the Slack community for Lando but we are more than happy to help with this module as well!

If you'd like to report a bug or submit a feature request then please use the issue queue in this repo.

Changelog

We try to log all changes big and small in both THE CHANGELOG and the release notes.

Development

• Requires Node 14+
• Prefers Yarn

git clone https://github.com/lando/argv.git && cd argv
yarn install

If you dont' want to install Node 14 or Yarn for whatever reason you can install Lando and use that:

git clone https://github.com/lando/argv.git && cd argv
# Install deps and get node
lando start

# Run commands
lando node
lando yarn

Testing

# Lint the code
yarn lint

# Run unit tests
yarn test

Releasing

To deploy and publish a new version of the package to the npm registry you need only create a release on GitHub with a semver tag.

Note that prereleases will get pushed to the edge tag on the npm registry.

Contributors

Made with contributors-img.

Other Resources

• Important advice