https://github.com/thiagodp/split-cmd

💦Split a command into an array or an object for using with spawn or execa
https://github.com/thiagodp/split-cmd

args argument child-process cli command exec execa node nodejs process spawn split

Last synced: about 2 months ago
JSON representation

💦Split a command into an array or an object for using with spawn or execa

• Host: GitHub
• URL: https://github.com/thiagodp/split-cmd
• Owner: thiagodp
• License: mit
• Created: 2018-06-11T10:46:13.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-12-21T02:01:12.000Z (about 1 year ago)
• Last Synced: 2024-10-30T17:11:58.457Z (about 2 months ago)
• Topics: args, argument, child-process, cli, command, exec, execa, node, nodejs, process, spawn, split
• Language: JavaScript
• Homepage:
• Size: 155 KB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![npm (tag)](https://img.shields.io/npm/v/split-cmd?color=green&label=NPM&style=for-the-badge)](https://github.com/thiagodp/split-cmd/releases)

[![Build Status](https://img.shields.io/github/actions/workflow/status/thiagodp/split-cmd/test.yml?style=for-the-badge)](https://github.com/thiagodp/split-cmd/actions)

[![License](https://img.shields.io/npm/l/split-cmd.svg?style=for-the-badge&color=green)](https://github.com/thiagodp/split-cmd/blob/master/LICENSE.txt)

[![npm](https://img.shields.io/npm/dt/split-cmd?style=for-the-badge&color=green)](https://www.npmjs.com/package/split-cmd)

# split-cmd

> 💦 Split a command into an array or an object

Useful for splitting a command to use with NodeJS' [child process](https://nodejs.org/api/child_process.html) methods, like [spawn](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options), [exec](https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback), and [execFile](https://nodejs.org/api/child_process.html#child_process_child_process_execfile_file_args_options_callback), as well with libs like [execa](https://github.com/sindresorhus/execa).

⚡ Just 0.4 KB uncompressed, no external dependencies.

🎯 Version `1.1`+ works with NodeJS, DenoJS and browsers. JavaScript and TypeScript.

## Installation

```bash

npm i split-cmd

```

## Usage

### Splitting into an array

```js

import { split } from 'split-cmd';

const arr = split( 'git commit -m "some message with spaces"' );

console.log( arr ); // [ "git", "commit", "-m", "some message with spaces" ]

```

### Splitting into an object

```js

import { splitToObject } from 'split-cmd';

const obj = splitToObject( 'git commit -m "some message with spaces"' );

console.log( obj.command ); // git

console.log( obj.args ); // [ "commit", "-m", "some message with spaces" ]

```

### Using it with execa

```js

import { splitToObject } from 'split-cmd';

import { execa } from 'execa';

// Executing a single command

const obj = splitToObject( 'echo "I see unicorns"' );

execa( obj.command, obj.args )

    .then( result => console.log( result.stdout ) ) // I see unicorns

    .catch( error => console.log( error ) );

// Executing multiple commands in batch

[

    'echo "I see unicorns"',

    'mkdir foo',

    'touch foo/bar.txt'

]

.map( s => splitToObject( s ) )

.forEach( obj => {

    execa( obj.command, obj.args )

        .then( result => console.log( result.stdout ) )

        .catch( error => console.log( error ) );

} );

```

## API

```js

/**

 * Split a command into an array.

 *

 * @param {string} command Command to split.

 * @returns {Array}

 */

split( command: string ): string[]

/**

 * Split a command into an object with the attributes `command` and `args`.

 *

 *

 * @param {string} command Command to split.

 * @returns {object}

 */

splitToObject( command: string ): { command?: string, args?: string[] }

```

## License

MIT © [Thiago Delgado Pinto](https://github.com/thiagodp)