545563e776
- Complete NestJS TypeScript implementation with WebSocket support - Direct messaging (DM) and group chat functionality - End-to-end encryption with AES encryption and key pairs - Media file support (images, videos, audio, documents) up to 100MB - Push notifications with Firebase Cloud Messaging integration - Mention alerts and real-time typing indicators - User authentication with JWT and Passport - SQLite database with TypeORM entities and relationships - Comprehensive API documentation with Swagger/OpenAPI - File upload handling with secure access control - Online/offline status tracking and presence management - Message editing, deletion, and reply functionality - Notification management with automatic cleanup - Health check endpoint for monitoring - CORS configuration for cross-origin requests - Environment-based configuration management - Structured for Flutter SDK integration Features implemented: ✅ Real-time messaging with Socket.IO ✅ User registration and authentication ✅ Direct messages and group chats ✅ Media file uploads and management ✅ End-to-end encryption ✅ Push notifications ✅ Mention alerts ✅ Typing indicators ✅ Message read receipts ✅ Online status tracking ✅ File access control ✅ Comprehensive API documentation Ready for Flutter SDK development and production deployment.
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).
|