A package for handling argv.
npm install @lando/argvA 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
``bashWith npm
npm install @lando/argv
Usage
This module has two functions
hasOption and getOption.$3
Checks to see if a flag exists in
process.argv.`js
const argv = require('argv');// Will return Boolean
const hasDebug = argv.hasOption('--debug'));
`$3
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.`js
// File: myscript.js
const argv = require('argv');console.log(argv.getOption('--debug'));
`The above code will produce the following:
`bash
node myscript.js --debug
> truenode myscript.js --debug "trill"
> trill
hyperdrive list --debug=trill
> trill
`You also can replace the default Boolean value with the
defaultValue option.`js
// File: myscript.js
const argv = require('argv');console.log(argv.getOption('--debug', {defaultValue: 'the-truth-is-out-there'}));
``bash
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
`bash
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:
`bash
git clone https://github.com/lando/argv.git && cd argv
Install deps and get node
lando startRun commands
lando node
lando yarn
`Testing
`bash
Lint the code
yarn lintRun 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.Made with contributors-img.