jimmycuadra/shellwords

Manipulate strings according to the word parsing rules of the UNIX Bourne shell.

Shellwords

Shellwords provides functions to manipulate strings according to the word parsing rules of the UNIX Bourne shell. It is based on the Ruby module of the same name.

Installation

With npm:

npm install shellwords

With pnpm:

pnpm add shellwords

With Yarn:

yarn add shellwords

API

Shellwords exports the following functions, shown here in the TypeScript declaration file format.

/**
 * Splits a string into an array of tokens in the same way the UNIX Bourne shell does.
 *
 * @param line A string to split.
 * @returns An array of the split tokens.
 */
export declare const split: (line?: string) => string[];

/**
 * Escapes a string so that it can be safely used in a Bourne shell command line.
 *
 * @param str A string to escape.
 * @returns The escaped string.
 */
export declare const escape: (str?: string) => string;

Example

import { escape, split } from "shellwords";

split("foo 'bar baz'");
// ["foo", "bar baz"]

escape("What's up, yo?");
// 'What\\\'s\\ up,\\ yo\\?'

Legal

shellwords is released under the MIT license. See LICENSE.

shellwords's Issues

Lose slash on windows

var command = '"D:\work\arduino\git\ml_agent\avrdude/bin/avrdude" "-CD:\work\arduino\git\ml_agent\avrdude/etc/avrdude.conf" -v -patmega328p -carduino -PCOM7 -b115200 -D "-Uflash:w:D:\work\arduino\git\ml_agent\tmp/code.ino.hex:i"'
var args = shellwords.split(command);
args:
[ 'D:work\arduino\git\ml_agent\avrdude/bin/avrdude',
'-CD:work\arduino\git\ml_agent\avrdude/etc/avrdude.conf',
'-v',
'-patmega328p',
'-carduino',
'-PCOM7',
'-b115200',
'-D',
'-Uflash:w:D:work\arduino\git\ml_agent\tmp/code.ino.hex:i' ]

all the path lost the slash...

Please npm publish v0.1.1

v0.1.0...master

The license information added in 3650806, but it isn't available on npm.

Could you publish a new version like v0.1.1 to npm?

Windows compatibility

👋 Hi there, we're using shellwords in@effection/node and it's been really great so far. I noticed that the last major change to this was eight years ago. Amazing how software can keep going and going!

https://github.com/thefrontside/effection/blob/v0/packages/node/src/exec.ts#L18

Anyhow, we're looking to add Windows support to this library and noticed that shellwords, when splitting a command on windows removes all \ characters which is the path separator on windows. So, for example:

\Users\cowboyd\Code\bigtest\node_modules\.bin\ts-node is converted to UserscowboydCodebigtestnode_modules.bints-node`

I'd be happy to submit a PR to fix this if you'd be willing to release it. Alternatively, we'd also be happy to take over maintenance of this repository and npm package if you'd be willing to donate it. Let me know and thanks again!

Also support Shellwords.join which takes an array.

http://ruby-doc.org/stdlib-1.9.3/libdoc/shellwords/rdoc/Shellwords.html#method-c-shelljoin

Add license information in package.json

License information in package.json would be great as it would allow the package to be automatically imported in a company setting.