Split argv(argument vector) and handle special cases, such as quoted values.
npm install argv-split
Split argv(argument vector) and handle special cases, such as quoted or escaped values.
``js
const split = require('split')
const mkdir = 'mkdir "foo bar"'
mkdir.split(' ') // ['mkdir', '"foo', 'bar"'] -> Oops!
split(mkdir) // ['mkdir', 'foo bar'] -> Oh yeah!
const mkdir2 = 'mkdir foo\\ bar'.split(' ')
mkdir2.split(' ') // ['mkdir', 'foo\\', 'bar'] -> Oops!
split(mkdir2) // ['mkdir', 'foo bar'] -> Oh yeah!
`
handles all special cases with complete unit tests.`shshell command: javascript array:
foo a\ b # ['foo', 'a b']
foo \' # ['foo', '\\\'']
foo \" # ['foo', '\\"']
foo "a b" # ['foo', 'a b']
foo "a\ b" # ['foo', 'a\\ b']
foo '\' # ['foo', '\\']
foo --abc="a b" # ['foo', '--abc=a b']
foo --abc=a\ b # ['foo', '--abc=a b']
js
split('foo \\\n --abc=a\\ b') // ['foo', '--abc=a b']
`Error Codes
$3
If a command missed the closing single quote, the error will throw:
Shell command:
sh
foo --abc 'abc
`js
try {
split('foo --abc \'abc')
} catch (e) {
console.log(e.code) // 'UNMATCHED_SINGLE'
}
`$3
If a command missed the closing double quote, the error will throw:
sh
foo --abc "abc
`$3
If a command unexpectedly ends with a
, the error will throw:`sh
foo --abc a\# if there is nothing after \, the error will throw
foo --abc a\ # if there is a whitespace after, then -> ['foo', '--abc', 'a ']
`$3
If the argument passed to
is not a string, the error will throw`js
split(undefined)
`Install
sh
$ npm i argv-split
`Methods
split(string) -> Array
Splits a string, and balance quoted parts. The usage is quite simple, see examples above.
Returns
split.join(args, options?) -> string
Join the given array of argument vectors into a valid argument string
New in
- args
arguments to be joined
- options? Object=
- quote should we use single quote or double quote when a certain argument needs to be quoted. Defaults to "js
'command ' + join(['foo "bar', "'baz"])// command "foo \"bar" "'baz"
`$3
There is a special value of
which could help us to create valid commands with line feeds:`js
'kubectl' + join(['apply', '--prune', '-f', 'manifest.yaml', split.LF, '-l', 'app=nginx'])// kubectl apply --prune -f manifest.yaml \
// -l app=nginx
``MIT