basant307/AI_Governance_Project

1# cross-spawn2 3[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Build status][appveyor-image]][appveyor-url]4 5[npm-url]:https://npmjs.org/package/cross-spawn6[downloads-image]:https://img.shields.io/npm/dm/cross-spawn.svg7[npm-image]:https://img.shields.io/npm/v/cross-spawn.svg8[ci-url]:https://github.com/moxystudio/node-cross-spawn/actions/workflows/ci.yaml9[ci-image]:https://github.com/moxystudio/node-cross-spawn/actions/workflows/ci.yaml/badge.svg10[appveyor-url]:https://ci.appveyor.com/project/satazor/node-cross-spawn11[appveyor-image]:https://img.shields.io/appveyor/ci/satazor/node-cross-spawn/master.svg12 13A cross platform solution to node's spawn and spawnSync.14 15## Installation16 17Node.js version 8 and up:18`$ npm install cross-spawn`19 20Node.js version 7 and under:21`$ npm install cross-spawn@6`22 23## Why24 25Node has issues when using spawn on Windows:26 27- It ignores [PATHEXT](https://github.com/joyent/node/issues/2318)28- It does not support [shebangs](https://en.wikipedia.org/wiki/Shebang_(Unix))29- Has problems running commands with [spaces](https://github.com/nodejs/node/issues/7367)30- Has problems running commands with posix relative paths (e.g.: `./my-folder/my-executable`)31- 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)32- No `options.shell` support on node `<v4.8`33 34All these issues are handled correctly by `cross-spawn`.35There 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.36 37 38## Usage39 40Exactly 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.41 42 43```js44const spawn = require('cross-spawn');45 46// Spawn NPM asynchronously47const child = spawn('npm', ['list', '-g', '-depth', '0'], { stdio: 'inherit' });48 49// Spawn NPM synchronously50const result = spawn.sync('npm', ['list', '-g', '-depth', '0'], { stdio: 'inherit' });51```52 53 54## Caveats55 56### Using `options.shell` as an alternative to `cross-spawn`57 58Starting from node `v4.8`, `spawn` has a `shell` option that allows you run commands from within a shell. This new option solves59the [PATHEXT](https://github.com/joyent/node/issues/2318) issue but:60 61- It's not supported in node `<v4.8`62- You must manually escape the command and arguments which is very error prone, specially when passing user input63- There are a lot of other unresolved issues from the [Why](#why) section that you must take into account64 65If you are using the `shell` option to spawn a command in a cross platform way, consider using `cross-spawn` instead. You have been warned.66 67### `options.shell` support68 69While `cross-spawn` adds support for `options.shell` in node `<v4.8`, all of its enhancements are disabled.70 71This 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.72 73### Shebangs support74 75While `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.   76If you would like to have the shebang support improved, feel free to contribute via a pull-request.77 78Remember to always test your code on Windows!79 80 81## Tests82 83`$ npm test`   84`$ npm test -- --watch` during development85 86 87## License88 89Released under the [MIT License](https://www.opensource.org/licenses/mit-license.php).90