Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

command-join

seangenabe59.8kMIT3.0.0TypeScript support: included

Escape and join command-line arguments, cross-platform.

argv, cli, command, escape, join, shell

readme

command-join

Escape command-line arguments, cross-platform.

npm Build Status devDependency Status node

If you like this package, be sure to star its repo, and please consider donating.

Usage

import { commandJoin } from "command-join"

commandJoin(arg: string | string[]): string

Escapes each command-line argument and joins them into a string that can then be executed, e.g. via child_process.exec.

If a string is passed, an array containing the string will instead be processed.

Example

const command = commandJoin(['a', "b\\", "'c"])
command
// output on Windows: a "b\\" 'c
// output on Linux: a 'b\' \'c

See the tests for more convoluted examples.

Migrating

Migrating to v3:

- const commandJoin = require("command-join")
+ const { commandJoin } = require("command-join")