options-to-spawn-args v2.1.1

options-to-spawn-args

Converts an options object to an array suitable for passing to child_process.spawn().

• Single letter object properties (e.g. c: "red") convert to short-option args (e.g. -c red).
• Longer object properties (e.g. colour: "red") convert to long-option args (e.g. --colour red).
• Object property values equalling true convert to flags (e.g. -l).
• Object property values containing white spaces get auto quoted (e.g. c: "hello world") convert to (e.g. -c "hello world").

This options object:

const options = {
    o: true,
    t: "hello",
    three: "world",
    four: true
}

converts to

[ "-o", "-t", "hello", "--three", "world", "--four" ]

Installation

$ npm install options-to-spawn-args --save

Usage

import toSpawnArgs from 'options-to-spawn-args';
import { spawn } from 'child_process';

const options = {
    l: true,
    a: true
};

spawn('ls', toSpawnArgs(options), { stdio: 'inherit' });

Options

prefix [string|function]=standard

Example

const options = { resize: '50%', r: '100%' }

toSpawnArgs(options, { prefix: '-' }) // [ '-resize', '50%', '-r', '100%' ]
toSpawnArgs(options, { prefix: item => item.length > 1 ? '++' : '--' }) // [ '++resize', '50%', '--r', '100%' ]

equal [boolean]=false

Example

const options = { resize: '50%' }

toSpawnArgs(options, { equal: true }) // [ '--resize=50%' ]

quote [boolean]=false

Example

const options = { resize: '50%', demo: 10 }

toSpawnArgs(options, { quote: true }) // [ '--resize', '"50%"', '--demo', '"10"' ]

License

MIT