Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

shlex

1.0.3 • Public • Published

node-shlex

Build Status

node-shlex is a Node.js module for quoting and parsing shell commands.

The API was inspired by the shlex module from the Python Standard Library. However, the Python implementation is fairly complex, and supports a confusing matrix of modes that is not replicated here. node-shlex always operates in what the Python module calls "POSIX mode."

An existing module, node-shell-quote, has numerous quality issues and seems to be abandoned. However, note that node-shlex does not attempt to split on or otherwise parse operators (such as 2>/dev/null), and it does not perform variable interpolation.

Usage

shlex.quote()

var quote = require("shlex").quote
quote("abc")      // returns: abc
quote("abc def")  // returns: 'abc def'
quote("can't")    // returns: 'can'"'"'t'

shlex.split()

var split = require("shlex").split
split('ls -al /')  // returns: [ 'ls', '-al', '/' ]
split('rm -f "/Volumes/Macintosh HD"')  // returns [ 'rm', '-f', '/Volumes/Macintosh HD' ]

install

npm i shlex

Downloadsweekly downloads

2

version

1.0.3

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability