Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Readme
argv
is a simple, zero dependency, command line argument parser for NodeJS. For a more feature-full CLI parser, checkout Commander.js or Yargs
$ npm install argv
var argv = require( 'argv' );
var args = argv.option( options ).run();
-> { targets: [], options: {} }
Runs the argument parser on the global arguments. Custom arguments array can be used by passing into this method
// Parses default arguments 'process.argv.slice( 2 )'
argv.run();
// Parses array instead
argv.run(["--option=123", "-o", "123"]);
argv
is a strict argument parser, which means all options must be defined before parsing starts.
argv.option({
name: "option",
short: "o",
type: "string",
description: "Defines an option for your script",
example: "'script --option=value' or 'script -o value'",
onset: function (args) {
args; // Object of current arguments parsed
},
});
Modules are nested commands for more complicated scripts. Each module has it's own set of options that have to be defined independently of the root options.
argv.mod({
mod: 'module',
description: 'Description of what the module is used for',
options: [ list of options ]
});
Types convert option values to useful JS objects. They are defined along with each option.
string
: Ensure values are stringspath
: Converts value into a fully resolved path.integer | int
: Converts value into an integerfloat
: Converts value into a float numberboolean | bool
: Converts value into a boolean object. 'true' and '1' are converted to true, everything else is false.csv
: Converts value into an array by splitting on comma's.list
: Allows for option to be defined multiple times, and each value added to an array[list|csv],[type]
: Combo type that allows you to create a list or csv and convert each individual value into a type.argv.option([
{
name: 'option',
type: 'csv,int'
},
{
name: 'path',
short: 'p',
type: 'list,path'
}
]);
// csv and int combo
$ script --option=123,456.001,789.01
-> option: [ 123, 456, 789 ]
// list and path combo
$ script -p /path/to/file1 -p /path/to/file2
-> option: [ '/path/to/file1', '/path/to/file2' ]
You can also create your own custom type for special conversions.
argv.type( 'squared', function( value ) {
value = parseFloat( value );
return value * value;
});
argv.option({
name: 'square',
short: 's',
type: 'squared'
});
$ script -s 2
-> 4
Defining the scripts version number will add the version option and print it out when asked.
argv.version( 'v1.0' );
$ script --version
v1.0
Custom information can be displayed at the top of the help printout using this method
argv.info( 'Special script info' );
$ script --help
Special script info
... Rest of Help Doc ...
If you have competing scripts accessing the argv
object, you can clear out any previous options that may have been set.
argv.clear().option([new options()]);
argv
injects a default help option initially and on clears. The help() method triggers the help printout.
argv.help();
FAQs
CLI Argument Parser
The npm package argv receives a total of 310,466 weekly downloads. As such, argv popularity was classified as popular.
We found that argv demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.