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.

1/**
2 * Splits a string into an array of tokens in the same way the UNIX Bourne shell does.
3 *
4 * @param line A string to split.
5 * @returns An array of the split tokens.
6 */
7export declare const split: (line?: string) => string[];
8
9/**
10 * Escapes a string so that it can be safely used in a Bourne shell command line.
11 *
12 * @param str A string to escape.
13 * @returns The escaped string.
14 */
15export declare const escape: (str?: string) => string;
16
17/**
18 * Builds a command line string from an argument list.
19 *
20 * @param array An array of string arguments.
21 * @returns The command line string.
22 */
23export const join = (array: string[]) => string;

Example

1import { escape, split, join } from "shellwords";
2
3split("foo 'bar baz'");
4// ["foo", "bar baz"]
5
6escape("What's up, yo?");
7// 'What\\\'s\\ up,\\ yo\\?'
8
9join(["What's", "up,", "gang?");
10// 'What\\\'s up, gang\\?'

Legal

shellwords is released under the MIT license. See LICENSE.