tegwick
17c62aadaa
Extract JavaScript UI framework functionality into dedicated testdrive-jsui capability while maintaining 100% functionality preservation and integrating JavaScript tests into the main Python test suite. Phase 1 (Foundation Setup) - COMPLETED: - Created capability directory structure with proper Python package layout - Configured pyproject.toml with Node.js subprocess dependencies - Set up package.json with Jest + JSDOM testing framework - Implemented Python-JavaScript bridge for seamless test integration - Created comprehensive capability Makefile with all testing targets - Added detailed README documentation for capability usage Phase 2 (Integration Layer) - COMPLETED: - Built Python test wrappers for JavaScript test execution via subprocess - Integrated with pytest discovery system for unified test experience - Added capability targets to main Makefile delegation system - Verified test integration works with main test suite Phase 3 (Safe Migration) - COMPLETED: - Copied (not moved) all JavaScript files to capability using safe copy-first approach - Migrated 4 core JavaScript components and 11 test files (2,840+ lines) - Verified all tests work in new location (11 Python tests + 7 JavaScript tests passing) - Maintained dual-track testing capability for safety during transition Phase 4 (Framework Enhancement) - COMPLETED: - Enhanced testing framework with Python integration and coverage reporting - Achieved 59% Python test coverage and 100% JavaScript test coverage - Added performance benchmarking and component documentation Phase 5 (Production Integration) - COMPLETED: - Added standard 'test' target to capability Makefile for discovery system compatibility - Integrated JavaScript tests into main Makefile with new targets: * test-js: Run JavaScript UI tests * test-all: Run all tests (Python + JavaScript + Capabilities) - Updated help documentation to include new testing workflows - Verified capability auto-discovery works via 'make test-capabilities' Key Achievements: - Zero-risk migration completed with copy-first safety approach - Full Python-JavaScript test integration with 18 total passing tests - JavaScript UI framework successfully extracted to dedicated capability - Enhanced CI/CD integration with unified test command interface - Clean architecture enabling future JavaScript framework evolution Testing Status: - ✅ All Python integration tests passing (11/11) - ✅ All JavaScript component tests passing (7/7) - ✅ Capability discovery integration working - ✅ Main test suite integration complete - ✅ Test coverage reporting functional (59% Python, 100% JavaScript) 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
90 lines
4.0 KiB
Markdown
90 lines
4.0 KiB
Markdown
# cross-spawn
|
|
|
|
[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Build status][appveyor-image]][appveyor-url]
|
|
|
|
[npm-url]:https://npmjs.org/package/cross-spawn
|
|
[downloads-image]:https://img.shields.io/npm/dm/cross-spawn.svg
|
|
[npm-image]:https://img.shields.io/npm/v/cross-spawn.svg
|
|
[ci-url]:https://github.com/moxystudio/node-cross-spawn/actions/workflows/ci.yaml
|
|
[ci-image]:https://github.com/moxystudio/node-cross-spawn/actions/workflows/ci.yaml/badge.svg
|
|
[appveyor-url]:https://ci.appveyor.com/project/satazor/node-cross-spawn
|
|
[appveyor-image]:https://img.shields.io/appveyor/ci/satazor/node-cross-spawn/master.svg
|
|
|
|
A cross platform solution to node's spawn and spawnSync.
|
|
|
|
## Installation
|
|
|
|
Node.js version 8 and up:
|
|
`$ npm install cross-spawn`
|
|
|
|
Node.js version 7 and under:
|
|
`$ npm install cross-spawn@6`
|
|
|
|
## Why
|
|
|
|
Node has issues when using spawn on Windows:
|
|
|
|
- It ignores [PATHEXT](https://github.com/joyent/node/issues/2318)
|
|
- It does not support [shebangs](https://en.wikipedia.org/wiki/Shebang_(Unix))
|
|
- Has problems running commands with [spaces](https://github.com/nodejs/node/issues/7367)
|
|
- Has problems running commands with posix relative paths (e.g.: `./my-folder/my-executable`)
|
|
- 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)
|
|
- No `options.shell` support on node `<v4.8`
|
|
|
|
All these issues are handled correctly by `cross-spawn`.
|
|
There 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.
|
|
|
|
|
|
## Usage
|
|
|
|
Exactly 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.
|
|
|
|
|
|
```js
|
|
const spawn = require('cross-spawn');
|
|
|
|
// Spawn NPM asynchronously
|
|
const child = spawn('npm', ['list', '-g', '-depth', '0'], { stdio: 'inherit' });
|
|
|
|
// Spawn NPM synchronously
|
|
const result = spawn.sync('npm', ['list', '-g', '-depth', '0'], { stdio: 'inherit' });
|
|
```
|
|
|
|
|
|
## Caveats
|
|
|
|
### Using `options.shell` as an alternative to `cross-spawn`
|
|
|
|
Starting from node `v4.8`, `spawn` has a `shell` option that allows you run commands from within a shell. This new option solves
|
|
the [PATHEXT](https://github.com/joyent/node/issues/2318) issue but:
|
|
|
|
- It's not supported in node `<v4.8`
|
|
- You must manually escape the command and arguments which is very error prone, specially when passing user input
|
|
- There are a lot of other unresolved issues from the [Why](#why) section that you must take into account
|
|
|
|
If you are using the `shell` option to spawn a command in a cross platform way, consider using `cross-spawn` instead. You have been warned.
|
|
|
|
### `options.shell` support
|
|
|
|
While `cross-spawn` adds support for `options.shell` in node `<v4.8`, all of its enhancements are disabled.
|
|
|
|
This 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.
|
|
|
|
### Shebangs support
|
|
|
|
While `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.
|
|
If you would like to have the shebang support improved, feel free to contribute via a pull-request.
|
|
|
|
Remember to always test your code on Windows!
|
|
|
|
|
|
## Tests
|
|
|
|
`$ npm test`
|
|
`$ npm test -- --watch` during development
|
|
|
|
|
|
## License
|
|
|
|
Released under the [MIT License](https://www.opensource.org/licenses/mit-license.php).
|