JSPM

argv-formatter

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1075847
  • Score
    100M100P100Q197416F
  • License MIT

Bizarro minimist: transform an options object into argv

Package Exports

  • argv-formatter

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (argv-formatter) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

argv-formatter

Bizarro minimist: transform an options object into into a process.argv-like array. Helpful for using child_process and passing complex arguments more easily.

Setup

$ npm install --save argv-formatter

API

formatter.format(object) -> Array

Accepts an object of containing options and arguments and returns an array of arguments.

  • options with a value of true will be included with a flag only ({R: true} -> ['-R'])
  • options that are falsey will be removed
  • all values will be stringified, ({D: new Date(0)} -> ['-D', 'Thurs Jan 1 1970...'])
  • arguments can be passed under the _ key as a value or array of values

Examples

To generate arguments to a git log command for printing the short hashes of commits that have changed our test files:

var args = formatter.format({
  _: './test/*',
  format: '%h'
});
console.log(args.join(' ')); // --format=%h ./test/*

git-log-parser uses this to spawn a git process:

var spawn     = require('child_process').spawn;
var formatter = require('argv-formatter');
var args      = formatter.format(options);
var child     = spawn('git', ['log'].concat(args));