source: trip-planner-front/node_modules/cross-spawn/README.md@ 6a3a178

Last change on this file since 6a3a178 was 6a3a178, checked in by Ema <ema_spirova@…>, 3 years ago

initial commit

  • Property mode set to 100644
File size: 4.7 KB
Line 
1# cross-spawn
2
3[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Build status][appveyor-image]][appveyor-url] [![Coverage Status][codecov-image]][codecov-url] [![Dependency status][david-dm-image]][david-dm-url] [![Dev Dependency status][david-dm-dev-image]][david-dm-dev-url] [![Greenkeeper badge][greenkeeper-image]][greenkeeper-url]
4
5[npm-url]:https://npmjs.org/package/cross-spawn
6[downloads-image]:http://img.shields.io/npm/dm/cross-spawn.svg
7[npm-image]:http://img.shields.io/npm/v/cross-spawn.svg
8[travis-url]:https://travis-ci.org/moxystudio/node-cross-spawn
9[travis-image]:http://img.shields.io/travis/moxystudio/node-cross-spawn/master.svg
10[appveyor-url]:https://ci.appveyor.com/project/satazor/node-cross-spawn
11[appveyor-image]:https://img.shields.io/appveyor/ci/satazor/node-cross-spawn/master.svg
12[codecov-url]:https://codecov.io/gh/moxystudio/node-cross-spawn
13[codecov-image]:https://img.shields.io/codecov/c/github/moxystudio/node-cross-spawn/master.svg
14[david-dm-url]:https://david-dm.org/moxystudio/node-cross-spawn
15[david-dm-image]:https://img.shields.io/david/moxystudio/node-cross-spawn.svg
16[david-dm-dev-url]:https://david-dm.org/moxystudio/node-cross-spawn?type=dev
17[david-dm-dev-image]:https://img.shields.io/david/dev/moxystudio/node-cross-spawn.svg
18[greenkeeper-image]:https://badges.greenkeeper.io/moxystudio/node-cross-spawn.svg
19[greenkeeper-url]:https://greenkeeper.io/
20
21A cross platform solution to node's spawn and spawnSync.
22
23
24## Installation
25
26`$ npm install cross-spawn`
27
28
29## Why
30
31Node has issues when using spawn on Windows:
32
33- It ignores [PATHEXT](https://github.com/joyent/node/issues/2318)
34- It does not support [shebangs](https://en.wikipedia.org/wiki/Shebang_(Unix))
35- Has problems running commands with [spaces](https://github.com/nodejs/node/issues/7367)
36- Has problems running commands with posix relative paths (e.g.: `./my-folder/my-executable`)
37- Has an [issue](https://github.com/moxystudio/node-cross-spawn/issues/82) with command shims (files in `node_modules/.bin/`), where arguments with quotes and parenthesis would result in [invalid syntax error](https://github.com/moxystudio/node-cross-spawn/blob/e77b8f22a416db46b6196767bcd35601d7e11d54/test/index.test.js#L149)
38- No `options.shell` support on node `<v4.8`
39
40All these issues are handled correctly by `cross-spawn`.
41There are some known modules, such as [win-spawn](https://github.com/ForbesLindesay/win-spawn), that try to solve this but they are either broken or provide faulty escaping of shell arguments.
42
43
44## Usage
45
46Exactly the same way as node's [`spawn`](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options) or [`spawnSync`](https://nodejs.org/api/child_process.html#child_process_child_process_spawnsync_command_args_options), so it's a drop in replacement.
47
48
49```js
50const spawn = require('cross-spawn');
51
52// Spawn NPM asynchronously
53const child = spawn('npm', ['list', '-g', '-depth', '0'], { stdio: 'inherit' });
54
55// Spawn NPM synchronously
56const result = spawn.sync('npm', ['list', '-g', '-depth', '0'], { stdio: 'inherit' });
57```
58
59
60## Caveats
61
62### Using `options.shell` as an alternative to `cross-spawn`
63
64Starting from node `v4.8`, `spawn` has a `shell` option that allows you run commands from within a shell. This new option solves
65the [PATHEXT](https://github.com/joyent/node/issues/2318) issue but:
66
67- It's not supported in node `<v4.8`
68- You must manually escape the command and arguments which is very error prone, specially when passing user input
69- There are a lot of other unresolved issues from the [Why](#why) section that you must take into account
70
71If you are using the `shell` option to spawn a command in a cross platform way, consider using `cross-spawn` instead. You have been warned.
72
73### `options.shell` support
74
75While `cross-spawn` adds support for `options.shell` in node `<v4.8`, all of its enhancements are disabled.
76
77This mimics the Node.js behavior. More specifically, the command and its arguments will not be automatically escaped nor shebang support will be offered. This is by design because if you are using `options.shell` you are probably targeting a specific platform anyway and you don't want things to get into your way.
78
79### Shebangs support
80
81While `cross-spawn` handles shebangs on Windows, its support is limited. More specifically, it just supports `#!/usr/bin/env <program>` where `<program>` must not contain any arguments.
82If you would like to have the shebang support improved, feel free to contribute via a pull-request.
83
84Remember to always test your code on Windows!
85
86
87## Tests
88
89`$ npm test`
90`$ npm test -- --watch` during development
91
92## License
93
94Released under the [MIT License](http://www.opensource.org/licenses/mit-license.php).
Note: See TracBrowser for help on using the repository browser.