feat: wcag-compliance tests
parent
3725ce76f3
commit
56afd8465f
@ -0,0 +1 @@
|
|||||||
|
package-lock=false
|
@ -0,0 +1,17 @@
|
|||||||
|
### 📄 Doc
|
||||||
|
|
||||||
|
This program tests how compliant Catppuccin's variants are with WCAG standards. The test looks like this: ever color is put on top of the `base` color of the palette with a font size of 15; colors from `subtext0` up are expected to be acceptable. In the case of the dark palettes, they should meet Level AA requirements. As for the light palette, however, they must meet a contrast ratio greater than `2.314159265359`.
|
||||||
|
|
||||||
|
#### Dev
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# clone this repo
|
||||||
|
npm install # fetch all dependencies
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Testing
|
||||||
|
|
||||||
|
```sh
|
||||||
|
npm start
|
||||||
|
|
||||||
|
```
|
@ -0,0 +1,104 @@
|
|||||||
|
import {variants, labels} from '@catppuccin/palette'
|
||||||
|
import ColorContrastChecker from "color-contrast-checker"
|
||||||
|
import chalk from "chalk"
|
||||||
|
var ccc = new ColorContrastChecker();
|
||||||
|
|
||||||
|
const FONT_SIZE = 15
|
||||||
|
const LATTE_CONTRAST_RATIO = 2.314159265359
|
||||||
|
|
||||||
|
|
||||||
|
function write(msg) {
|
||||||
|
process.stdout.write(msg)
|
||||||
|
}
|
||||||
|
|
||||||
|
function get_tabs(str) {
|
||||||
|
if (str.length > 6) {
|
||||||
|
return '\t'
|
||||||
|
}
|
||||||
|
return '\t\t'
|
||||||
|
}
|
||||||
|
|
||||||
|
function get_rgb(c) {
|
||||||
|
return parseInt(c, 16) || c
|
||||||
|
}
|
||||||
|
|
||||||
|
function gets_rgb(c) {
|
||||||
|
return get_rgb(c) / 255 <= 0.03928
|
||||||
|
? get_rgb(c) / 255 / 12.92
|
||||||
|
: Math.pow((get_rgb(c) / 255 + 0.055) / 1.055, 2.4)
|
||||||
|
}
|
||||||
|
|
||||||
|
function get_luminance(hexColor) {
|
||||||
|
return (
|
||||||
|
0.2126 * gets_rgb(hexColor.substr(1, 2)) +
|
||||||
|
0.7152 * gets_rgb(hexColor.substr(3, 2)) +
|
||||||
|
0.0722 * gets_rgb(hexColor.substr(-2))
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
function get_contrast(f, b) {
|
||||||
|
const L1 = get_luminance(f)
|
||||||
|
const L2 = get_luminance(b)
|
||||||
|
return (Math.max(L1, L2) + 0.05) / (Math.min(L1, L2) + 0.05)
|
||||||
|
}
|
||||||
|
|
||||||
|
function get_text_color(bg_color, preferred_white, preffered_black) {
|
||||||
|
let white = preferred_white ? preferred_white : '#ffffff'
|
||||||
|
let black = preffered_black ? preffered_black : '#000000'
|
||||||
|
const whiteContrast = get_contrast(bg_color, white)
|
||||||
|
const blackContrast = get_contrast(bg_color, black)
|
||||||
|
|
||||||
|
return whiteContrast > blackContrast ? white : black
|
||||||
|
}
|
||||||
|
|
||||||
|
function print_color(text, background, preferred_white, preffered_black) {
|
||||||
|
write(
|
||||||
|
chalk.bgHex(background)(
|
||||||
|
chalk.hex(
|
||||||
|
get_text_color(background, preferred_white, preffered_black)
|
||||||
|
)(text)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
function good_contrast(base, label_color, custom_ratio) {
|
||||||
|
|
||||||
|
let good_contrast_ratio = ccc.isLevelAA(base, label_color, FONT_SIZE)
|
||||||
|
|
||||||
|
if (custom_ratio) {
|
||||||
|
good_contrast_ratio = ccc.isLevelCustom(base, label_color, custom_ratio)
|
||||||
|
}
|
||||||
|
|
||||||
|
if (good_contrast_ratio) {
|
||||||
|
return "✅"
|
||||||
|
} else {
|
||||||
|
return "❌"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function get_symbol_space(str) {
|
||||||
|
if (str.length < 8) {
|
||||||
|
return '\t' + ' '.repeat(2)
|
||||||
|
} else if (str.length == 8) {
|
||||||
|
return ' '
|
||||||
|
}
|
||||||
|
return ' '
|
||||||
|
}
|
||||||
|
|
||||||
|
write(chalk.hex('#fff')('|Latte|\t\t|Frappe|\t|Macchiato|\t|Moccha|\n\n'))
|
||||||
|
for (let label in labels) {
|
||||||
|
for (let palette in variants) {
|
||||||
|
let label_color = variants[palette][label]["hex"]
|
||||||
|
let base = variants[palette]["base"]["hex"]
|
||||||
|
var symbol_space = get_symbol_space(label)
|
||||||
|
let good_contrast_ratio = good_contrast(base, label_color)
|
||||||
|
|
||||||
|
if (palette == "latte") {
|
||||||
|
good_contrast_ratio = good_contrast(base, label_color, LATTE_CONTRAST_RATIO)
|
||||||
|
}
|
||||||
|
|
||||||
|
print_color(label, base, label_color, label_color)
|
||||||
|
write(symbol_space + good_contrast_ratio + "\t")
|
||||||
|
}
|
||||||
|
console.log('')
|
||||||
|
}
|
@ -1 +0,0 @@
|
|||||||
../which/bin/node-which
|
|
@ -1,195 +1,30 @@
|
|||||||
{
|
{
|
||||||
"name": "wcag-compliance",
|
|
||||||
"version": "0.1.0",
|
|
||||||
"lockfileVersion": 2,
|
"lockfileVersion": 2,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"node_modules/color-contrast-checker": {
|
"node_modules/@catppuccin/palette": {
|
||||||
"version": "2.1.0",
|
"version": "0.1.2",
|
||||||
"resolved": "https://registry.npmjs.org/color-contrast-checker/-/color-contrast-checker-2.1.0.tgz",
|
"resolved": "https://registry.npmjs.org/@catppuccin/palette/-/palette-0.1.2.tgz",
|
||||||
"integrity": "sha512-6Y0aIEej3pwZTVlicIqVzhO6T4izDWouaIXnYoDdTuFFAMQ9nnN0dgHNP9J94jRnH6asjPq1/wzUKxwoNbWtRQ=="
|
"integrity": "sha512-5Gt/goIgHAKjQtMqYhMJeoUWXj5d0HNai3gOPRzDVuz6V4ptTbnSxRyyooOY5OnYn/p0YLEtED/K0JvJPan9Aw==",
|
||||||
},
|
"dev": true
|
||||||
"node_modules/cross-spawn": {
|
|
||||||
"version": "7.0.3",
|
|
||||||
"resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz",
|
|
||||||
"integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==",
|
|
||||||
"dependencies": {
|
|
||||||
"path-key": "^3.1.0",
|
|
||||||
"shebang-command": "^2.0.0",
|
|
||||||
"which": "^2.0.1"
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": ">= 8"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/execa": {
|
|
||||||
"version": "6.1.0",
|
|
||||||
"resolved": "https://registry.npmjs.org/execa/-/execa-6.1.0.tgz",
|
|
||||||
"integrity": "sha512-QVWlX2e50heYJcCPG0iWtf8r0xjEYfz/OYLGDYH+IyjWezzPNxz63qNFOu0l4YftGWuizFVZHHs8PrLU5p2IDA==",
|
|
||||||
"dependencies": {
|
|
||||||
"cross-spawn": "^7.0.3",
|
|
||||||
"get-stream": "^6.0.1",
|
|
||||||
"human-signals": "^3.0.1",
|
|
||||||
"is-stream": "^3.0.0",
|
|
||||||
"merge-stream": "^2.0.0",
|
|
||||||
"npm-run-path": "^5.1.0",
|
|
||||||
"onetime": "^6.0.0",
|
|
||||||
"signal-exit": "^3.0.7",
|
|
||||||
"strip-final-newline": "^3.0.0"
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": "^12.20.0 || ^14.13.1 || >=16.0.0"
|
|
||||||
},
|
|
||||||
"funding": {
|
|
||||||
"url": "https://github.com/sindresorhus/execa?sponsor=1"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/get-stream": {
|
|
||||||
"version": "6.0.1",
|
|
||||||
"resolved": "https://registry.npmjs.org/get-stream/-/get-stream-6.0.1.tgz",
|
|
||||||
"integrity": "sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg==",
|
|
||||||
"engines": {
|
|
||||||
"node": ">=10"
|
|
||||||
},
|
|
||||||
"funding": {
|
|
||||||
"url": "https://github.com/sponsors/sindresorhus"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/human-signals": {
|
|
||||||
"version": "3.0.1",
|
|
||||||
"resolved": "https://registry.npmjs.org/human-signals/-/human-signals-3.0.1.tgz",
|
|
||||||
"integrity": "sha512-rQLskxnM/5OCldHo+wNXbpVgDn5A17CUoKX+7Sokwaknlq7CdSnphy0W39GU8dw59XiCXmFXDg4fRuckQRKewQ==",
|
|
||||||
"engines": {
|
|
||||||
"node": ">=12.20.0"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/is-stream": {
|
|
||||||
"version": "3.0.0",
|
|
||||||
"resolved": "https://registry.npmjs.org/is-stream/-/is-stream-3.0.0.tgz",
|
|
||||||
"integrity": "sha512-LnQR4bZ9IADDRSkvpqMGvt/tEJWclzklNgSw48V5EAaAeDd6qGvN8ei6k5p0tvxSR171VmGyHuTiAOfxAbr8kA==",
|
|
||||||
"engines": {
|
|
||||||
"node": "^12.20.0 || ^14.13.1 || >=16.0.0"
|
|
||||||
},
|
|
||||||
"funding": {
|
|
||||||
"url": "https://github.com/sponsors/sindresorhus"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/isexe": {
|
|
||||||
"version": "2.0.0",
|
|
||||||
"resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz",
|
|
||||||
"integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA="
|
|
||||||
},
|
|
||||||
"node_modules/merge-stream": {
|
|
||||||
"version": "2.0.0",
|
|
||||||
"resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz",
|
|
||||||
"integrity": "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w=="
|
|
||||||
},
|
|
||||||
"node_modules/mimic-fn": {
|
|
||||||
"version": "4.0.0",
|
|
||||||
"resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-4.0.0.tgz",
|
|
||||||
"integrity": "sha512-vqiC06CuhBTUdZH+RYl8sFrL096vA45Ok5ISO6sE/Mr1jRbGH4Csnhi8f3wKVl7x8mO4Au7Ir9D3Oyv1VYMFJw==",
|
|
||||||
"engines": {
|
|
||||||
"node": ">=12"
|
|
||||||
},
|
|
||||||
"funding": {
|
|
||||||
"url": "https://github.com/sponsors/sindresorhus"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/npm-run-path": {
|
|
||||||
"version": "5.1.0",
|
|
||||||
"resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-5.1.0.tgz",
|
|
||||||
"integrity": "sha512-sJOdmRGrY2sjNTRMbSvluQqg+8X7ZK61yvzBEIDhz4f8z1TZFYABsqjjCBd/0PUNE9M6QDgHJXQkGUEm7Q+l9Q==",
|
|
||||||
"dependencies": {
|
|
||||||
"path-key": "^4.0.0"
|
|
||||||
},
|
},
|
||||||
|
"node_modules/chalk": {
|
||||||
|
"version": "5.0.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/chalk/-/chalk-5.0.1.tgz",
|
||||||
|
"integrity": "sha512-Fo07WOYGqMfCWHOzSXOt2CxDbC6skS/jO9ynEcmpANMoPrD+W1r1K6Vx7iNm+AQmETU1Xr2t+n8nzkV9t6xh3w==",
|
||||||
|
"dev": true,
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": "^12.20.0 || ^14.13.1 || >=16.0.0"
|
"node": "^12.17.0 || ^14.13 || >=16.0.0"
|
||||||
},
|
},
|
||||||
"funding": {
|
"funding": {
|
||||||
"url": "https://github.com/sponsors/sindresorhus"
|
"url": "https://github.com/chalk/chalk?sponsor=1"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/npm-run-path/node_modules/path-key": {
|
"node_modules/color-contrast-checker": {
|
||||||
"version": "4.0.0",
|
"version": "2.1.0",
|
||||||
"resolved": "https://registry.npmjs.org/path-key/-/path-key-4.0.0.tgz",
|
"resolved": "https://registry.npmjs.org/color-contrast-checker/-/color-contrast-checker-2.1.0.tgz",
|
||||||
"integrity": "sha512-haREypq7xkM7ErfgIyA0z+Bj4AGKlMSdlQE2jvJo6huWD1EdkKYV+G/T4nq0YEF2vgTT8kqMFKo1uHn950r4SQ==",
|
"integrity": "sha512-6Y0aIEej3pwZTVlicIqVzhO6T4izDWouaIXnYoDdTuFFAMQ9nnN0dgHNP9J94jRnH6asjPq1/wzUKxwoNbWtRQ==",
|
||||||
"engines": {
|
"dev": true
|
||||||
"node": ">=12"
|
|
||||||
},
|
|
||||||
"funding": {
|
|
||||||
"url": "https://github.com/sponsors/sindresorhus"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/onetime": {
|
|
||||||
"version": "6.0.0",
|
|
||||||
"resolved": "https://registry.npmjs.org/onetime/-/onetime-6.0.0.tgz",
|
|
||||||
"integrity": "sha512-1FlR+gjXK7X+AsAHso35MnyN5KqGwJRi/31ft6x0M194ht7S+rWAvd7PHss9xSKMzE0asv1pyIHaJYq+BbacAQ==",
|
|
||||||
"dependencies": {
|
|
||||||
"mimic-fn": "^4.0.0"
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": ">=12"
|
|
||||||
},
|
|
||||||
"funding": {
|
|
||||||
"url": "https://github.com/sponsors/sindresorhus"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/path-key": {
|
|
||||||
"version": "3.1.1",
|
|
||||||
"resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz",
|
|
||||||
"integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==",
|
|
||||||
"engines": {
|
|
||||||
"node": ">=8"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/shebang-command": {
|
|
||||||
"version": "2.0.0",
|
|
||||||
"resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz",
|
|
||||||
"integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==",
|
|
||||||
"dependencies": {
|
|
||||||
"shebang-regex": "^3.0.0"
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": ">=8"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/shebang-regex": {
|
|
||||||
"version": "3.0.0",
|
|
||||||
"resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz",
|
|
||||||
"integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==",
|
|
||||||
"engines": {
|
|
||||||
"node": ">=8"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/signal-exit": {
|
|
||||||
"version": "3.0.7",
|
|
||||||
"resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz",
|
|
||||||
"integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ=="
|
|
||||||
},
|
|
||||||
"node_modules/strip-final-newline": {
|
|
||||||
"version": "3.0.0",
|
|
||||||
"resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-3.0.0.tgz",
|
|
||||||
"integrity": "sha512-dOESqjYr96iWYylGObzd39EuNTa5VJxyvVAEm5Jnh7KGo75V43Hk1odPQkNDyXNmUR6k+gEiDVXnjB8HJ3crXw==",
|
|
||||||
"engines": {
|
|
||||||
"node": ">=12"
|
|
||||||
},
|
|
||||||
"funding": {
|
|
||||||
"url": "https://github.com/sponsors/sindresorhus"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/which": {
|
|
||||||
"version": "2.0.2",
|
|
||||||
"resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz",
|
|
||||||
"integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==",
|
|
||||||
"dependencies": {
|
|
||||||
"isexe": "^2.0.0"
|
|
||||||
},
|
|
||||||
"bin": {
|
|
||||||
"node-which": "bin/node-which"
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": ">= 8"
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,130 +0,0 @@
|
|||||||
# Changelog
|
|
||||||
|
|
||||||
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
|
||||||
|
|
||||||
### [7.0.3](https://github.com/moxystudio/node-cross-spawn/compare/v7.0.2...v7.0.3) (2020-05-25)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* detect path key based on correct environment ([#133](https://github.com/moxystudio/node-cross-spawn/issues/133)) ([159e7e9](https://github.com/moxystudio/node-cross-spawn/commit/159e7e9785e57451cba034ae51719f97135074ae))
|
|
||||||
|
|
||||||
### [7.0.2](https://github.com/moxystudio/node-cross-spawn/compare/v7.0.1...v7.0.2) (2020-04-04)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* fix worker threads in Node >=11.10.0 ([#132](https://github.com/moxystudio/node-cross-spawn/issues/132)) ([6c5b4f0](https://github.com/moxystudio/node-cross-spawn/commit/6c5b4f015814a6c4f6b33230dfd1a860aedc0aaf))
|
|
||||||
|
|
||||||
### [7.0.1](https://github.com/moxystudio/node-cross-spawn/compare/v7.0.0...v7.0.1) (2019-10-07)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* **core:** support worker threads ([#127](https://github.com/moxystudio/node-cross-spawn/issues/127)) ([cfd49c9](https://github.com/moxystudio/node-cross-spawn/commit/cfd49c9))
|
|
||||||
|
|
||||||
## [7.0.0](https://github.com/moxystudio/node-cross-spawn/compare/v6.0.5...v7.0.0) (2019-09-03)
|
|
||||||
|
|
||||||
|
|
||||||
### ⚠ BREAKING CHANGES
|
|
||||||
|
|
||||||
* drop support for Node.js < 8
|
|
||||||
|
|
||||||
* drop support for versions below Node.js 8 ([#125](https://github.com/moxystudio/node-cross-spawn/issues/125)) ([16feb53](https://github.com/moxystudio/node-cross-spawn/commit/16feb53))
|
|
||||||
|
|
||||||
<a name="6.0.5"></a>
|
|
||||||
## [6.0.5](https://github.com/moxystudio/node-cross-spawn/compare/v6.0.4...v6.0.5) (2018-03-02)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* avoid using deprecated Buffer constructor ([#94](https://github.com/moxystudio/node-cross-spawn/issues/94)) ([d5770df](https://github.com/moxystudio/node-cross-spawn/commit/d5770df)), closes [/nodejs.org/api/deprecations.html#deprecations_dep0005](https://github.com//nodejs.org/api/deprecations.html/issues/deprecations_dep0005)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="6.0.4"></a>
|
|
||||||
## [6.0.4](https://github.com/moxystudio/node-cross-spawn/compare/v6.0.3...v6.0.4) (2018-01-31)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* fix paths being incorrectly normalized on unix ([06ee3c6](https://github.com/moxystudio/node-cross-spawn/commit/06ee3c6)), closes [#90](https://github.com/moxystudio/node-cross-spawn/issues/90)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="6.0.3"></a>
|
|
||||||
## [6.0.3](https://github.com/moxystudio/node-cross-spawn/compare/v6.0.2...v6.0.3) (2018-01-23)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="6.0.2"></a>
|
|
||||||
## [6.0.2](https://github.com/moxystudio/node-cross-spawn/compare/v6.0.1...v6.0.2) (2018-01-23)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="6.0.1"></a>
|
|
||||||
## [6.0.1](https://github.com/moxystudio/node-cross-spawn/compare/v6.0.0...v6.0.1) (2018-01-23)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="6.0.0"></a>
|
|
||||||
# [6.0.0](https://github.com/moxystudio/node-cross-spawn/compare/5.1.0...6.0.0) (2018-01-23)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* fix certain arguments not being correctly escaped or causing batch syntax error ([900cf10](https://github.com/moxystudio/node-cross-spawn/commit/900cf10)), closes [#82](https://github.com/moxystudio/node-cross-spawn/issues/82) [#51](https://github.com/moxystudio/node-cross-spawn/issues/51)
|
|
||||||
* fix commands as posix relatixe paths not working correctly, e.g.: `./my-command` ([900cf10](https://github.com/moxystudio/node-cross-spawn/commit/900cf10))
|
|
||||||
* fix `options` argument being mutated ([900cf10](https://github.com/moxystudio/node-cross-spawn/commit/900cf10))
|
|
||||||
* fix commands resolution when PATH was actually Path ([900cf10](https://github.com/moxystudio/node-cross-spawn/commit/900cf10))
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* improve compliance with node's ENOENT errors ([900cf10](https://github.com/moxystudio/node-cross-spawn/commit/900cf10))
|
|
||||||
* improve detection of node's shell option support ([900cf10](https://github.com/moxystudio/node-cross-spawn/commit/900cf10))
|
|
||||||
|
|
||||||
|
|
||||||
### Chores
|
|
||||||
|
|
||||||
* upgrade tooling
|
|
||||||
* upgrate project to es6 (node v4)
|
|
||||||
|
|
||||||
|
|
||||||
### BREAKING CHANGES
|
|
||||||
|
|
||||||
* remove support for older nodejs versions, only `node >= 4` is supported
|
|
||||||
|
|
||||||
|
|
||||||
<a name="5.1.0"></a>
|
|
||||||
## [5.1.0](https://github.com/moxystudio/node-cross-spawn/compare/5.0.1...5.1.0) (2017-02-26)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* fix `options.shell` support for NodeJS [v4.8](https://github.com/nodejs/node/blob/master/doc/changelogs/CHANGELOG_V4.md#4.8.0)
|
|
||||||
|
|
||||||
|
|
||||||
<a name="5.0.1"></a>
|
|
||||||
## [5.0.1](https://github.com/moxystudio/node-cross-spawn/compare/5.0.0...5.0.1) (2016-11-04)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* fix `options.shell` support for NodeJS v7
|
|
||||||
|
|
||||||
|
|
||||||
<a name="5.0.0"></a>
|
|
||||||
# [5.0.0](https://github.com/moxystudio/node-cross-spawn/compare/4.0.2...5.0.0) (2016-10-30)
|
|
||||||
|
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
* add support for `options.shell`
|
|
||||||
* improve parsing of shebangs by using [`shebang-command`](https://github.com/kevva/shebang-command) module
|
|
||||||
|
|
||||||
|
|
||||||
## Chores
|
|
||||||
|
|
||||||
* refactor some code to make it more clear
|
|
||||||
* update README caveats
|
|
@ -1,21 +0,0 @@
|
|||||||
The MIT License (MIT)
|
|
||||||
|
|
||||||
Copyright (c) 2018 Made With MOXY Lda <hello@moxy.studio>
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in
|
|
||||||
all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
||||||
THE SOFTWARE.
|
|
@ -1,96 +0,0 @@
|
|||||||
# cross-spawn
|
|
||||||
|
|
||||||
[![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]
|
|
||||||
|
|
||||||
[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
|
|
||||||
[travis-url]:https://travis-ci.org/moxystudio/node-cross-spawn
|
|
||||||
[travis-image]:https://img.shields.io/travis/moxystudio/node-cross-spawn/master.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
|
|
||||||
[codecov-url]:https://codecov.io/gh/moxystudio/node-cross-spawn
|
|
||||||
[codecov-image]:https://img.shields.io/codecov/c/github/moxystudio/node-cross-spawn/master.svg
|
|
||||||
[david-dm-url]:https://david-dm.org/moxystudio/node-cross-spawn
|
|
||||||
[david-dm-image]:https://img.shields.io/david/moxystudio/node-cross-spawn.svg
|
|
||||||
[david-dm-dev-url]:https://david-dm.org/moxystudio/node-cross-spawn?type=dev
|
|
||||||
[david-dm-dev-image]:https://img.shields.io/david/dev/moxystudio/node-cross-spawn.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).
|
|
@ -1,39 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
const cp = require('child_process');
|
|
||||||
const parse = require('./lib/parse');
|
|
||||||
const enoent = require('./lib/enoent');
|
|
||||||
|
|
||||||
function spawn(command, args, options) {
|
|
||||||
// Parse the arguments
|
|
||||||
const parsed = parse(command, args, options);
|
|
||||||
|
|
||||||
// Spawn the child process
|
|
||||||
const spawned = cp.spawn(parsed.command, parsed.args, parsed.options);
|
|
||||||
|
|
||||||
// Hook into child process "exit" event to emit an error if the command
|
|
||||||
// does not exists, see: https://github.com/IndigoUnited/node-cross-spawn/issues/16
|
|
||||||
enoent.hookChildProcess(spawned, parsed);
|
|
||||||
|
|
||||||
return spawned;
|
|
||||||
}
|
|
||||||
|
|
||||||
function spawnSync(command, args, options) {
|
|
||||||
// Parse the arguments
|
|
||||||
const parsed = parse(command, args, options);
|
|
||||||
|
|
||||||
// Spawn the child process
|
|
||||||
const result = cp.spawnSync(parsed.command, parsed.args, parsed.options);
|
|
||||||
|
|
||||||
// Analyze if the command does not exist, see: https://github.com/IndigoUnited/node-cross-spawn/issues/16
|
|
||||||
result.error = result.error || enoent.verifyENOENTSync(result.status, parsed);
|
|
||||||
|
|
||||||
return result;
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = spawn;
|
|
||||||
module.exports.spawn = spawn;
|
|
||||||
module.exports.sync = spawnSync;
|
|
||||||
|
|
||||||
module.exports._parse = parse;
|
|
||||||
module.exports._enoent = enoent;
|
|
@ -1,59 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
const isWin = process.platform === 'win32';
|
|
||||||
|
|
||||||
function notFoundError(original, syscall) {
|
|
||||||
return Object.assign(new Error(`${syscall} ${original.command} ENOENT`), {
|
|
||||||
code: 'ENOENT',
|
|
||||||
errno: 'ENOENT',
|
|
||||||
syscall: `${syscall} ${original.command}`,
|
|
||||||
path: original.command,
|
|
||||||
spawnargs: original.args,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
function hookChildProcess(cp, parsed) {
|
|
||||||
if (!isWin) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const originalEmit = cp.emit;
|
|
||||||
|
|
||||||
cp.emit = function (name, arg1) {
|
|
||||||
// If emitting "exit" event and exit code is 1, we need to check if
|
|
||||||
// the command exists and emit an "error" instead
|
|
||||||
// See https://github.com/IndigoUnited/node-cross-spawn/issues/16
|
|
||||||
if (name === 'exit') {
|
|
||||||
const err = verifyENOENT(arg1, parsed, 'spawn');
|
|
||||||
|
|
||||||
if (err) {
|
|
||||||
return originalEmit.call(cp, 'error', err);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return originalEmit.apply(cp, arguments); // eslint-disable-line prefer-rest-params
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
function verifyENOENT(status, parsed) {
|
|
||||||
if (isWin && status === 1 && !parsed.file) {
|
|
||||||
return notFoundError(parsed.original, 'spawn');
|
|
||||||
}
|
|
||||||
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
function verifyENOENTSync(status, parsed) {
|
|
||||||
if (isWin && status === 1 && !parsed.file) {
|
|
||||||
return notFoundError(parsed.original, 'spawnSync');
|
|
||||||
}
|
|
||||||
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = {
|
|
||||||
hookChildProcess,
|
|
||||||
verifyENOENT,
|
|
||||||
verifyENOENTSync,
|
|
||||||
notFoundError,
|
|
||||||
};
|
|
@ -1,91 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
const path = require('path');
|
|
||||||
const resolveCommand = require('./util/resolveCommand');
|
|
||||||
const escape = require('./util/escape');
|
|
||||||
const readShebang = require('./util/readShebang');
|
|
||||||
|
|
||||||
const isWin = process.platform === 'win32';
|
|
||||||
const isExecutableRegExp = /\.(?:com|exe)$/i;
|
|
||||||
const isCmdShimRegExp = /node_modules[\\/].bin[\\/][^\\/]+\.cmd$/i;
|
|
||||||
|
|
||||||
function detectShebang(parsed) {
|
|
||||||
parsed.file = resolveCommand(parsed);
|
|
||||||
|
|
||||||
const shebang = parsed.file && readShebang(parsed.file);
|
|
||||||
|
|
||||||
if (shebang) {
|
|
||||||
parsed.args.unshift(parsed.file);
|
|
||||||
parsed.command = shebang;
|
|
||||||
|
|
||||||
return resolveCommand(parsed);
|
|
||||||
}
|
|
||||||
|
|
||||||
return parsed.file;
|
|
||||||
}
|
|
||||||
|
|
||||||
function parseNonShell(parsed) {
|
|
||||||
if (!isWin) {
|
|
||||||
return parsed;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Detect & add support for shebangs
|
|
||||||
const commandFile = detectShebang(parsed);
|
|
||||||
|
|
||||||
// We don't need a shell if the command filename is an executable
|
|
||||||
const needsShell = !isExecutableRegExp.test(commandFile);
|
|
||||||
|
|
||||||
// If a shell is required, use cmd.exe and take care of escaping everything correctly
|
|
||||||
// Note that `forceShell` is an hidden option used only in tests
|
|
||||||
if (parsed.options.forceShell || needsShell) {
|
|
||||||
// Need to double escape meta chars if the command is a cmd-shim located in `node_modules/.bin/`
|
|
||||||
// The cmd-shim simply calls execute the package bin file with NodeJS, proxying any argument
|
|
||||||
// Because the escape of metachars with ^ gets interpreted when the cmd.exe is first called,
|
|
||||||
// we need to double escape them
|
|
||||||
const needsDoubleEscapeMetaChars = isCmdShimRegExp.test(commandFile);
|
|
||||||
|
|
||||||
// Normalize posix paths into OS compatible paths (e.g.: foo/bar -> foo\bar)
|
|
||||||
// This is necessary otherwise it will always fail with ENOENT in those cases
|
|
||||||
parsed.command = path.normalize(parsed.command);
|
|
||||||
|
|
||||||
// Escape command & arguments
|
|
||||||
parsed.command = escape.command(parsed.command);
|
|
||||||
parsed.args = parsed.args.map((arg) => escape.argument(arg, needsDoubleEscapeMetaChars));
|
|
||||||
|
|
||||||
const shellCommand = [parsed.command].concat(parsed.args).join(' ');
|
|
||||||
|
|
||||||
parsed.args = ['/d', '/s', '/c', `"${shellCommand}"`];
|
|
||||||
parsed.command = process.env.comspec || 'cmd.exe';
|
|
||||||
parsed.options.windowsVerbatimArguments = true; // Tell node's spawn that the arguments are already escaped
|
|
||||||
}
|
|
||||||
|
|
||||||
return parsed;
|
|
||||||
}
|
|
||||||
|
|
||||||
function parse(command, args, options) {
|
|
||||||
// Normalize arguments, similar to nodejs
|
|
||||||
if (args && !Array.isArray(args)) {
|
|
||||||
options = args;
|
|
||||||
args = null;
|
|
||||||
}
|
|
||||||
|
|
||||||
args = args ? args.slice(0) : []; // Clone array to avoid changing the original
|
|
||||||
options = Object.assign({}, options); // Clone object to avoid changing the original
|
|
||||||
|
|
||||||
// Build our parsed object
|
|
||||||
const parsed = {
|
|
||||||
command,
|
|
||||||
args,
|
|
||||||
options,
|
|
||||||
file: undefined,
|
|
||||||
original: {
|
|
||||||
command,
|
|
||||||
args,
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
// Delegate further parsing to shell or non-shell
|
|
||||||
return options.shell ? parsed : parseNonShell(parsed);
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = parse;
|
|
@ -1,45 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
// See http://www.robvanderwoude.com/escapechars.php
|
|
||||||
const metaCharsRegExp = /([()\][%!^"`<>&|;, *?])/g;
|
|
||||||
|
|
||||||
function escapeCommand(arg) {
|
|
||||||
// Escape meta chars
|
|
||||||
arg = arg.replace(metaCharsRegExp, '^$1');
|
|
||||||
|
|
||||||
return arg;
|
|
||||||
}
|
|
||||||
|
|
||||||
function escapeArgument(arg, doubleEscapeMetaChars) {
|
|
||||||
// Convert to string
|
|
||||||
arg = `${arg}`;
|
|
||||||
|
|
||||||
// Algorithm below is based on https://qntm.org/cmd
|
|
||||||
|
|
||||||
// Sequence of backslashes followed by a double quote:
|
|
||||||
// double up all the backslashes and escape the double quote
|
|
||||||
arg = arg.replace(/(\\*)"/g, '$1$1\\"');
|
|
||||||
|
|
||||||
// Sequence of backslashes followed by the end of the string
|
|
||||||
// (which will become a double quote later):
|
|
||||||
// double up all the backslashes
|
|
||||||
arg = arg.replace(/(\\*)$/, '$1$1');
|
|
||||||
|
|
||||||
// All other backslashes occur literally
|
|
||||||
|
|
||||||
// Quote the whole thing:
|
|
||||||
arg = `"${arg}"`;
|
|
||||||
|
|
||||||
// Escape meta chars
|
|
||||||
arg = arg.replace(metaCharsRegExp, '^$1');
|
|
||||||
|
|
||||||
// Double escape meta chars if necessary
|
|
||||||
if (doubleEscapeMetaChars) {
|
|
||||||
arg = arg.replace(metaCharsRegExp, '^$1');
|
|
||||||
}
|
|
||||||
|
|
||||||
return arg;
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports.command = escapeCommand;
|
|
||||||
module.exports.argument = escapeArgument;
|
|
@ -1,23 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
const fs = require('fs');
|
|
||||||
const shebangCommand = require('shebang-command');
|
|
||||||
|
|
||||||
function readShebang(command) {
|
|
||||||
// Read the first 150 bytes from the file
|
|
||||||
const size = 150;
|
|
||||||
const buffer = Buffer.alloc(size);
|
|
||||||
|
|
||||||
let fd;
|
|
||||||
|
|
||||||
try {
|
|
||||||
fd = fs.openSync(command, 'r');
|
|
||||||
fs.readSync(fd, buffer, 0, size, 0);
|
|
||||||
fs.closeSync(fd);
|
|
||||||
} catch (e) { /* Empty */ }
|
|
||||||
|
|
||||||
// Attempt to extract shebang (null is returned if not a shebang)
|
|
||||||
return shebangCommand(buffer.toString());
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = readShebang;
|
|
@ -1,52 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
const path = require('path');
|
|
||||||
const which = require('which');
|
|
||||||
const getPathKey = require('path-key');
|
|
||||||
|
|
||||||
function resolveCommandAttempt(parsed, withoutPathExt) {
|
|
||||||
const env = parsed.options.env || process.env;
|
|
||||||
const cwd = process.cwd();
|
|
||||||
const hasCustomCwd = parsed.options.cwd != null;
|
|
||||||
// Worker threads do not have process.chdir()
|
|
||||||
const shouldSwitchCwd = hasCustomCwd && process.chdir !== undefined && !process.chdir.disabled;
|
|
||||||
|
|
||||||
// If a custom `cwd` was specified, we need to change the process cwd
|
|
||||||
// because `which` will do stat calls but does not support a custom cwd
|
|
||||||
if (shouldSwitchCwd) {
|
|
||||||
try {
|
|
||||||
process.chdir(parsed.options.cwd);
|
|
||||||
} catch (err) {
|
|
||||||
/* Empty */
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
let resolved;
|
|
||||||
|
|
||||||
try {
|
|
||||||
resolved = which.sync(parsed.command, {
|
|
||||||
path: env[getPathKey({ env })],
|
|
||||||
pathExt: withoutPathExt ? path.delimiter : undefined,
|
|
||||||
});
|
|
||||||
} catch (e) {
|
|
||||||
/* Empty */
|
|
||||||
} finally {
|
|
||||||
if (shouldSwitchCwd) {
|
|
||||||
process.chdir(cwd);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// If we successfully resolved, ensure that an absolute path is returned
|
|
||||||
// Note that when a custom `cwd` was used, we need to resolve to an absolute path based on it
|
|
||||||
if (resolved) {
|
|
||||||
resolved = path.resolve(hasCustomCwd ? parsed.options.cwd : '', resolved);
|
|
||||||
}
|
|
||||||
|
|
||||||
return resolved;
|
|
||||||
}
|
|
||||||
|
|
||||||
function resolveCommand(parsed) {
|
|
||||||
return resolveCommandAttempt(parsed) || resolveCommandAttempt(parsed, true);
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = resolveCommand;
|
|
@ -1,73 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "cross-spawn",
|
|
||||||
"version": "7.0.3",
|
|
||||||
"description": "Cross platform child_process#spawn and child_process#spawnSync",
|
|
||||||
"keywords": [
|
|
||||||
"spawn",
|
|
||||||
"spawnSync",
|
|
||||||
"windows",
|
|
||||||
"cross-platform",
|
|
||||||
"path-ext",
|
|
||||||
"shebang",
|
|
||||||
"cmd",
|
|
||||||
"execute"
|
|
||||||
],
|
|
||||||
"author": "André Cruz <andre@moxy.studio>",
|
|
||||||
"homepage": "https://github.com/moxystudio/node-cross-spawn",
|
|
||||||
"repository": {
|
|
||||||
"type": "git",
|
|
||||||
"url": "git@github.com:moxystudio/node-cross-spawn.git"
|
|
||||||
},
|
|
||||||
"license": "MIT",
|
|
||||||
"main": "index.js",
|
|
||||||
"files": [
|
|
||||||
"lib"
|
|
||||||
],
|
|
||||||
"scripts": {
|
|
||||||
"lint": "eslint .",
|
|
||||||
"test": "jest --env node --coverage",
|
|
||||||
"prerelease": "npm t && npm run lint",
|
|
||||||
"release": "standard-version",
|
|
||||||
"postrelease": "git push --follow-tags origin HEAD && npm publish"
|
|
||||||
},
|
|
||||||
"husky": {
|
|
||||||
"hooks": {
|
|
||||||
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
|
|
||||||
"pre-commit": "lint-staged"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"lint-staged": {
|
|
||||||
"*.js": [
|
|
||||||
"eslint --fix",
|
|
||||||
"git add"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"commitlint": {
|
|
||||||
"extends": [
|
|
||||||
"@commitlint/config-conventional"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"dependencies": {
|
|
||||||
"path-key": "^3.1.0",
|
|
||||||
"shebang-command": "^2.0.0",
|
|
||||||
"which": "^2.0.1"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"@commitlint/cli": "^8.1.0",
|
|
||||||
"@commitlint/config-conventional": "^8.1.0",
|
|
||||||
"babel-core": "^6.26.3",
|
|
||||||
"babel-jest": "^24.9.0",
|
|
||||||
"babel-preset-moxy": "^3.1.0",
|
|
||||||
"eslint": "^5.16.0",
|
|
||||||
"eslint-config-moxy": "^7.1.0",
|
|
||||||
"husky": "^3.0.5",
|
|
||||||
"jest": "^24.9.0",
|
|
||||||
"lint-staged": "^9.2.5",
|
|
||||||
"mkdirp": "^0.5.1",
|
|
||||||
"rimraf": "^3.0.0",
|
|
||||||
"standard-version": "^7.0.0"
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": ">= 8"
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,586 +0,0 @@
|
|||||||
import {Buffer} from 'node:buffer';
|
|
||||||
import {ChildProcess} from 'node:child_process';
|
|
||||||
import {Stream, Readable as ReadableStream} from 'node:stream';
|
|
||||||
|
|
||||||
export type StdioOption =
|
|
||||||
| 'pipe'
|
|
||||||
| 'ipc'
|
|
||||||
| 'ignore'
|
|
||||||
| 'inherit'
|
|
||||||
| Stream
|
|
||||||
| number
|
|
||||||
| undefined;
|
|
||||||
|
|
||||||
export interface CommonOptions<EncodingType> {
|
|
||||||
/**
|
|
||||||
Kill the spawned process when the parent process exits unless either:
|
|
||||||
- the spawned process is [`detached`](https://nodejs.org/api/child_process.html#child_process_options_detached)
|
|
||||||
- the parent process is terminated abruptly, for example, with `SIGKILL` as opposed to `SIGTERM` or a normal exit
|
|
||||||
|
|
||||||
@default true
|
|
||||||
*/
|
|
||||||
readonly cleanup?: boolean;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Prefer locally installed binaries when looking for a binary to execute.
|
|
||||||
|
|
||||||
If you `$ npm install foo`, you can then `execa('foo')`.
|
|
||||||
|
|
||||||
@default false
|
|
||||||
*/
|
|
||||||
readonly preferLocal?: boolean;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Preferred path to find locally installed binaries in (use with `preferLocal`).
|
|
||||||
|
|
||||||
Using a `URL` is only supported in Node.js `14.18.0`, `16.14.0` or above.
|
|
||||||
|
|
||||||
@default process.cwd()
|
|
||||||
*/
|
|
||||||
readonly localDir?: string | URL;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Path to the Node.js executable to use in child processes.
|
|
||||||
|
|
||||||
This can be either an absolute path or a path relative to the `cwd` option.
|
|
||||||
|
|
||||||
Requires `preferLocal` to be `true`.
|
|
||||||
|
|
||||||
For example, this can be used together with [`get-node`](https://github.com/ehmicky/get-node) to run a specific Node.js version in a child process.
|
|
||||||
|
|
||||||
@default process.execPath
|
|
||||||
*/
|
|
||||||
readonly execPath?: string;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Buffer the output from the spawned process. When set to `false`, you must read the output of `stdout` and `stderr` (or `all` if the `all` option is `true`). Otherwise the returned promise will not be resolved/rejected.
|
|
||||||
|
|
||||||
If the spawned process fails, `error.stdout`, `error.stderr`, and `error.all` will contain the buffered data.
|
|
||||||
|
|
||||||
@default true
|
|
||||||
*/
|
|
||||||
readonly buffer?: boolean;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Same options as [`stdio`](https://nodejs.org/dist/latest-v6.x/docs/api/child_process.html#child_process_options_stdio).
|
|
||||||
|
|
||||||
@default 'pipe'
|
|
||||||
*/
|
|
||||||
readonly stdin?: StdioOption;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Same options as [`stdio`](https://nodejs.org/dist/latest-v6.x/docs/api/child_process.html#child_process_options_stdio).
|
|
||||||
|
|
||||||
@default 'pipe'
|
|
||||||
*/
|
|
||||||
readonly stdout?: StdioOption;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Same options as [`stdio`](https://nodejs.org/dist/latest-v6.x/docs/api/child_process.html#child_process_options_stdio).
|
|
||||||
|
|
||||||
@default 'pipe'
|
|
||||||
*/
|
|
||||||
readonly stderr?: StdioOption;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Setting this to `false` resolves the promise with the error instead of rejecting it.
|
|
||||||
|
|
||||||
@default true
|
|
||||||
*/
|
|
||||||
readonly reject?: boolean;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Add an `.all` property on the promise and the resolved value. The property contains the output of the process with `stdout` and `stderr` interleaved.
|
|
||||||
|
|
||||||
@default false
|
|
||||||
*/
|
|
||||||
readonly all?: boolean;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Strip the final [newline character](https://en.wikipedia.org/wiki/Newline) from the output.
|
|
||||||
|
|
||||||
@default true
|
|
||||||
*/
|
|
||||||
readonly stripFinalNewline?: boolean;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Set to `false` if you don't want to extend the environment variables when providing the `env` property.
|
|
||||||
|
|
||||||
@default true
|
|
||||||
*/
|
|
||||||
readonly extendEnv?: boolean;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Current working directory of the child process.
|
|
||||||
|
|
||||||
Using a `URL` is only supported in Node.js `14.18.0`, `16.14.0` or above.
|
|
||||||
|
|
||||||
@default process.cwd()
|
|
||||||
*/
|
|
||||||
readonly cwd?: string | URL;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Environment key-value pairs. Extends automatically from `process.env`. Set `extendEnv` to `false` if you don't want this.
|
|
||||||
|
|
||||||
@default process.env
|
|
||||||
*/
|
|
||||||
readonly env?: NodeJS.ProcessEnv;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Explicitly set the value of `argv[0]` sent to the child process. This will be set to `command` or `file` if not specified.
|
|
||||||
*/
|
|
||||||
readonly argv0?: string;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Child's [stdio](https://nodejs.org/api/child_process.html#child_process_options_stdio) configuration.
|
|
||||||
|
|
||||||
@default 'pipe'
|
|
||||||
*/
|
|
||||||
readonly stdio?: 'pipe' | 'ignore' | 'inherit' | readonly StdioOption[];
|
|
||||||
|
|
||||||
/**
|
|
||||||
Specify the kind of serialization used for sending messages between processes when using the `stdio: 'ipc'` option or `execaNode()`:
|
|
||||||
- `json`: Uses `JSON.stringify()` and `JSON.parse()`.
|
|
||||||
- `advanced`: Uses [`v8.serialize()`](https://nodejs.org/api/v8.html#v8_v8_serialize_value)
|
|
||||||
|
|
||||||
Requires Node.js `13.2.0` or later.
|
|
||||||
|
|
||||||
[More info.](https://nodejs.org/api/child_process.html#child_process_advanced_serialization)
|
|
||||||
|
|
||||||
@default 'json'
|
|
||||||
*/
|
|
||||||
readonly serialization?: 'json' | 'advanced';
|
|
||||||
|
|
||||||
/**
|
|
||||||
Prepare child to run independently of its parent process. Specific behavior [depends on the platform](https://nodejs.org/api/child_process.html#child_process_options_detached).
|
|
||||||
|
|
||||||
@default false
|
|
||||||
*/
|
|
||||||
readonly detached?: boolean;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Sets the user identity of the process.
|
|
||||||
*/
|
|
||||||
readonly uid?: number;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Sets the group identity of the process.
|
|
||||||
*/
|
|
||||||
readonly gid?: number;
|
|
||||||
|
|
||||||
/**
|
|
||||||
If `true`, runs `command` inside of a shell. Uses `/bin/sh` on UNIX and `cmd.exe` on Windows. A different shell can be specified as a string. The shell should understand the `-c` switch on UNIX or `/d /s /c` on Windows.
|
|
||||||
|
|
||||||
We recommend against using this option since it is:
|
|
||||||
- not cross-platform, encouraging shell-specific syntax.
|
|
||||||
- slower, because of the additional shell interpretation.
|
|
||||||
- unsafe, potentially allowing command injection.
|
|
||||||
|
|
||||||
@default false
|
|
||||||
*/
|
|
||||||
readonly shell?: boolean | string;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Specify the character encoding used to decode the `stdout` and `stderr` output. If set to `null`, then `stdout` and `stderr` will be a `Buffer` instead of a string.
|
|
||||||
|
|
||||||
@default 'utf8'
|
|
||||||
*/
|
|
||||||
readonly encoding?: EncodingType;
|
|
||||||
|
|
||||||
/**
|
|
||||||
If `timeout` is greater than `0`, the parent will send the signal identified by the `killSignal` property (the default is `SIGTERM`) if the child runs longer than `timeout` milliseconds.
|
|
||||||
|
|
||||||
@default 0
|
|
||||||
*/
|
|
||||||
readonly timeout?: number;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Largest amount of data in bytes allowed on `stdout` or `stderr`. Default: 100 MB.
|
|
||||||
|
|
||||||
@default 100_000_000
|
|
||||||
*/
|
|
||||||
readonly maxBuffer?: number;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Signal value to be used when the spawned process will be killed.
|
|
||||||
|
|
||||||
@default 'SIGTERM'
|
|
||||||
*/
|
|
||||||
readonly killSignal?: string | number;
|
|
||||||
|
|
||||||
/**
|
|
||||||
You can abort the spawned process using [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
||||||
|
|
||||||
When `AbortController.abort()` is called, [`.isCanceled`](https://github.com/sindresorhus/execa#iscanceled) becomes `false`.
|
|
||||||
|
|
||||||
*Requires Node.js 16 or later.*
|
|
||||||
|
|
||||||
@example
|
|
||||||
```js
|
|
||||||
import {execa} from 'execa';
|
|
||||||
|
|
||||||
const abortController = new AbortController();
|
|
||||||
const subprocess = execa('node', [], {signal: abortController.signal});
|
|
||||||
|
|
||||||
setTimeout(() => {
|
|
||||||
abortController.abort();
|
|
||||||
}, 1000);
|
|
||||||
|
|
||||||
try {
|
|
||||||
await subprocess;
|
|
||||||
} catch (error) {
|
|
||||||
console.log(subprocess.killed); // true
|
|
||||||
console.log(error.isCanceled); // true
|
|
||||||
}
|
|
||||||
```
|
|
||||||
*/
|
|
||||||
readonly signal?: AbortSignal;
|
|
||||||
|
|
||||||
/**
|
|
||||||
If `true`, no quoting or escaping of arguments is done on Windows. Ignored on other platforms. This is set to `true` automatically when the `shell` option is `true`.
|
|
||||||
|
|
||||||
@default false
|
|
||||||
*/
|
|
||||||
readonly windowsVerbatimArguments?: boolean;
|
|
||||||
|
|
||||||
/**
|
|
||||||
On Windows, do not create a new console window. Please note this also prevents `CTRL-C` [from working](https://github.com/nodejs/node/issues/29837) on Windows.
|
|
||||||
|
|
||||||
@default true
|
|
||||||
*/
|
|
||||||
readonly windowsHide?: boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface Options<EncodingType = string> extends CommonOptions<EncodingType> {
|
|
||||||
/**
|
|
||||||
Write some input to the `stdin` of your binary.
|
|
||||||
*/
|
|
||||||
readonly input?: string | Buffer | ReadableStream;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface SyncOptions<EncodingType = string> extends CommonOptions<EncodingType> {
|
|
||||||
/**
|
|
||||||
Write some input to the `stdin` of your binary.
|
|
||||||
*/
|
|
||||||
readonly input?: string | Buffer;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface NodeOptions<EncodingType = string> extends Options<EncodingType> {
|
|
||||||
/**
|
|
||||||
The Node.js executable to use.
|
|
||||||
|
|
||||||
@default process.execPath
|
|
||||||
*/
|
|
||||||
readonly nodePath?: string;
|
|
||||||
|
|
||||||
/**
|
|
||||||
List of [CLI options](https://nodejs.org/api/cli.html#cli_options) passed to the Node.js executable.
|
|
||||||
|
|
||||||
@default process.execArgv
|
|
||||||
*/
|
|
||||||
readonly nodeOptions?: string[];
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface ExecaReturnBase<StdoutStderrType> {
|
|
||||||
/**
|
|
||||||
The file and arguments that were run, for logging purposes.
|
|
||||||
|
|
||||||
This is not escaped and should not be executed directly as a process, including using `execa()` or `execaCommand()`.
|
|
||||||
*/
|
|
||||||
command: string;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Same as `command` but escaped.
|
|
||||||
|
|
||||||
This is meant to be copy and pasted into a shell, for debugging purposes.
|
|
||||||
Since the escaping is fairly basic, this should not be executed directly as a process, including using `execa()` or `execaCommand()`.
|
|
||||||
*/
|
|
||||||
escapedCommand: string;
|
|
||||||
|
|
||||||
/**
|
|
||||||
The numeric exit code of the process that was run.
|
|
||||||
*/
|
|
||||||
exitCode: number;
|
|
||||||
|
|
||||||
/**
|
|
||||||
The output of the process on stdout.
|
|
||||||
*/
|
|
||||||
stdout: StdoutStderrType;
|
|
||||||
|
|
||||||
/**
|
|
||||||
The output of the process on stderr.
|
|
||||||
*/
|
|
||||||
stderr: StdoutStderrType;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Whether the process failed to run.
|
|
||||||
*/
|
|
||||||
failed: boolean;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Whether the process timed out.
|
|
||||||
*/
|
|
||||||
timedOut: boolean;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Whether the process was killed.
|
|
||||||
*/
|
|
||||||
killed: boolean;
|
|
||||||
|
|
||||||
/**
|
|
||||||
The name of the signal that was used to terminate the process. For example, `SIGFPE`.
|
|
||||||
|
|
||||||
If a signal terminated the process, this property is defined and included in the error message. Otherwise it is `undefined`.
|
|
||||||
*/
|
|
||||||
signal?: string;
|
|
||||||
|
|
||||||
/**
|
|
||||||
A human-friendly description of the signal that was used to terminate the process. For example, `Floating point arithmetic error`.
|
|
||||||
|
|
||||||
If a signal terminated the process, this property is defined and included in the error message. Otherwise it is `undefined`. It is also `undefined` when the signal is very uncommon which should seldomly happen.
|
|
||||||
*/
|
|
||||||
signalDescription?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface ExecaSyncReturnValue<StdoutErrorType = string>
|
|
||||||
extends ExecaReturnBase<StdoutErrorType> {
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
Result of a child process execution. On success this is a plain object. On failure this is also an `Error` instance.
|
|
||||||
|
|
||||||
The child process fails when:
|
|
||||||
- its exit code is not `0`
|
|
||||||
- it was killed with a signal
|
|
||||||
- timing out
|
|
||||||
- being canceled
|
|
||||||
- there's not enough memory or there are already too many child processes
|
|
||||||
*/
|
|
||||||
export interface ExecaReturnValue<StdoutErrorType = string>
|
|
||||||
extends ExecaSyncReturnValue<StdoutErrorType> {
|
|
||||||
/**
|
|
||||||
The output of the process with `stdout` and `stderr` interleaved.
|
|
||||||
|
|
||||||
This is `undefined` if either:
|
|
||||||
- the `all` option is `false` (default value)
|
|
||||||
- `execaSync()` was used
|
|
||||||
*/
|
|
||||||
all?: StdoutErrorType;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Whether the process was canceled.
|
|
||||||
|
|
||||||
You can cancel the spawned process using the [`signal`](https://github.com/sindresorhus/execa#signal-1) option.
|
|
||||||
*/
|
|
||||||
isCanceled: boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface ExecaSyncError<StdoutErrorType = string>
|
|
||||||
extends Error,
|
|
||||||
ExecaReturnBase<StdoutErrorType> {
|
|
||||||
/**
|
|
||||||
Error message when the child process failed to run. In addition to the underlying error message, it also contains some information related to why the child process errored.
|
|
||||||
|
|
||||||
The child process stderr then stdout are appended to the end, separated with newlines and not interleaved.
|
|
||||||
*/
|
|
||||||
message: string;
|
|
||||||
|
|
||||||
/**
|
|
||||||
This is the same as the `message` property except it does not include the child process stdout/stderr.
|
|
||||||
*/
|
|
||||||
shortMessage: string;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Original error message. This is the same as the `message` property except it includes neither the child process stdout/stderr nor some additional information added by Execa.
|
|
||||||
|
|
||||||
This is `undefined` unless the child process exited due to an `error` event or a timeout.
|
|
||||||
*/
|
|
||||||
originalMessage?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface ExecaError<StdoutErrorType = string>
|
|
||||||
extends ExecaSyncError<StdoutErrorType> {
|
|
||||||
/**
|
|
||||||
The output of the process with `stdout` and `stderr` interleaved.
|
|
||||||
|
|
||||||
This is `undefined` if either:
|
|
||||||
- the `all` option is `false` (default value)
|
|
||||||
- `execaSync()` was used
|
|
||||||
*/
|
|
||||||
all?: StdoutErrorType;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Whether the process was canceled.
|
|
||||||
*/
|
|
||||||
isCanceled: boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface KillOptions {
|
|
||||||
/**
|
|
||||||
Milliseconds to wait for the child process to terminate before sending `SIGKILL`.
|
|
||||||
|
|
||||||
Can be disabled with `false`.
|
|
||||||
|
|
||||||
@default 5000
|
|
||||||
*/
|
|
||||||
forceKillAfterTimeout?: number | false;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface ExecaChildPromise<StdoutErrorType> {
|
|
||||||
/**
|
|
||||||
Stream combining/interleaving [`stdout`](https://nodejs.org/api/child_process.html#child_process_subprocess_stdout) and [`stderr`](https://nodejs.org/api/child_process.html#child_process_subprocess_stderr).
|
|
||||||
|
|
||||||
This is `undefined` if either:
|
|
||||||
- the `all` option is `false` (the default value)
|
|
||||||
- both `stdout` and `stderr` options are set to [`'inherit'`, `'ipc'`, `Stream` or `integer`](https://nodejs.org/dist/latest-v6.x/docs/api/child_process.html#child_process_options_stdio)
|
|
||||||
*/
|
|
||||||
all?: ReadableStream;
|
|
||||||
|
|
||||||
catch<ResultType = never>(
|
|
||||||
onRejected?: (reason: ExecaError<StdoutErrorType>) => ResultType | PromiseLike<ResultType>
|
|
||||||
): Promise<ExecaReturnValue<StdoutErrorType> | ResultType>;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Same as the original [`child_process#kill()`](https://nodejs.org/api/child_process.html#child_process_subprocess_kill_signal), except if `signal` is `SIGTERM` (the default value) and the child process is not terminated after 5 seconds, force it by sending `SIGKILL`.
|
|
||||||
*/
|
|
||||||
kill(signal?: string, options?: KillOptions): void;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Similar to [`childProcess.kill()`](https://nodejs.org/api/child_process.html#child_process_subprocess_kill_signal). This is preferred when cancelling the child process execution as the error is more descriptive and [`childProcessResult.isCanceled`](#iscanceled) is set to `true`.
|
|
||||||
*/
|
|
||||||
cancel(): void;
|
|
||||||
}
|
|
||||||
|
|
||||||
export type ExecaChildProcess<StdoutErrorType = string> = ChildProcess &
|
|
||||||
ExecaChildPromise<StdoutErrorType> &
|
|
||||||
Promise<ExecaReturnValue<StdoutErrorType>>;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Execute a file.
|
|
||||||
|
|
||||||
Think of this as a mix of `child_process.execFile` and `child_process.spawn`.
|
|
||||||
|
|
||||||
@param file - The program/script to execute.
|
|
||||||
@param arguments - Arguments to pass to `file` on execution.
|
|
||||||
@returns A [`child_process` instance](https://nodejs.org/api/child_process.html#child_process_class_childprocess), which is enhanced to also be a `Promise` for a result `Object` with `stdout` and `stderr` properties.
|
|
||||||
|
|
||||||
@example
|
|
||||||
```
|
|
||||||
import {execa} from 'execa';
|
|
||||||
|
|
||||||
const {stdout} = await execa('echo', ['unicorns']);
|
|
||||||
console.log(stdout);
|
|
||||||
//=> 'unicorns'
|
|
||||||
|
|
||||||
// Cancelling a spawned process
|
|
||||||
|
|
||||||
const subprocess = execa('node');
|
|
||||||
|
|
||||||
setTimeout(() => {
|
|
||||||
subprocess.cancel()
|
|
||||||
}, 1000);
|
|
||||||
|
|
||||||
try {
|
|
||||||
await subprocess;
|
|
||||||
} catch (error) {
|
|
||||||
console.log(subprocess.killed); // true
|
|
||||||
console.log(error.isCanceled); // true
|
|
||||||
}
|
|
||||||
|
|
||||||
// Pipe the child process stdout to the current stdout
|
|
||||||
execa('echo', ['unicorns']).stdout.pipe(process.stdout);
|
|
||||||
```
|
|
||||||
*/
|
|
||||||
export function execa(
|
|
||||||
file: string,
|
|
||||||
arguments?: readonly string[],
|
|
||||||
options?: Options
|
|
||||||
): ExecaChildProcess;
|
|
||||||
export function execa(
|
|
||||||
file: string,
|
|
||||||
arguments?: readonly string[],
|
|
||||||
options?: Options<null>
|
|
||||||
): ExecaChildProcess<Buffer>;
|
|
||||||
export function execa(file: string, options?: Options): ExecaChildProcess;
|
|
||||||
export function execa(file: string, options?: Options<null>): ExecaChildProcess<Buffer>;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Execute a file synchronously.
|
|
||||||
|
|
||||||
This method throws an `Error` if the command fails.
|
|
||||||
|
|
||||||
@param file - The program/script to execute.
|
|
||||||
@param arguments - Arguments to pass to `file` on execution.
|
|
||||||
@returns A result `Object` with `stdout` and `stderr` properties.
|
|
||||||
*/
|
|
||||||
export function execaSync(
|
|
||||||
file: string,
|
|
||||||
arguments?: readonly string[],
|
|
||||||
options?: SyncOptions
|
|
||||||
): ExecaSyncReturnValue;
|
|
||||||
export function execaSync(
|
|
||||||
file: string,
|
|
||||||
arguments?: readonly string[],
|
|
||||||
options?: SyncOptions<null>
|
|
||||||
): ExecaSyncReturnValue<Buffer>;
|
|
||||||
export function execaSync(file: string, options?: SyncOptions): ExecaSyncReturnValue;
|
|
||||||
export function execaSync(
|
|
||||||
file: string,
|
|
||||||
options?: SyncOptions<null>
|
|
||||||
): ExecaSyncReturnValue<Buffer>;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Same as `execa()` except both file and arguments are specified in a single `command` string. For example, `execa('echo', ['unicorns'])` is the same as `execaCommand('echo unicorns')`.
|
|
||||||
|
|
||||||
If the file or an argument contains spaces, they must be escaped with backslashes. This matters especially if `command` is not a constant but a variable, for example with `__dirname` or `process.cwd()`. Except for spaces, no escaping/quoting is needed.
|
|
||||||
|
|
||||||
The `shell` option must be used if the `command` uses shell-specific features (for example, `&&` or `||`), as opposed to being a simple `file` followed by its `arguments`.
|
|
||||||
|
|
||||||
@param command - The program/script to execute and its arguments.
|
|
||||||
@returns A [`child_process` instance](https://nodejs.org/api/child_process.html#child_process_class_childprocess), which is enhanced to also be a `Promise` for a result `Object` with `stdout` and `stderr` properties.
|
|
||||||
|
|
||||||
@example
|
|
||||||
```
|
|
||||||
import {execaCommand} from 'execa';
|
|
||||||
|
|
||||||
const {stdout} = await execaCommand('echo unicorns');
|
|
||||||
console.log(stdout);
|
|
||||||
//=> 'unicorns'
|
|
||||||
```
|
|
||||||
*/
|
|
||||||
export function execaCommand(command: string, options?: Options): ExecaChildProcess;
|
|
||||||
export function execaCommand(command: string, options?: Options<null>): ExecaChildProcess<Buffer>;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Same as `execaCommand()` but synchronous.
|
|
||||||
|
|
||||||
@param command - The program/script to execute and its arguments.
|
|
||||||
@returns A result `Object` with `stdout` and `stderr` properties.
|
|
||||||
*/
|
|
||||||
export function execaCommandSync(command: string, options?: SyncOptions): ExecaSyncReturnValue;
|
|
||||||
export function execaCommandSync(command: string, options?: SyncOptions<null>): ExecaSyncReturnValue<Buffer>;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Execute a Node.js script as a child process.
|
|
||||||
|
|
||||||
Same as `execa('node', [scriptPath, ...arguments], options)` except (like [`child_process#fork()`](https://nodejs.org/api/child_process.html#child_process_child_process_fork_modulepath_args_options)):
|
|
||||||
- the current Node version and options are used. This can be overridden using the `nodePath` and `nodeArguments` options.
|
|
||||||
- the `shell` option cannot be used
|
|
||||||
- an extra channel [`ipc`](https://nodejs.org/api/child_process.html#child_process_options_stdio) is passed to [`stdio`](#stdio)
|
|
||||||
|
|
||||||
@param scriptPath - Node.js script to execute.
|
|
||||||
@param arguments - Arguments to pass to `scriptPath` on execution.
|
|
||||||
@returns A [`child_process` instance](https://nodejs.org/api/child_process.html#child_process_class_childprocess), which is enhanced to also be a `Promise` for a result `Object` with `stdout` and `stderr` properties.
|
|
||||||
*/
|
|
||||||
export function execaNode(
|
|
||||||
scriptPath: string,
|
|
||||||
arguments?: readonly string[],
|
|
||||||
options?: NodeOptions
|
|
||||||
): ExecaChildProcess;
|
|
||||||
export function execaNode(
|
|
||||||
scriptPath: string,
|
|
||||||
arguments?: readonly string[],
|
|
||||||
options?: Options<null>
|
|
||||||
): ExecaChildProcess<Buffer>;
|
|
||||||
export function execaNode(scriptPath: string, options?: Options): ExecaChildProcess;
|
|
||||||
export function execaNode(scriptPath: string, options?: Options<null>): ExecaChildProcess<Buffer>;
|
|
@ -1,267 +0,0 @@
|
|||||||
import {Buffer} from 'node:buffer';
|
|
||||||
import path from 'node:path';
|
|
||||||
import childProcess from 'node:child_process';
|
|
||||||
import process from 'node:process';
|
|
||||||
import crossSpawn from 'cross-spawn';
|
|
||||||
import stripFinalNewline from 'strip-final-newline';
|
|
||||||
import {npmRunPathEnv} from 'npm-run-path';
|
|
||||||
import onetime from 'onetime';
|
|
||||||
import {makeError} from './lib/error.js';
|
|
||||||
import {normalizeStdio, normalizeStdioNode} from './lib/stdio.js';
|
|
||||||
import {spawnedKill, spawnedCancel, setupTimeout, validateTimeout, setExitHandler} from './lib/kill.js';
|
|
||||||
import {handleInput, getSpawnedResult, makeAllStream, validateInputSync} from './lib/stream.js';
|
|
||||||
import {mergePromise, getSpawnedPromise} from './lib/promise.js';
|
|
||||||
import {joinCommand, parseCommand, getEscapedCommand} from './lib/command.js';
|
|
||||||
|
|
||||||
const DEFAULT_MAX_BUFFER = 1000 * 1000 * 100;
|
|
||||||
|
|
||||||
const getEnv = ({env: envOption, extendEnv, preferLocal, localDir, execPath}) => {
|
|
||||||
const env = extendEnv ? {...process.env, ...envOption} : envOption;
|
|
||||||
|
|
||||||
if (preferLocal) {
|
|
||||||
return npmRunPathEnv({env, cwd: localDir, execPath});
|
|
||||||
}
|
|
||||||
|
|
||||||
return env;
|
|
||||||
};
|
|
||||||
|
|
||||||
const handleArguments = (file, args, options = {}) => {
|
|
||||||
const parsed = crossSpawn._parse(file, args, options);
|
|
||||||
file = parsed.command;
|
|
||||||
args = parsed.args;
|
|
||||||
options = parsed.options;
|
|
||||||
|
|
||||||
options = {
|
|
||||||
maxBuffer: DEFAULT_MAX_BUFFER,
|
|
||||||
buffer: true,
|
|
||||||
stripFinalNewline: true,
|
|
||||||
extendEnv: true,
|
|
||||||
preferLocal: false,
|
|
||||||
localDir: options.cwd || process.cwd(),
|
|
||||||
execPath: process.execPath,
|
|
||||||
encoding: 'utf8',
|
|
||||||
reject: true,
|
|
||||||
cleanup: true,
|
|
||||||
all: false,
|
|
||||||
windowsHide: true,
|
|
||||||
...options,
|
|
||||||
};
|
|
||||||
|
|
||||||
options.env = getEnv(options);
|
|
||||||
|
|
||||||
options.stdio = normalizeStdio(options);
|
|
||||||
|
|
||||||
if (process.platform === 'win32' && path.basename(file, '.exe') === 'cmd') {
|
|
||||||
// #116
|
|
||||||
args.unshift('/q');
|
|
||||||
}
|
|
||||||
|
|
||||||
return {file, args, options, parsed};
|
|
||||||
};
|
|
||||||
|
|
||||||
const handleOutput = (options, value, error) => {
|
|
||||||
if (typeof value !== 'string' && !Buffer.isBuffer(value)) {
|
|
||||||
// When `execaSync()` errors, we normalize it to '' to mimic `execa()`
|
|
||||||
return error === undefined ? undefined : '';
|
|
||||||
}
|
|
||||||
|
|
||||||
if (options.stripFinalNewline) {
|
|
||||||
return stripFinalNewline(value);
|
|
||||||
}
|
|
||||||
|
|
||||||
return value;
|
|
||||||
};
|
|
||||||
|
|
||||||
export function execa(file, args, options) {
|
|
||||||
const parsed = handleArguments(file, args, options);
|
|
||||||
const command = joinCommand(file, args);
|
|
||||||
const escapedCommand = getEscapedCommand(file, args);
|
|
||||||
|
|
||||||
validateTimeout(parsed.options);
|
|
||||||
|
|
||||||
let spawned;
|
|
||||||
try {
|
|
||||||
spawned = childProcess.spawn(parsed.file, parsed.args, parsed.options);
|
|
||||||
} catch (error) {
|
|
||||||
// Ensure the returned error is always both a promise and a child process
|
|
||||||
const dummySpawned = new childProcess.ChildProcess();
|
|
||||||
const errorPromise = Promise.reject(makeError({
|
|
||||||
error,
|
|
||||||
stdout: '',
|
|
||||||
stderr: '',
|
|
||||||
all: '',
|
|
||||||
command,
|
|
||||||
escapedCommand,
|
|
||||||
parsed,
|
|
||||||
timedOut: false,
|
|
||||||
isCanceled: false,
|
|
||||||
killed: false,
|
|
||||||
}));
|
|
||||||
return mergePromise(dummySpawned, errorPromise);
|
|
||||||
}
|
|
||||||
|
|
||||||
const spawnedPromise = getSpawnedPromise(spawned);
|
|
||||||
const timedPromise = setupTimeout(spawned, parsed.options, spawnedPromise);
|
|
||||||
const processDone = setExitHandler(spawned, parsed.options, timedPromise);
|
|
||||||
|
|
||||||
const context = {isCanceled: false};
|
|
||||||
|
|
||||||
spawned.kill = spawnedKill.bind(null, spawned.kill.bind(spawned));
|
|
||||||
spawned.cancel = spawnedCancel.bind(null, spawned, context);
|
|
||||||
|
|
||||||
const handlePromise = async () => {
|
|
||||||
const [{error, exitCode, signal, timedOut}, stdoutResult, stderrResult, allResult] = await getSpawnedResult(spawned, parsed.options, processDone);
|
|
||||||
const stdout = handleOutput(parsed.options, stdoutResult);
|
|
||||||
const stderr = handleOutput(parsed.options, stderrResult);
|
|
||||||
const all = handleOutput(parsed.options, allResult);
|
|
||||||
|
|
||||||
if (error || exitCode !== 0 || signal !== null) {
|
|
||||||
const returnedError = makeError({
|
|
||||||
error,
|
|
||||||
exitCode,
|
|
||||||
signal,
|
|
||||||
stdout,
|
|
||||||
stderr,
|
|
||||||
all,
|
|
||||||
command,
|
|
||||||
escapedCommand,
|
|
||||||
parsed,
|
|
||||||
timedOut,
|
|
||||||
isCanceled: context.isCanceled || (parsed.options.signal ? parsed.options.signal.aborted : false),
|
|
||||||
killed: spawned.killed,
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!parsed.options.reject) {
|
|
||||||
return returnedError;
|
|
||||||
}
|
|
||||||
|
|
||||||
throw returnedError;
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
command,
|
|
||||||
escapedCommand,
|
|
||||||
exitCode: 0,
|
|
||||||
stdout,
|
|
||||||
stderr,
|
|
||||||
all,
|
|
||||||
failed: false,
|
|
||||||
timedOut: false,
|
|
||||||
isCanceled: false,
|
|
||||||
killed: false,
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
const handlePromiseOnce = onetime(handlePromise);
|
|
||||||
|
|
||||||
handleInput(spawned, parsed.options.input);
|
|
||||||
|
|
||||||
spawned.all = makeAllStream(spawned, parsed.options);
|
|
||||||
|
|
||||||
return mergePromise(spawned, handlePromiseOnce);
|
|
||||||
}
|
|
||||||
|
|
||||||
export function execaSync(file, args, options) {
|
|
||||||
const parsed = handleArguments(file, args, options);
|
|
||||||
const command = joinCommand(file, args);
|
|
||||||
const escapedCommand = getEscapedCommand(file, args);
|
|
||||||
|
|
||||||
validateInputSync(parsed.options);
|
|
||||||
|
|
||||||
let result;
|
|
||||||
try {
|
|
||||||
result = childProcess.spawnSync(parsed.file, parsed.args, parsed.options);
|
|
||||||
} catch (error) {
|
|
||||||
throw makeError({
|
|
||||||
error,
|
|
||||||
stdout: '',
|
|
||||||
stderr: '',
|
|
||||||
all: '',
|
|
||||||
command,
|
|
||||||
escapedCommand,
|
|
||||||
parsed,
|
|
||||||
timedOut: false,
|
|
||||||
isCanceled: false,
|
|
||||||
killed: false,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
const stdout = handleOutput(parsed.options, result.stdout, result.error);
|
|
||||||
const stderr = handleOutput(parsed.options, result.stderr, result.error);
|
|
||||||
|
|
||||||
if (result.error || result.status !== 0 || result.signal !== null) {
|
|
||||||
const error = makeError({
|
|
||||||
stdout,
|
|
||||||
stderr,
|
|
||||||
error: result.error,
|
|
||||||
signal: result.signal,
|
|
||||||
exitCode: result.status,
|
|
||||||
command,
|
|
||||||
escapedCommand,
|
|
||||||
parsed,
|
|
||||||
timedOut: result.error && result.error.code === 'ETIMEDOUT',
|
|
||||||
isCanceled: false,
|
|
||||||
killed: result.signal !== null,
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!parsed.options.reject) {
|
|
||||||
return error;
|
|
||||||
}
|
|
||||||
|
|
||||||
throw error;
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
command,
|
|
||||||
escapedCommand,
|
|
||||||
exitCode: 0,
|
|
||||||
stdout,
|
|
||||||
stderr,
|
|
||||||
failed: false,
|
|
||||||
timedOut: false,
|
|
||||||
isCanceled: false,
|
|
||||||
killed: false,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
export function execaCommand(command, options) {
|
|
||||||
const [file, ...args] = parseCommand(command);
|
|
||||||
return execa(file, args, options);
|
|
||||||
}
|
|
||||||
|
|
||||||
export function execaCommandSync(command, options) {
|
|
||||||
const [file, ...args] = parseCommand(command);
|
|
||||||
return execaSync(file, args, options);
|
|
||||||
}
|
|
||||||
|
|
||||||
export function execaNode(scriptPath, args, options = {}) {
|
|
||||||
if (args && !Array.isArray(args) && typeof args === 'object') {
|
|
||||||
options = args;
|
|
||||||
args = [];
|
|
||||||
}
|
|
||||||
|
|
||||||
const stdio = normalizeStdioNode(options);
|
|
||||||
const defaultExecArgv = process.execArgv.filter(arg => !arg.startsWith('--inspect'));
|
|
||||||
|
|
||||||
const {
|
|
||||||
nodePath = process.execPath,
|
|
||||||
nodeOptions = defaultExecArgv,
|
|
||||||
} = options;
|
|
||||||
|
|
||||||
return execa(
|
|
||||||
nodePath,
|
|
||||||
[
|
|
||||||
...nodeOptions,
|
|
||||||
scriptPath,
|
|
||||||
...(Array.isArray(args) ? args : []),
|
|
||||||
],
|
|
||||||
{
|
|
||||||
...options,
|
|
||||||
stdin: undefined,
|
|
||||||
stdout: undefined,
|
|
||||||
stderr: undefined,
|
|
||||||
stdio,
|
|
||||||
shell: false,
|
|
||||||
},
|
|
||||||
);
|
|
||||||
}
|
|
@ -1,41 +0,0 @@
|
|||||||
const normalizeArgs = (file, args = []) => {
|
|
||||||
if (!Array.isArray(args)) {
|
|
||||||
return [file];
|
|
||||||
}
|
|
||||||
|
|
||||||
return [file, ...args];
|
|
||||||
};
|
|
||||||
|
|
||||||
const NO_ESCAPE_REGEXP = /^[\w.-]+$/;
|
|
||||||
const DOUBLE_QUOTES_REGEXP = /"/g;
|
|
||||||
|
|
||||||
const escapeArg = arg => {
|
|
||||||
if (typeof arg !== 'string' || NO_ESCAPE_REGEXP.test(arg)) {
|
|
||||||
return arg;
|
|
||||||
}
|
|
||||||
|
|
||||||
return `"${arg.replace(DOUBLE_QUOTES_REGEXP, '\\"')}"`;
|
|
||||||
};
|
|
||||||
|
|
||||||
export const joinCommand = (file, args) => normalizeArgs(file, args).join(' ');
|
|
||||||
|
|
||||||
export const getEscapedCommand = (file, args) => normalizeArgs(file, args).map(arg => escapeArg(arg)).join(' ');
|
|
||||||
|
|
||||||
const SPACES_REGEXP = / +/g;
|
|
||||||
|
|
||||||
// Handle `execaCommand()`
|
|
||||||
export const parseCommand = command => {
|
|
||||||
const tokens = [];
|
|
||||||
for (const token of command.trim().split(SPACES_REGEXP)) {
|
|
||||||
// Allow spaces to be escaped by a backslash if not meant as a delimiter
|
|
||||||
const previousToken = tokens[tokens.length - 1];
|
|
||||||
if (previousToken && previousToken.endsWith('\\')) {
|
|
||||||
// Merge previous token with current one
|
|
||||||
tokens[tokens.length - 1] = `${previousToken.slice(0, -1)} ${token}`;
|
|
||||||
} else {
|
|
||||||
tokens.push(token);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return tokens;
|
|
||||||
};
|
|
@ -1,85 +0,0 @@
|
|||||||
import {signalsByName} from 'human-signals';
|
|
||||||
|
|
||||||
const getErrorPrefix = ({timedOut, timeout, errorCode, signal, signalDescription, exitCode, isCanceled}) => {
|
|
||||||
if (timedOut) {
|
|
||||||
return `timed out after ${timeout} milliseconds`;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (isCanceled) {
|
|
||||||
return 'was canceled';
|
|
||||||
}
|
|
||||||
|
|
||||||
if (errorCode !== undefined) {
|
|
||||||
return `failed with ${errorCode}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (signal !== undefined) {
|
|
||||||
return `was killed with ${signal} (${signalDescription})`;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (exitCode !== undefined) {
|
|
||||||
return `failed with exit code ${exitCode}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
return 'failed';
|
|
||||||
};
|
|
||||||
|
|
||||||
export const makeError = ({
|
|
||||||
stdout,
|
|
||||||
stderr,
|
|
||||||
all,
|
|
||||||
error,
|
|
||||||
signal,
|
|
||||||
exitCode,
|
|
||||||
command,
|
|
||||||
escapedCommand,
|
|
||||||
timedOut,
|
|
||||||
isCanceled,
|
|
||||||
killed,
|
|
||||||
parsed: {options: {timeout}},
|
|
||||||
}) => {
|
|
||||||
// `signal` and `exitCode` emitted on `spawned.on('exit')` event can be `null`.
|
|
||||||
// We normalize them to `undefined`
|
|
||||||
exitCode = exitCode === null ? undefined : exitCode;
|
|
||||||
signal = signal === null ? undefined : signal;
|
|
||||||
const signalDescription = signal === undefined ? undefined : signalsByName[signal].description;
|
|
||||||
|
|
||||||
const errorCode = error && error.code;
|
|
||||||
|
|
||||||
const prefix = getErrorPrefix({timedOut, timeout, errorCode, signal, signalDescription, exitCode, isCanceled});
|
|
||||||
const execaMessage = `Command ${prefix}: ${command}`;
|
|
||||||
const isError = Object.prototype.toString.call(error) === '[object Error]';
|
|
||||||
const shortMessage = isError ? `${execaMessage}\n${error.message}` : execaMessage;
|
|
||||||
const message = [shortMessage, stderr, stdout].filter(Boolean).join('\n');
|
|
||||||
|
|
||||||
if (isError) {
|
|
||||||
error.originalMessage = error.message;
|
|
||||||
error.message = message;
|
|
||||||
} else {
|
|
||||||
error = new Error(message);
|
|
||||||
}
|
|
||||||
|
|
||||||
error.shortMessage = shortMessage;
|
|
||||||
error.command = command;
|
|
||||||
error.escapedCommand = escapedCommand;
|
|
||||||
error.exitCode = exitCode;
|
|
||||||
error.signal = signal;
|
|
||||||
error.signalDescription = signalDescription;
|
|
||||||
error.stdout = stdout;
|
|
||||||
error.stderr = stderr;
|
|
||||||
|
|
||||||
if (all !== undefined) {
|
|
||||||
error.all = all;
|
|
||||||
}
|
|
||||||
|
|
||||||
if ('bufferedData' in error) {
|
|
||||||
delete error.bufferedData;
|
|
||||||
}
|
|
||||||
|
|
||||||
error.failed = true;
|
|
||||||
error.timedOut = Boolean(timedOut);
|
|
||||||
error.isCanceled = isCanceled;
|
|
||||||
error.killed = killed && !timedOut;
|
|
||||||
|
|
||||||
return error;
|
|
||||||
};
|
|
@ -1,102 +0,0 @@
|
|||||||
import os from 'node:os';
|
|
||||||
import onExit from 'signal-exit';
|
|
||||||
|
|
||||||
const DEFAULT_FORCE_KILL_TIMEOUT = 1000 * 5;
|
|
||||||
|
|
||||||
// Monkey-patches `childProcess.kill()` to add `forceKillAfterTimeout` behavior
|
|
||||||
export const spawnedKill = (kill, signal = 'SIGTERM', options = {}) => {
|
|
||||||
const killResult = kill(signal);
|
|
||||||
setKillTimeout(kill, signal, options, killResult);
|
|
||||||
return killResult;
|
|
||||||
};
|
|
||||||
|
|
||||||
const setKillTimeout = (kill, signal, options, killResult) => {
|
|
||||||
if (!shouldForceKill(signal, options, killResult)) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const timeout = getForceKillAfterTimeout(options);
|
|
||||||
const t = setTimeout(() => {
|
|
||||||
kill('SIGKILL');
|
|
||||||
}, timeout);
|
|
||||||
|
|
||||||
// Guarded because there's no `.unref()` when `execa` is used in the renderer
|
|
||||||
// process in Electron. This cannot be tested since we don't run tests in
|
|
||||||
// Electron.
|
|
||||||
// istanbul ignore else
|
|
||||||
if (t.unref) {
|
|
||||||
t.unref();
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
const shouldForceKill = (signal, {forceKillAfterTimeout}, killResult) => isSigterm(signal) && forceKillAfterTimeout !== false && killResult;
|
|
||||||
|
|
||||||
const isSigterm = signal => signal === os.constants.signals.SIGTERM
|
|
||||||
|| (typeof signal === 'string' && signal.toUpperCase() === 'SIGTERM');
|
|
||||||
|
|
||||||
const getForceKillAfterTimeout = ({forceKillAfterTimeout = true}) => {
|
|
||||||
if (forceKillAfterTimeout === true) {
|
|
||||||
return DEFAULT_FORCE_KILL_TIMEOUT;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!Number.isFinite(forceKillAfterTimeout) || forceKillAfterTimeout < 0) {
|
|
||||||
throw new TypeError(`Expected the \`forceKillAfterTimeout\` option to be a non-negative integer, got \`${forceKillAfterTimeout}\` (${typeof forceKillAfterTimeout})`);
|
|
||||||
}
|
|
||||||
|
|
||||||
return forceKillAfterTimeout;
|
|
||||||
};
|
|
||||||
|
|
||||||
// `childProcess.cancel()`
|
|
||||||
export const spawnedCancel = (spawned, context) => {
|
|
||||||
const killResult = spawned.kill();
|
|
||||||
|
|
||||||
if (killResult) {
|
|
||||||
context.isCanceled = true;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
const timeoutKill = (spawned, signal, reject) => {
|
|
||||||
spawned.kill(signal);
|
|
||||||
reject(Object.assign(new Error('Timed out'), {timedOut: true, signal}));
|
|
||||||
};
|
|
||||||
|
|
||||||
// `timeout` option handling
|
|
||||||
export const setupTimeout = (spawned, {timeout, killSignal = 'SIGTERM'}, spawnedPromise) => {
|
|
||||||
if (timeout === 0 || timeout === undefined) {
|
|
||||||
return spawnedPromise;
|
|
||||||
}
|
|
||||||
|
|
||||||
let timeoutId;
|
|
||||||
const timeoutPromise = new Promise((resolve, reject) => {
|
|
||||||
timeoutId = setTimeout(() => {
|
|
||||||
timeoutKill(spawned, killSignal, reject);
|
|
||||||
}, timeout);
|
|
||||||
});
|
|
||||||
|
|
||||||
const safeSpawnedPromise = spawnedPromise.finally(() => {
|
|
||||||
clearTimeout(timeoutId);
|
|
||||||
});
|
|
||||||
|
|
||||||
return Promise.race([timeoutPromise, safeSpawnedPromise]);
|
|
||||||
};
|
|
||||||
|
|
||||||
export const validateTimeout = ({timeout}) => {
|
|
||||||
if (timeout !== undefined && (!Number.isFinite(timeout) || timeout < 0)) {
|
|
||||||
throw new TypeError(`Expected the \`timeout\` option to be a non-negative integer, got \`${timeout}\` (${typeof timeout})`);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
// `cleanup` option handling
|
|
||||||
export const setExitHandler = async (spawned, {cleanup, detached}, timedPromise) => {
|
|
||||||
if (!cleanup || detached) {
|
|
||||||
return timedPromise;
|
|
||||||
}
|
|
||||||
|
|
||||||
const removeExitHandler = onExit(() => {
|
|
||||||
spawned.kill();
|
|
||||||
});
|
|
||||||
|
|
||||||
return timedPromise.finally(() => {
|
|
||||||
removeExitHandler();
|
|
||||||
});
|
|
||||||
};
|
|
@ -1,36 +0,0 @@
|
|||||||
const nativePromisePrototype = (async () => {})().constructor.prototype;
|
|
||||||
const descriptors = ['then', 'catch', 'finally'].map(property => [
|
|
||||||
property,
|
|
||||||
Reflect.getOwnPropertyDescriptor(nativePromisePrototype, property),
|
|
||||||
]);
|
|
||||||
|
|
||||||
// The return value is a mixin of `childProcess` and `Promise`
|
|
||||||
export const mergePromise = (spawned, promise) => {
|
|
||||||
for (const [property, descriptor] of descriptors) {
|
|
||||||
// Starting the main `promise` is deferred to avoid consuming streams
|
|
||||||
const value = typeof promise === 'function'
|
|
||||||
? (...args) => Reflect.apply(descriptor.value, promise(), args)
|
|
||||||
: descriptor.value.bind(promise);
|
|
||||||
|
|
||||||
Reflect.defineProperty(spawned, property, {...descriptor, value});
|
|
||||||
}
|
|
||||||
|
|
||||||
return spawned;
|
|
||||||
};
|
|
||||||
|
|
||||||
// Use promises instead of `child_process` events
|
|
||||||
export const getSpawnedPromise = spawned => new Promise((resolve, reject) => {
|
|
||||||
spawned.on('exit', (exitCode, signal) => {
|
|
||||||
resolve({exitCode, signal});
|
|
||||||
});
|
|
||||||
|
|
||||||
spawned.on('error', error => {
|
|
||||||
reject(error);
|
|
||||||
});
|
|
||||||
|
|
||||||
if (spawned.stdin) {
|
|
||||||
spawned.stdin.on('error', error => {
|
|
||||||
reject(error);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
});
|
|
@ -1,49 +0,0 @@
|
|||||||
const aliases = ['stdin', 'stdout', 'stderr'];
|
|
||||||
|
|
||||||
const hasAlias = options => aliases.some(alias => options[alias] !== undefined);
|
|
||||||
|
|
||||||
export const normalizeStdio = options => {
|
|
||||||
if (!options) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const {stdio} = options;
|
|
||||||
|
|
||||||
if (stdio === undefined) {
|
|
||||||
return aliases.map(alias => options[alias]);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (hasAlias(options)) {
|
|
||||||
throw new Error(`It's not possible to provide \`stdio\` in combination with one of ${aliases.map(alias => `\`${alias}\``).join(', ')}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (typeof stdio === 'string') {
|
|
||||||
return stdio;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!Array.isArray(stdio)) {
|
|
||||||
throw new TypeError(`Expected \`stdio\` to be of type \`string\` or \`Array\`, got \`${typeof stdio}\``);
|
|
||||||
}
|
|
||||||
|
|
||||||
const length = Math.max(stdio.length, aliases.length);
|
|
||||||
return Array.from({length}, (value, index) => stdio[index]);
|
|
||||||
};
|
|
||||||
|
|
||||||
// `ipc` is pushed unless it is already present
|
|
||||||
export const normalizeStdioNode = options => {
|
|
||||||
const stdio = normalizeStdio(options);
|
|
||||||
|
|
||||||
if (stdio === 'ipc') {
|
|
||||||
return 'ipc';
|
|
||||||
}
|
|
||||||
|
|
||||||
if (stdio === undefined || typeof stdio === 'string') {
|
|
||||||
return [stdio, stdio, stdio, 'ipc'];
|
|
||||||
}
|
|
||||||
|
|
||||||
if (stdio.includes('ipc')) {
|
|
||||||
return stdio;
|
|
||||||
}
|
|
||||||
|
|
||||||
return [...stdio, 'ipc'];
|
|
||||||
};
|
|
@ -1,88 +0,0 @@
|
|||||||
import {isStream} from 'is-stream';
|
|
||||||
import getStream from 'get-stream';
|
|
||||||
import mergeStream from 'merge-stream';
|
|
||||||
|
|
||||||
// `input` option
|
|
||||||
export const handleInput = (spawned, input) => {
|
|
||||||
// Checking for stdin is workaround for https://github.com/nodejs/node/issues/26852
|
|
||||||
// @todo remove `|| spawned.stdin === undefined` once we drop support for Node.js <=12.2.0
|
|
||||||
if (input === undefined || spawned.stdin === undefined) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (isStream(input)) {
|
|
||||||
input.pipe(spawned.stdin);
|
|
||||||
} else {
|
|
||||||
spawned.stdin.end(input);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
// `all` interleaves `stdout` and `stderr`
|
|
||||||
export const makeAllStream = (spawned, {all}) => {
|
|
||||||
if (!all || (!spawned.stdout && !spawned.stderr)) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const mixed = mergeStream();
|
|
||||||
|
|
||||||
if (spawned.stdout) {
|
|
||||||
mixed.add(spawned.stdout);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (spawned.stderr) {
|
|
||||||
mixed.add(spawned.stderr);
|
|
||||||
}
|
|
||||||
|
|
||||||
return mixed;
|
|
||||||
};
|
|
||||||
|
|
||||||
// On failure, `result.stdout|stderr|all` should contain the currently buffered stream
|
|
||||||
const getBufferedData = async (stream, streamPromise) => {
|
|
||||||
if (!stream) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
stream.destroy();
|
|
||||||
|
|
||||||
try {
|
|
||||||
return await streamPromise;
|
|
||||||
} catch (error) {
|
|
||||||
return error.bufferedData;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
const getStreamPromise = (stream, {encoding, buffer, maxBuffer}) => {
|
|
||||||
if (!stream || !buffer) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (encoding) {
|
|
||||||
return getStream(stream, {encoding, maxBuffer});
|
|
||||||
}
|
|
||||||
|
|
||||||
return getStream.buffer(stream, {maxBuffer});
|
|
||||||
};
|
|
||||||
|
|
||||||
// Retrieve result of child process: exit code, signal, error, streams (stdout/stderr/all)
|
|
||||||
export const getSpawnedResult = async ({stdout, stderr, all}, {encoding, buffer, maxBuffer}, processDone) => {
|
|
||||||
const stdoutPromise = getStreamPromise(stdout, {encoding, buffer, maxBuffer});
|
|
||||||
const stderrPromise = getStreamPromise(stderr, {encoding, buffer, maxBuffer});
|
|
||||||
const allPromise = getStreamPromise(all, {encoding, buffer, maxBuffer: maxBuffer * 2});
|
|
||||||
|
|
||||||
try {
|
|
||||||
return await Promise.all([processDone, stdoutPromise, stderrPromise, allPromise]);
|
|
||||||
} catch (error) {
|
|
||||||
return Promise.all([
|
|
||||||
{error, signal: error.signal, timedOut: error.timedOut},
|
|
||||||
getBufferedData(stdout, stdoutPromise),
|
|
||||||
getBufferedData(stderr, stderrPromise),
|
|
||||||
getBufferedData(all, allPromise),
|
|
||||||
]);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
export const validateInputSync = ({input}) => {
|
|
||||||
if (isStream(input)) {
|
|
||||||
throw new TypeError('The `input` option cannot be a stream in sync mode');
|
|
||||||
}
|
|
||||||
};
|
|
@ -1,9 +0,0 @@
|
|||||||
MIT License
|
|
||||||
|
|
||||||
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
@ -1,83 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "execa",
|
|
||||||
"version": "6.1.0",
|
|
||||||
"description": "Process execution for humans",
|
|
||||||
"license": "MIT",
|
|
||||||
"repository": "sindresorhus/execa",
|
|
||||||
"funding": "https://github.com/sindresorhus/execa?sponsor=1",
|
|
||||||
"author": {
|
|
||||||
"name": "Sindre Sorhus",
|
|
||||||
"email": "sindresorhus@gmail.com",
|
|
||||||
"url": "https://sindresorhus.com"
|
|
||||||
},
|
|
||||||
"type": "module",
|
|
||||||
"exports": "./index.js",
|
|
||||||
"engines": {
|
|
||||||
"node": "^12.20.0 || ^14.13.1 || >=16.0.0"
|
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"test": "xo && c8 ava && tsd"
|
|
||||||
},
|
|
||||||
"files": [
|
|
||||||
"index.js",
|
|
||||||
"index.d.ts",
|
|
||||||
"lib"
|
|
||||||
],
|
|
||||||
"keywords": [
|
|
||||||
"exec",
|
|
||||||
"child",
|
|
||||||
"process",
|
|
||||||
"execute",
|
|
||||||
"fork",
|
|
||||||
"execfile",
|
|
||||||
"spawn",
|
|
||||||
"file",
|
|
||||||
"shell",
|
|
||||||
"bin",
|
|
||||||
"binary",
|
|
||||||
"binaries",
|
|
||||||
"npm",
|
|
||||||
"path",
|
|
||||||
"local"
|
|
||||||
],
|
|
||||||
"dependencies": {
|
|
||||||
"cross-spawn": "^7.0.3",
|
|
||||||
"get-stream": "^6.0.1",
|
|
||||||
"human-signals": "^3.0.1",
|
|
||||||
"is-stream": "^3.0.0",
|
|
||||||
"merge-stream": "^2.0.0",
|
|
||||||
"npm-run-path": "^5.1.0",
|
|
||||||
"onetime": "^6.0.0",
|
|
||||||
"signal-exit": "^3.0.7",
|
|
||||||
"strip-final-newline": "^3.0.0"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"@types/node": "^17.0.17",
|
|
||||||
"ava": "^4.0.1",
|
|
||||||
"c8": "^7.11.0",
|
|
||||||
"get-node": "^12.0.0",
|
|
||||||
"is-running": "^2.1.0",
|
|
||||||
"p-event": "^5.0.1",
|
|
||||||
"semver": "^7.3.5",
|
|
||||||
"tempfile": "^4.0.0",
|
|
||||||
"tsd": "^0.19.1",
|
|
||||||
"xo": "^0.48.0"
|
|
||||||
},
|
|
||||||
"c8": {
|
|
||||||
"reporter": [
|
|
||||||
"text",
|
|
||||||
"lcov"
|
|
||||||
],
|
|
||||||
"exclude": [
|
|
||||||
"**/fixtures/**",
|
|
||||||
"**/test.js",
|
|
||||||
"**/test/**"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"xo": {
|
|
||||||
"rules": {
|
|
||||||
"unicorn/no-empty-file": "off",
|
|
||||||
"@typescript-eslint/ban-types": "off"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,667 +0,0 @@
|
|||||||
<img src="media/logo.svg" width="400">
|
|
||||||
<br>
|
|
||||||
|
|
||||||
[![Coverage Status](https://codecov.io/gh/sindresorhus/execa/branch/main/graph/badge.svg)](https://codecov.io/gh/sindresorhus/execa)
|
|
||||||
|
|
||||||
> Process execution for humans
|
|
||||||
|
|
||||||
## Why
|
|
||||||
|
|
||||||
This package improves [`child_process`](https://nodejs.org/api/child_process.html) methods with:
|
|
||||||
|
|
||||||
- Promise interface.
|
|
||||||
- [Strips the final newline](#stripfinalnewline) from the output so you don't have to do `stdout.trim()`.
|
|
||||||
- Supports [shebang](https://en.wikipedia.org/wiki/Shebang_(Unix)) binaries cross-platform.
|
|
||||||
- [Improved Windows support.](https://github.com/IndigoUnited/node-cross-spawn#why)
|
|
||||||
- Higher max buffer. 100 MB instead of 200 KB.
|
|
||||||
- [Executes locally installed binaries by name.](#preferlocal)
|
|
||||||
- [Cleans up spawned processes when the parent process dies.](#cleanup)
|
|
||||||
- [Get interleaved output](#all) from `stdout` and `stderr` similar to what is printed on the terminal. [*(Async only)*](#execasyncfile-arguments-options)
|
|
||||||
- [Can specify file and arguments as a single string without a shell](#execacommandcommand-options)
|
|
||||||
- More descriptive errors.
|
|
||||||
|
|
||||||
## Install
|
|
||||||
|
|
||||||
```sh
|
|
||||||
npm install execa
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```js
|
|
||||||
import {execa} from 'execa';
|
|
||||||
|
|
||||||
const {stdout} = await execa('echo', ['unicorns']);
|
|
||||||
console.log(stdout);
|
|
||||||
//=> 'unicorns'
|
|
||||||
```
|
|
||||||
|
|
||||||
### Pipe the child process stdout to the parent
|
|
||||||
|
|
||||||
```js
|
|
||||||
import {execa} from 'execa';
|
|
||||||
|
|
||||||
execa('echo', ['unicorns']).stdout.pipe(process.stdout);
|
|
||||||
```
|
|
||||||
|
|
||||||
### Handling Errors
|
|
||||||
|
|
||||||
```js
|
|
||||||
import {execa} from 'execa';
|
|
||||||
|
|
||||||
// Catching an error
|
|
||||||
try {
|
|
||||||
await execa('unknown', ['command']);
|
|
||||||
} catch (error) {
|
|
||||||
console.log(error);
|
|
||||||
/*
|
|
||||||
{
|
|
||||||
message: 'Command failed with ENOENT: unknown command spawn unknown ENOENT',
|
|
||||||
errno: -2,
|
|
||||||
code: 'ENOENT',
|
|
||||||
syscall: 'spawn unknown',
|
|
||||||
path: 'unknown',
|
|
||||||
spawnargs: ['command'],
|
|
||||||
originalMessage: 'spawn unknown ENOENT',
|
|
||||||
shortMessage: 'Command failed with ENOENT: unknown command spawn unknown ENOENT',
|
|
||||||
command: 'unknown command',
|
|
||||||
escapedCommand: 'unknown command',
|
|
||||||
stdout: '',
|
|
||||||
stderr: '',
|
|
||||||
all: '',
|
|
||||||
failed: true,
|
|
||||||
timedOut: false,
|
|
||||||
isCanceled: false,
|
|
||||||
killed: false
|
|
||||||
}
|
|
||||||
*/
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Cancelling a spawned process
|
|
||||||
|
|
||||||
```js
|
|
||||||
import {execa} from 'execa';
|
|
||||||
|
|
||||||
const abortController = new AbortController();
|
|
||||||
const subprocess = execa('node', [], {signal: abortController.signal});
|
|
||||||
|
|
||||||
setTimeout(() => {
|
|
||||||
abortController.abort();
|
|
||||||
}, 1000);
|
|
||||||
|
|
||||||
try {
|
|
||||||
await subprocess;
|
|
||||||
} catch (error) {
|
|
||||||
console.log(subprocess.killed); // true
|
|
||||||
console.log(error.isCanceled); // true
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Catching an error with the sync method
|
|
||||||
|
|
||||||
```js
|
|
||||||
import {execaSync} from 'execa';
|
|
||||||
|
|
||||||
try {
|
|
||||||
execaSync('unknown', ['command']);
|
|
||||||
} catch (error) {
|
|
||||||
console.log(error);
|
|
||||||
/*
|
|
||||||
{
|
|
||||||
message: 'Command failed with ENOENT: unknown command spawnSync unknown ENOENT',
|
|
||||||
errno: -2,
|
|
||||||
code: 'ENOENT',
|
|
||||||
syscall: 'spawnSync unknown',
|
|
||||||
path: 'unknown',
|
|
||||||
spawnargs: ['command'],
|
|
||||||
originalMessage: 'spawnSync unknown ENOENT',
|
|
||||||
shortMessage: 'Command failed with ENOENT: unknown command spawnSync unknown ENOENT',
|
|
||||||
command: 'unknown command',
|
|
||||||
escapedCommand: 'unknown command',
|
|
||||||
stdout: '',
|
|
||||||
stderr: '',
|
|
||||||
all: '',
|
|
||||||
failed: true,
|
|
||||||
timedOut: false,
|
|
||||||
isCanceled: false,
|
|
||||||
killed: false
|
|
||||||
}
|
|
||||||
*/
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Kill a process
|
|
||||||
|
|
||||||
Using SIGTERM, and after 2 seconds, kill it with SIGKILL.
|
|
||||||
|
|
||||||
```js
|
|
||||||
const subprocess = execa('node');
|
|
||||||
|
|
||||||
setTimeout(() => {
|
|
||||||
subprocess.kill('SIGTERM', {
|
|
||||||
forceKillAfterTimeout: 2000
|
|
||||||
});
|
|
||||||
}, 1000);
|
|
||||||
```
|
|
||||||
|
|
||||||
## API
|
|
||||||
|
|
||||||
### execa(file, arguments, options?)
|
|
||||||
|
|
||||||
Execute a file. Think of this as a mix of [`child_process.execFile()`](https://nodejs.org/api/child_process.html#child_process_child_process_execfile_file_args_options_callback) and [`child_process.spawn()`](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options).
|
|
||||||
|
|
||||||
No escaping/quoting is needed.
|
|
||||||
|
|
||||||
Unless the [`shell`](#shell) option is used, no shell interpreter (Bash, `cmd.exe`, etc.) is used, so shell features such as variables substitution (`echo $PATH`) are not allowed.
|
|
||||||
|
|
||||||
Returns a [`child_process` instance](https://nodejs.org/api/child_process.html#child_process_class_childprocess) which:
|
|
||||||
- is also a `Promise` resolving or rejecting with a [`childProcessResult`](#childProcessResult).
|
|
||||||
- exposes the following additional methods and properties.
|
|
||||||
|
|
||||||
#### kill(signal?, options?)
|
|
||||||
|
|
||||||
Same as the original [`child_process#kill()`](https://nodejs.org/api/child_process.html#child_process_subprocess_kill_signal) except: if `signal` is `SIGTERM` (the default value) and the child process is not terminated after 5 seconds, force it by sending `SIGKILL`.
|
|
||||||
|
|
||||||
##### options.forceKillAfterTimeout
|
|
||||||
|
|
||||||
Type: `number | false`\
|
|
||||||
Default: `5000`
|
|
||||||
|
|
||||||
Milliseconds to wait for the child process to terminate before sending `SIGKILL`.
|
|
||||||
|
|
||||||
Can be disabled with `false`.
|
|
||||||
|
|
||||||
#### all
|
|
||||||
|
|
||||||
Type: `ReadableStream | undefined`
|
|
||||||
|
|
||||||
Stream combining/interleaving [`stdout`](https://nodejs.org/api/child_process.html#child_process_subprocess_stdout) and [`stderr`](https://nodejs.org/api/child_process.html#child_process_subprocess_stderr).
|
|
||||||
|
|
||||||
This is `undefined` if either:
|
|
||||||
- the [`all` option](#all-2) is `false` (the default value)
|
|
||||||
- both [`stdout`](#stdout-1) and [`stderr`](#stderr-1) options are set to [`'inherit'`, `'ipc'`, `Stream` or `integer`](https://nodejs.org/dist/latest-v6.x/docs/api/child_process.html#child_process_options_stdio)
|
|
||||||
|
|
||||||
### execaSync(file, arguments?, options?)
|
|
||||||
|
|
||||||
Execute a file synchronously.
|
|
||||||
|
|
||||||
Returns or throws a [`childProcessResult`](#childProcessResult).
|
|
||||||
|
|
||||||
### execaCommand(command, options?)
|
|
||||||
|
|
||||||
Same as [`execa()`](#execafile-arguments-options) except both file and arguments are specified in a single `command` string. For example, `execa('echo', ['unicorns'])` is the same as `execaCommand('echo unicorns')`.
|
|
||||||
|
|
||||||
If the file or an argument contains spaces, they must be escaped with backslashes. This matters especially if `command` is not a constant but a variable, for example with `__dirname` or `process.cwd()`. Except for spaces, no escaping/quoting is needed.
|
|
||||||
|
|
||||||
The [`shell` option](#shell) must be used if the `command` uses shell-specific features (for example, `&&` or `||`), as opposed to being a simple `file` followed by its `arguments`.
|
|
||||||
|
|
||||||
### execaCommandSync(command, options?)
|
|
||||||
|
|
||||||
Same as [`execaCommand()`](#execacommand-command-options) but synchronous.
|
|
||||||
|
|
||||||
Returns or throws a [`childProcessResult`](#childProcessResult).
|
|
||||||
|
|
||||||
### execaNode(scriptPath, arguments?, options?)
|
|
||||||
|
|
||||||
Execute a Node.js script as a child process.
|
|
||||||
|
|
||||||
Same as `execa('node', [scriptPath, ...arguments], options)` except (like [`child_process#fork()`](https://nodejs.org/api/child_process.html#child_process_child_process_fork_modulepath_args_options)):
|
|
||||||
- the current Node version and options are used. This can be overridden using the [`nodePath`](#nodepath-for-node-only) and [`nodeOptions`](#nodeoptions-for-node-only) options.
|
|
||||||
- the [`shell`](#shell) option cannot be used
|
|
||||||
- an extra channel [`ipc`](https://nodejs.org/api/child_process.html#child_process_options_stdio) is passed to [`stdio`](#stdio)
|
|
||||||
|
|
||||||
### childProcessResult
|
|
||||||
|
|
||||||
Type: `object`
|
|
||||||
|
|
||||||
Result of a child process execution. On success this is a plain object. On failure this is also an `Error` instance.
|
|
||||||
|
|
||||||
The child process [fails](#failed) when:
|
|
||||||
- its [exit code](#exitcode) is not `0`
|
|
||||||
- it was [killed](#killed) with a [signal](#signal)
|
|
||||||
- [timing out](#timedout)
|
|
||||||
- [being canceled](#iscanceled)
|
|
||||||
- there's not enough memory or there are already too many child processes
|
|
||||||
|
|
||||||
#### command
|
|
||||||
|
|
||||||
Type: `string`
|
|
||||||
|
|
||||||
The file and arguments that were run, for logging purposes.
|
|
||||||
|
|
||||||
This is not escaped and should not be executed directly as a process, including using [`execa()`](#execafile-arguments-options) or [`execaCommand()`](#execacommandcommand-options).
|
|
||||||
|
|
||||||
#### escapedCommand
|
|
||||||
|
|
||||||
Type: `string`
|
|
||||||
|
|
||||||
Same as [`command`](#command) but escaped.
|
|
||||||
|
|
||||||
This is meant to be copy and pasted into a shell, for debugging purposes.
|
|
||||||
Since the escaping is fairly basic, this should not be executed directly as a process, including using [`execa()`](#execafile-arguments-options) or [`execaCommand()`](#execacommandcommand-options).
|
|
||||||
|
|
||||||
#### exitCode
|
|
||||||
|
|
||||||
Type: `number`
|
|
||||||
|
|
||||||
The numeric exit code of the process that was run.
|
|
||||||
|
|
||||||
#### stdout
|
|
||||||
|
|
||||||
Type: `string | Buffer`
|
|
||||||
|
|
||||||
The output of the process on stdout.
|
|
||||||
|
|
||||||
#### stderr
|
|
||||||
|
|
||||||
Type: `string | Buffer`
|
|
||||||
|
|
||||||
The output of the process on stderr.
|
|
||||||
|
|
||||||
#### all
|
|
||||||
|
|
||||||
Type: `string | Buffer | undefined`
|
|
||||||
|
|
||||||
The output of the process with `stdout` and `stderr` interleaved.
|
|
||||||
|
|
||||||
This is `undefined` if either:
|
|
||||||
- the [`all` option](#all-2) is `false` (the default value)
|
|
||||||
- `execaSync()` was used
|
|
||||||
|
|
||||||
#### failed
|
|
||||||
|
|
||||||
Type: `boolean`
|
|
||||||
|
|
||||||
Whether the process failed to run.
|
|
||||||
|
|
||||||
#### timedOut
|
|
||||||
|
|
||||||
Type: `boolean`
|
|
||||||
|
|
||||||
Whether the process timed out.
|
|
||||||
|
|
||||||
#### isCanceled
|
|
||||||
|
|
||||||
Type: `boolean`
|
|
||||||
|
|
||||||
Whether the process was canceled.
|
|
||||||
|
|
||||||
You can cancel the spawned process using the [`signal`](#signal-1) option.
|
|
||||||
|
|
||||||
#### killed
|
|
||||||
|
|
||||||
Type: `boolean`
|
|
||||||
|
|
||||||
Whether the process was killed.
|
|
||||||
|
|
||||||
#### signal
|
|
||||||
|
|
||||||
Type: `string | undefined`
|
|
||||||
|
|
||||||
The name of the signal that was used to terminate the process. For example, `SIGFPE`.
|
|
||||||
|
|
||||||
If a signal terminated the process, this property is defined and included in the error message. Otherwise it is `undefined`.
|
|
||||||
|
|
||||||
#### signalDescription
|
|
||||||
|
|
||||||
Type: `string | undefined`
|
|
||||||
|
|
||||||
A human-friendly description of the signal that was used to terminate the process. For example, `Floating point arithmetic error`.
|
|
||||||
|
|
||||||
If a signal terminated the process, this property is defined and included in the error message. Otherwise it is `undefined`. It is also `undefined` when the signal is very uncommon which should seldomly happen.
|
|
||||||
|
|
||||||
#### message
|
|
||||||
|
|
||||||
Type: `string`
|
|
||||||
|
|
||||||
Error message when the child process failed to run. In addition to the [underlying error message](#originalMessage), it also contains some information related to why the child process errored.
|
|
||||||
|
|
||||||
The child process [stderr](#stderr) then [stdout](#stdout) are appended to the end, separated with newlines and not interleaved.
|
|
||||||
|
|
||||||
#### shortMessage
|
|
||||||
|
|
||||||
Type: `string`
|
|
||||||
|
|
||||||
This is the same as the [`message` property](#message) except it does not include the child process stdout/stderr.
|
|
||||||
|
|
||||||
#### originalMessage
|
|
||||||
|
|
||||||
Type: `string | undefined`
|
|
||||||
|
|
||||||
Original error message. This is the same as the `message` property except it includes neither the child process stdout/stderr nor some additional information added by Execa.
|
|
||||||
|
|
||||||
This is `undefined` unless the child process exited due to an `error` event or a timeout.
|
|
||||||
|
|
||||||
### options
|
|
||||||
|
|
||||||
Type: `object`
|
|
||||||
|
|
||||||
#### cleanup
|
|
||||||
|
|
||||||
Type: `boolean`\
|
|
||||||
Default: `true`
|
|
||||||
|
|
||||||
Kill the spawned process when the parent process exits unless either:
|
|
||||||
- the spawned process is [`detached`](https://nodejs.org/api/child_process.html#child_process_options_detached)
|
|
||||||
- the parent process is terminated abruptly, for example, with `SIGKILL` as opposed to `SIGTERM` or a normal exit
|
|
||||||
|
|
||||||
#### preferLocal
|
|
||||||
|
|
||||||
Type: `boolean`\
|
|
||||||
Default: `false`
|
|
||||||
|
|
||||||
Prefer locally installed binaries when looking for a binary to execute.\
|
|
||||||
If you `$ npm install foo`, you can then `execa('foo')`.
|
|
||||||
|
|
||||||
#### localDir
|
|
||||||
|
|
||||||
Type: `string | URL`\
|
|
||||||
Default: `process.cwd()`
|
|
||||||
|
|
||||||
Preferred path to find locally installed binaries in (use with `preferLocal`).
|
|
||||||
|
|
||||||
Using a `URL` is only supported in Node.js `14.18.0`, `16.14.0` or above.
|
|
||||||
|
|
||||||
#### execPath
|
|
||||||
|
|
||||||
Type: `string`\
|
|
||||||
Default: `process.execPath` (Current Node.js executable)
|
|
||||||
|
|
||||||
Path to the Node.js executable to use in child processes.
|
|
||||||
|
|
||||||
This can be either an absolute path or a path relative to the [`cwd` option](#cwd).
|
|
||||||
|
|
||||||
Requires [`preferLocal`](#preferlocal) to be `true`.
|
|
||||||
|
|
||||||
For example, this can be used together with [`get-node`](https://github.com/ehmicky/get-node) to run a specific Node.js version in a child process.
|
|
||||||
|
|
||||||
#### buffer
|
|
||||||
|
|
||||||
Type: `boolean`\
|
|
||||||
Default: `true`
|
|
||||||
|
|
||||||
Buffer the output from the spawned process. When set to `false`, you must read the output of [`stdout`](#stdout-1) and [`stderr`](#stderr-1) (or [`all`](#all) if the [`all`](#all-2) option is `true`). Otherwise the returned promise will not be resolved/rejected.
|
|
||||||
|
|
||||||
If the spawned process fails, [`error.stdout`](#stdout), [`error.stderr`](#stderr), and [`error.all`](#all) will contain the buffered data.
|
|
||||||
|
|
||||||
#### input
|
|
||||||
|
|
||||||
Type: `string | Buffer | stream.Readable`
|
|
||||||
|
|
||||||
Write some input to the `stdin` of your binary.\
|
|
||||||
Streams are not allowed when using the synchronous methods.
|
|
||||||
|
|
||||||
#### stdin
|
|
||||||
|
|
||||||
Type: `string | number | Stream | undefined`\
|
|
||||||
Default: `pipe`
|
|
||||||
|
|
||||||
Same options as [`stdio`](https://nodejs.org/dist/latest-v6.x/docs/api/child_process.html#child_process_options_stdio).
|
|
||||||
|
|
||||||
#### stdout
|
|
||||||
|
|
||||||
Type: `string | number | Stream | undefined`\
|
|
||||||
Default: `pipe`
|
|
||||||
|
|
||||||
Same options as [`stdio`](https://nodejs.org/dist/latest-v6.x/docs/api/child_process.html#child_process_options_stdio).
|
|
||||||
|
|
||||||
#### stderr
|
|
||||||
|
|
||||||
Type: `string | number | Stream | undefined`\
|
|
||||||
Default: `pipe`
|
|
||||||
|
|
||||||
Same options as [`stdio`](https://nodejs.org/dist/latest-v6.x/docs/api/child_process.html#child_process_options_stdio).
|
|
||||||
|
|
||||||
#### all
|
|
||||||
|
|
||||||
Type: `boolean`\
|
|
||||||
Default: `false`
|
|
||||||
|
|
||||||
Add an `.all` property on the [promise](#all) and the [resolved value](#all-1). The property contains the output of the process with `stdout` and `stderr` interleaved.
|
|
||||||
|
|
||||||
#### reject
|
|
||||||
|
|
||||||
Type: `boolean`\
|
|
||||||
Default: `true`
|
|
||||||
|
|
||||||
Setting this to `false` resolves the promise with the error instead of rejecting it.
|
|
||||||
|
|
||||||
#### stripFinalNewline
|
|
||||||
|
|
||||||
Type: `boolean`\
|
|
||||||
Default: `true`
|
|
||||||
|
|
||||||
Strip the final [newline character](https://en.wikipedia.org/wiki/Newline) from the output.
|
|
||||||
|
|
||||||
#### extendEnv
|
|
||||||
|
|
||||||
Type: `boolean`\
|
|
||||||
Default: `true`
|
|
||||||
|
|
||||||
Set to `false` if you don't want to extend the environment variables when providing the `env` property.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Execa also accepts the below options which are the same as the options for [`child_process#spawn()`](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options)/[`child_process#exec()`](https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback)
|
|
||||||
|
|
||||||
#### cwd
|
|
||||||
|
|
||||||
Type: `string | URL`\
|
|
||||||
Default: `process.cwd()`
|
|
||||||
|
|
||||||
Current working directory of the child process.
|
|
||||||
|
|
||||||
Using a `URL` is only supported in Node.js `14.18.0`, `16.14.0` or above.
|
|
||||||
|
|
||||||
#### env
|
|
||||||
|
|
||||||
Type: `object`\
|
|
||||||
Default: `process.env`
|
|
||||||
|
|
||||||
Environment key-value pairs. Extends automatically from `process.env`. Set [`extendEnv`](#extendenv) to `false` if you don't want this.
|
|
||||||
|
|
||||||
#### argv0
|
|
||||||
|
|
||||||
Type: `string`
|
|
||||||
|
|
||||||
Explicitly set the value of `argv[0]` sent to the child process. This will be set to `file` if not specified.
|
|
||||||
|
|
||||||
#### stdio
|
|
||||||
|
|
||||||
Type: `string | string[]`\
|
|
||||||
Default: `pipe`
|
|
||||||
|
|
||||||
Child's [stdio](https://nodejs.org/api/child_process.html#child_process_options_stdio) configuration.
|
|
||||||
|
|
||||||
#### serialization
|
|
||||||
|
|
||||||
Type: `string`\
|
|
||||||
Default: `'json'`
|
|
||||||
|
|
||||||
Specify the kind of serialization used for sending messages between processes when using the [`stdio: 'ipc'`](#stdio) option or [`execaNode()`](#execanodescriptpath-arguments-options):
|
|
||||||
- `json`: Uses `JSON.stringify()` and `JSON.parse()`.
|
|
||||||
- `advanced`: Uses [`v8.serialize()`](https://nodejs.org/api/v8.html#v8_v8_serialize_value)
|
|
||||||
|
|
||||||
Requires Node.js `13.2.0` or later.
|
|
||||||
|
|
||||||
[More info.](https://nodejs.org/api/child_process.html#child_process_advanced_serialization)
|
|
||||||
|
|
||||||
#### detached
|
|
||||||
|
|
||||||
Type: `boolean`
|
|
||||||
|
|
||||||
Prepare child to run independently of its parent process. Specific behavior [depends on the platform](https://nodejs.org/api/child_process.html#child_process_options_detached).
|
|
||||||
|
|
||||||
#### uid
|
|
||||||
|
|
||||||
Type: `number`
|
|
||||||
|
|
||||||
Sets the user identity of the process.
|
|
||||||
|
|
||||||
#### gid
|
|
||||||
|
|
||||||
Type: `number`
|
|
||||||
|
|
||||||
Sets the group identity of the process.
|
|
||||||
|
|
||||||
#### shell
|
|
||||||
|
|
||||||
Type: `boolean | string`\
|
|
||||||
Default: `false`
|
|
||||||
|
|
||||||
If `true`, runs `file` inside of a shell. Uses `/bin/sh` on UNIX and `cmd.exe` on Windows. A different shell can be specified as a string. The shell should understand the `-c` switch on UNIX or `/d /s /c` on Windows.
|
|
||||||
|
|
||||||
We recommend against using this option since it is:
|
|
||||||
- not cross-platform, encouraging shell-specific syntax.
|
|
||||||
- slower, because of the additional shell interpretation.
|
|
||||||
- unsafe, potentially allowing command injection.
|
|
||||||
|
|
||||||
#### encoding
|
|
||||||
|
|
||||||
Type: `string | null`\
|
|
||||||
Default: `utf8`
|
|
||||||
|
|
||||||
Specify the character encoding used to decode the `stdout` and `stderr` output. If set to `null`, then `stdout` and `stderr` will be a `Buffer` instead of a string.
|
|
||||||
|
|
||||||
#### timeout
|
|
||||||
|
|
||||||
Type: `number`\
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
If timeout is greater than `0`, the parent will send the signal identified by the `killSignal` property (the default is `SIGTERM`) if the child runs longer than timeout milliseconds.
|
|
||||||
|
|
||||||
#### maxBuffer
|
|
||||||
|
|
||||||
Type: `number`\
|
|
||||||
Default: `100_000_000` (100 MB)
|
|
||||||
|
|
||||||
Largest amount of data in bytes allowed on `stdout` or `stderr`.
|
|
||||||
|
|
||||||
#### killSignal
|
|
||||||
|
|
||||||
Type: `string | number`\
|
|
||||||
Default: `SIGTERM`
|
|
||||||
|
|
||||||
Signal value to be used when the spawned process will be killed.
|
|
||||||
|
|
||||||
#### signal
|
|
||||||
|
|
||||||
Type: [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal)
|
|
||||||
|
|
||||||
You can abort the spawned process using [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
||||||
|
|
||||||
When `AbortController.abort()` is called, [`.isCanceled`](#iscanceled) becomes `false`.
|
|
||||||
|
|
||||||
*Requires Node.js 16 or later.*
|
|
||||||
|
|
||||||
#### windowsVerbatimArguments
|
|
||||||
|
|
||||||
Type: `boolean`\
|
|
||||||
Default: `false`
|
|
||||||
|
|
||||||
If `true`, no quoting or escaping of arguments is done on Windows. Ignored on other platforms. This is set to `true` automatically when the `shell` option is `true`.
|
|
||||||
|
|
||||||
#### windowsHide
|
|
||||||
|
|
||||||
Type: `boolean`\
|
|
||||||
Default: `true`
|
|
||||||
|
|
||||||
On Windows, do not create a new console window. Please note this also prevents `CTRL-C` [from working](https://github.com/nodejs/node/issues/29837) on Windows.
|
|
||||||
|
|
||||||
#### nodePath *(For `.node()` only)*
|
|
||||||
|
|
||||||
Type: `string`\
|
|
||||||
Default: [`process.execPath`](https://nodejs.org/api/process.html#process_process_execpath)
|
|
||||||
|
|
||||||
Node.js executable used to create the child process.
|
|
||||||
|
|
||||||
#### nodeOptions *(For `.node()` only)*
|
|
||||||
|
|
||||||
Type: `string[]`\
|
|
||||||
Default: [`process.execArgv`](https://nodejs.org/api/process.html#process_process_execargv)
|
|
||||||
|
|
||||||
List of [CLI options](https://nodejs.org/api/cli.html#cli_options) passed to the Node.js executable.
|
|
||||||
|
|
||||||
## Tips
|
|
||||||
|
|
||||||
### Retry on error
|
|
||||||
|
|
||||||
Gracefully handle failures by using automatic retries and exponential backoff with the [`p-retry`](https://github.com/sindresorhus/p-retry) package:
|
|
||||||
|
|
||||||
```js
|
|
||||||
import pRetry from 'p-retry';
|
|
||||||
|
|
||||||
const run = async () => {
|
|
||||||
const results = await execa('curl', ['-sSL', 'https://sindresorhus.com/unicorn']);
|
|
||||||
return results;
|
|
||||||
};
|
|
||||||
|
|
||||||
console.log(await pRetry(run, {retries: 5}));
|
|
||||||
```
|
|
||||||
|
|
||||||
### Save and pipe output from a child process
|
|
||||||
|
|
||||||
Let's say you want to show the output of a child process in real-time while also saving it to a variable.
|
|
||||||
|
|
||||||
```js
|
|
||||||
import {execa} from 'execa';
|
|
||||||
|
|
||||||
const subprocess = execa('echo', ['foo']);
|
|
||||||
subprocess.stdout.pipe(process.stdout);
|
|
||||||
|
|
||||||
const {stdout} = await subprocess;
|
|
||||||
console.log('child output:', stdout);
|
|
||||||
```
|
|
||||||
|
|
||||||
### Redirect output to a file
|
|
||||||
|
|
||||||
```js
|
|
||||||
import {execa} from 'execa';
|
|
||||||
|
|
||||||
const subprocess = execa('echo', ['foo'])
|
|
||||||
subprocess.stdout.pipe(fs.createWriteStream('stdout.txt'))
|
|
||||||
```
|
|
||||||
|
|
||||||
### Redirect input from a file
|
|
||||||
|
|
||||||
```js
|
|
||||||
import {execa} from 'execa';
|
|
||||||
|
|
||||||
const subprocess = execa('cat')
|
|
||||||
fs.createReadStream('stdin.txt').pipe(subprocess.stdin)
|
|
||||||
```
|
|
||||||
|
|
||||||
### Execute the current package's binary
|
|
||||||
|
|
||||||
```js
|
|
||||||
import {getBinPathSync} from 'get-bin-path';
|
|
||||||
|
|
||||||
const binPath = getBinPathSync();
|
|
||||||
const subprocess = execa(binPath);
|
|
||||||
```
|
|
||||||
|
|
||||||
`execa` can be combined with [`get-bin-path`](https://github.com/ehmicky/get-bin-path) to test the current package's binary. As opposed to hard-coding the path to the binary, this validates that the `package.json` `bin` field is correctly set up.
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [gulp-execa](https://github.com/ehmicky/gulp-execa) - Gulp plugin for `execa`
|
|
||||||
- [nvexeca](https://github.com/ehmicky/nvexeca) - Run `execa` using any Node.js version
|
|
||||||
- [sudo-prompt](https://github.com/jorangreef/sudo-prompt) - Run commands with elevated privileges.
|
|
||||||
|
|
||||||
## Maintainers
|
|
||||||
|
|
||||||
- [Sindre Sorhus](https://github.com/sindresorhus)
|
|
||||||
- [@ehmicky](https://github.com/ehmicky)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
<div align="center">
|
|
||||||
<b>
|
|
||||||
<a href="https://tidelift.com/subscription/pkg/npm-execa?utm_source=npm-execa&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
|
|
||||||
</b>
|
|
||||||
<br>
|
|
||||||
<sub>
|
|
||||||
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
|
|
||||||
</sub>
|
|
||||||
</div>
|
|
@ -1,52 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
const {PassThrough: PassThroughStream} = require('stream');
|
|
||||||
|
|
||||||
module.exports = options => {
|
|
||||||
options = {...options};
|
|
||||||
|
|
||||||
const {array} = options;
|
|
||||||
let {encoding} = options;
|
|
||||||
const isBuffer = encoding === 'buffer';
|
|
||||||
let objectMode = false;
|
|
||||||
|
|
||||||
if (array) {
|
|
||||||
objectMode = !(encoding || isBuffer);
|
|
||||||
} else {
|
|
||||||
encoding = encoding || 'utf8';
|
|
||||||
}
|
|
||||||
|
|
||||||
if (isBuffer) {
|
|
||||||
encoding = null;
|
|
||||||
}
|
|
||||||
|
|
||||||
const stream = new PassThroughStream({objectMode});
|
|
||||||
|
|
||||||
if (encoding) {
|
|
||||||
stream.setEncoding(encoding);
|
|
||||||
}
|
|
||||||
|
|
||||||
let length = 0;
|
|
||||||
const chunks = [];
|
|
||||||
|
|
||||||
stream.on('data', chunk => {
|
|
||||||
chunks.push(chunk);
|
|
||||||
|
|
||||||
if (objectMode) {
|
|
||||||
length = chunks.length;
|
|
||||||
} else {
|
|
||||||
length += chunk.length;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
stream.getBufferedValue = () => {
|
|
||||||
if (array) {
|
|
||||||
return chunks;
|
|
||||||
}
|
|
||||||
|
|
||||||
return isBuffer ? Buffer.concat(chunks, length) : chunks.join('');
|
|
||||||
};
|
|
||||||
|
|
||||||
stream.getBufferedLength = () => length;
|
|
||||||
|
|
||||||
return stream;
|
|
||||||
};
|
|
@ -1,105 +0,0 @@
|
|||||||
/// <reference types="node"/>
|
|
||||||
import {Stream} from 'stream';
|
|
||||||
|
|
||||||
declare class MaxBufferErrorClass extends Error {
|
|
||||||
readonly name: 'MaxBufferError';
|
|
||||||
constructor();
|
|
||||||
}
|
|
||||||
|
|
||||||
declare namespace getStream {
|
|
||||||
interface Options {
|
|
||||||
/**
|
|
||||||
Maximum length of the returned string. If it exceeds this value before the stream ends, the promise will be rejected with a `MaxBufferError` error.
|
|
||||||
|
|
||||||
@default Infinity
|
|
||||||
*/
|
|
||||||
readonly maxBuffer?: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
interface OptionsWithEncoding<EncodingType = BufferEncoding> extends Options {
|
|
||||||
/**
|
|
||||||
[Encoding](https://nodejs.org/api/buffer.html#buffer_buffer) of the incoming stream.
|
|
||||||
|
|
||||||
@default 'utf8'
|
|
||||||
*/
|
|
||||||
readonly encoding?: EncodingType;
|
|
||||||
}
|
|
||||||
|
|
||||||
type MaxBufferError = MaxBufferErrorClass;
|
|
||||||
}
|
|
||||||
|
|
||||||
declare const getStream: {
|
|
||||||
/**
|
|
||||||
Get the `stream` as a string.
|
|
||||||
|
|
||||||
@returns A promise that resolves when the end event fires on the stream, indicating that there is no more data to be read. The stream is switched to flowing mode.
|
|
||||||
|
|
||||||
@example
|
|
||||||
```
|
|
||||||
import * as fs from 'fs';
|
|
||||||
import getStream = require('get-stream');
|
|
||||||
|
|
||||||
(async () => {
|
|
||||||
const stream = fs.createReadStream('unicorn.txt');
|
|
||||||
|
|
||||||
console.log(await getStream(stream));
|
|
||||||
// ,,))))))));,
|
|
||||||
// __)))))))))))))),
|
|
||||||
// \|/ -\(((((''''((((((((.
|
|
||||||
// -*-==//////(('' . `)))))),
|
|
||||||
// /|\ ))| o ;-. '((((( ,(,
|
|
||||||
// ( `| / ) ;))))' ,_))^;(~
|
|
||||||
// | | | ,))((((_ _____------~~~-. %,;(;(>';'~
|
|
||||||
// o_); ; )))(((` ~---~ `:: \ %%~~)(v;(`('~
|
|
||||||
// ; ''''```` `: `:::|\,__,%% );`'; ~
|
|
||||||
// | _ ) / `:|`----' `-'
|
|
||||||
// ______/\/~ | / /
|
|
||||||
// /~;;.____/;;' / ___--,-( `;;;/
|
|
||||||
// / // _;______;'------~~~~~ /;;/\ /
|
|
||||||
// // | | / ; \;;,\
|
|
||||||
// (<_ | ; /',/-----' _>
|
|
||||||
// \_| ||_ //~;~~~~~~~~~
|
|
||||||
// `\_| (,~~
|
|
||||||
// \~\
|
|
||||||
// ~~
|
|
||||||
})();
|
|
||||||
```
|
|
||||||
*/
|
|
||||||
(stream: Stream, options?: getStream.OptionsWithEncoding): Promise<string>;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Get the `stream` as a buffer.
|
|
||||||
|
|
||||||
It honors the `maxBuffer` option as above, but it refers to byte length rather than string length.
|
|
||||||
*/
|
|
||||||
buffer(
|
|
||||||
stream: Stream,
|
|
||||||
options?: getStream.Options
|
|
||||||
): Promise<Buffer>;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Get the `stream` as an array of values.
|
|
||||||
|
|
||||||
It honors both the `maxBuffer` and `encoding` options. The behavior changes slightly based on the encoding chosen:
|
|
||||||
|
|
||||||
- When `encoding` is unset, it assumes an [object mode stream](https://nodesource.com/blog/understanding-object-streams/) and collects values emitted from `stream` unmodified. In this case `maxBuffer` refers to the number of items in the array (not the sum of their sizes).
|
|
||||||
- When `encoding` is set to `buffer`, it collects an array of buffers. `maxBuffer` refers to the summed byte lengths of every buffer in the array.
|
|
||||||
- When `encoding` is set to anything else, it collects an array of strings. `maxBuffer` refers to the summed character lengths of every string in the array.
|
|
||||||
*/
|
|
||||||
array<StreamObjectModeType>(
|
|
||||||
stream: Stream,
|
|
||||||
options?: getStream.Options
|
|
||||||
): Promise<StreamObjectModeType[]>;
|
|
||||||
array(
|
|
||||||
stream: Stream,
|
|
||||||
options: getStream.OptionsWithEncoding<'buffer'>
|
|
||||||
): Promise<Buffer[]>;
|
|
||||||
array(
|
|
||||||
stream: Stream,
|
|
||||||
options: getStream.OptionsWithEncoding<BufferEncoding>
|
|
||||||
): Promise<string[]>;
|
|
||||||
|
|
||||||
MaxBufferError: typeof MaxBufferErrorClass;
|
|
||||||
};
|
|
||||||
|
|
||||||
export = getStream;
|
|
@ -1,61 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
const {constants: BufferConstants} = require('buffer');
|
|
||||||
const stream = require('stream');
|
|
||||||
const {promisify} = require('util');
|
|
||||||
const bufferStream = require('./buffer-stream');
|
|
||||||
|
|
||||||
const streamPipelinePromisified = promisify(stream.pipeline);
|
|
||||||
|
|
||||||
class MaxBufferError extends Error {
|
|
||||||
constructor() {
|
|
||||||
super('maxBuffer exceeded');
|
|
||||||
this.name = 'MaxBufferError';
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async function getStream(inputStream, options) {
|
|
||||||
if (!inputStream) {
|
|
||||||
throw new Error('Expected a stream');
|
|
||||||
}
|
|
||||||
|
|
||||||
options = {
|
|
||||||
maxBuffer: Infinity,
|
|
||||||
...options
|
|
||||||
};
|
|
||||||
|
|
||||||
const {maxBuffer} = options;
|
|
||||||
const stream = bufferStream(options);
|
|
||||||
|
|
||||||
await new Promise((resolve, reject) => {
|
|
||||||
const rejectPromise = error => {
|
|
||||||
// Don't retrieve an oversized buffer.
|
|
||||||
if (error && stream.getBufferedLength() <= BufferConstants.MAX_LENGTH) {
|
|
||||||
error.bufferedData = stream.getBufferedValue();
|
|
||||||
}
|
|
||||||
|
|
||||||
reject(error);
|
|
||||||
};
|
|
||||||
|
|
||||||
(async () => {
|
|
||||||
try {
|
|
||||||
await streamPipelinePromisified(inputStream, stream);
|
|
||||||
resolve();
|
|
||||||
} catch (error) {
|
|
||||||
rejectPromise(error);
|
|
||||||
}
|
|
||||||
})();
|
|
||||||
|
|
||||||
stream.on('data', () => {
|
|
||||||
if (stream.getBufferedLength() > maxBuffer) {
|
|
||||||
rejectPromise(new MaxBufferError());
|
|
||||||
}
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
return stream.getBufferedValue();
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = getStream;
|
|
||||||
module.exports.buffer = (stream, options) => getStream(stream, {...options, encoding: 'buffer'});
|
|
||||||
module.exports.array = (stream, options) => getStream(stream, {...options, array: true});
|
|
||||||
module.exports.MaxBufferError = MaxBufferError;
|
|
@ -1,9 +0,0 @@
|
|||||||
MIT License
|
|
||||||
|
|
||||||
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
@ -1,47 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "get-stream",
|
|
||||||
"version": "6.0.1",
|
|
||||||
"description": "Get a stream as a string, buffer, or array",
|
|
||||||
"license": "MIT",
|
|
||||||
"repository": "sindresorhus/get-stream",
|
|
||||||
"funding": "https://github.com/sponsors/sindresorhus",
|
|
||||||
"author": {
|
|
||||||
"name": "Sindre Sorhus",
|
|
||||||
"email": "sindresorhus@gmail.com",
|
|
||||||
"url": "https://sindresorhus.com"
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": ">=10"
|
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"test": "xo && ava && tsd"
|
|
||||||
},
|
|
||||||
"files": [
|
|
||||||
"index.js",
|
|
||||||
"index.d.ts",
|
|
||||||
"buffer-stream.js"
|
|
||||||
],
|
|
||||||
"keywords": [
|
|
||||||
"get",
|
|
||||||
"stream",
|
|
||||||
"promise",
|
|
||||||
"concat",
|
|
||||||
"string",
|
|
||||||
"text",
|
|
||||||
"buffer",
|
|
||||||
"read",
|
|
||||||
"data",
|
|
||||||
"consume",
|
|
||||||
"readable",
|
|
||||||
"readablestream",
|
|
||||||
"array",
|
|
||||||
"object"
|
|
||||||
],
|
|
||||||
"devDependencies": {
|
|
||||||
"@types/node": "^14.0.27",
|
|
||||||
"ava": "^2.4.0",
|
|
||||||
"into-stream": "^5.0.0",
|
|
||||||
"tsd": "^0.13.1",
|
|
||||||
"xo": "^0.24.0"
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,124 +0,0 @@
|
|||||||
# get-stream
|
|
||||||
|
|
||||||
> Get a stream as a string, buffer, or array
|
|
||||||
|
|
||||||
## Install
|
|
||||||
|
|
||||||
```
|
|
||||||
$ npm install get-stream
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```js
|
|
||||||
const fs = require('fs');
|
|
||||||
const getStream = require('get-stream');
|
|
||||||
|
|
||||||
(async () => {
|
|
||||||
const stream = fs.createReadStream('unicorn.txt');
|
|
||||||
|
|
||||||
console.log(await getStream(stream));
|
|
||||||
/*
|
|
||||||
,,))))))));,
|
|
||||||
__)))))))))))))),
|
|
||||||
\|/ -\(((((''''((((((((.
|
|
||||||
-*-==//////(('' . `)))))),
|
|
||||||
/|\ ))| o ;-. '((((( ,(,
|
|
||||||
( `| / ) ;))))' ,_))^;(~
|
|
||||||
| | | ,))((((_ _____------~~~-. %,;(;(>';'~
|
|
||||||
o_); ; )))(((` ~---~ `:: \ %%~~)(v;(`('~
|
|
||||||
; ''''```` `: `:::|\,__,%% );`'; ~
|
|
||||||
| _ ) / `:|`----' `-'
|
|
||||||
______/\/~ | / /
|
|
||||||
/~;;.____/;;' / ___--,-( `;;;/
|
|
||||||
/ // _;______;'------~~~~~ /;;/\ /
|
|
||||||
// | | / ; \;;,\
|
|
||||||
(<_ | ; /',/-----' _>
|
|
||||||
\_| ||_ //~;~~~~~~~~~
|
|
||||||
`\_| (,~~
|
|
||||||
\~\
|
|
||||||
~~
|
|
||||||
*/
|
|
||||||
})();
|
|
||||||
```
|
|
||||||
|
|
||||||
## API
|
|
||||||
|
|
||||||
The methods returns a promise that resolves when the `end` event fires on the stream, indicating that there is no more data to be read. The stream is switched to flowing mode.
|
|
||||||
|
|
||||||
### getStream(stream, options?)
|
|
||||||
|
|
||||||
Get the `stream` as a string.
|
|
||||||
|
|
||||||
#### options
|
|
||||||
|
|
||||||
Type: `object`
|
|
||||||
|
|
||||||
##### encoding
|
|
||||||
|
|
||||||
Type: `string`\
|
|
||||||
Default: `'utf8'`
|
|
||||||
|
|
||||||
[Encoding](https://nodejs.org/api/buffer.html#buffer_buffer) of the incoming stream.
|
|
||||||
|
|
||||||
##### maxBuffer
|
|
||||||
|
|
||||||
Type: `number`\
|
|
||||||
Default: `Infinity`
|
|
||||||
|
|
||||||
Maximum length of the returned string. If it exceeds this value before the stream ends, the promise will be rejected with a `getStream.MaxBufferError` error.
|
|
||||||
|
|
||||||
### getStream.buffer(stream, options?)
|
|
||||||
|
|
||||||
Get the `stream` as a buffer.
|
|
||||||
|
|
||||||
It honors the `maxBuffer` option as above, but it refers to byte length rather than string length.
|
|
||||||
|
|
||||||
### getStream.array(stream, options?)
|
|
||||||
|
|
||||||
Get the `stream` as an array of values.
|
|
||||||
|
|
||||||
It honors both the `maxBuffer` and `encoding` options. The behavior changes slightly based on the encoding chosen:
|
|
||||||
|
|
||||||
- When `encoding` is unset, it assumes an [object mode stream](https://nodesource.com/blog/understanding-object-streams/) and collects values emitted from `stream` unmodified. In this case `maxBuffer` refers to the number of items in the array (not the sum of their sizes).
|
|
||||||
|
|
||||||
- When `encoding` is set to `buffer`, it collects an array of buffers. `maxBuffer` refers to the summed byte lengths of every buffer in the array.
|
|
||||||
|
|
||||||
- When `encoding` is set to anything else, it collects an array of strings. `maxBuffer` refers to the summed character lengths of every string in the array.
|
|
||||||
|
|
||||||
## Errors
|
|
||||||
|
|
||||||
If the input stream emits an `error` event, the promise will be rejected with the error. The buffered data will be attached to the `bufferedData` property of the error.
|
|
||||||
|
|
||||||
```js
|
|
||||||
(async () => {
|
|
||||||
try {
|
|
||||||
await getStream(streamThatErrorsAtTheEnd('unicorn'));
|
|
||||||
} catch (error) {
|
|
||||||
console.log(error.bufferedData);
|
|
||||||
//=> 'unicorn'
|
|
||||||
}
|
|
||||||
})()
|
|
||||||
```
|
|
||||||
|
|
||||||
## FAQ
|
|
||||||
|
|
||||||
### How is this different from [`concat-stream`](https://github.com/maxogden/concat-stream)?
|
|
||||||
|
|
||||||
This module accepts a stream instead of being one and returns a promise instead of using a callback. The API is simpler and it only supports returning a string, buffer, or array. It doesn't have a fragile type inference. You explicitly choose what you want. And it doesn't depend on the huge `readable-stream` package.
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [get-stdin](https://github.com/sindresorhus/get-stdin) - Get stdin as a string or buffer
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
<div align="center">
|
|
||||||
<b>
|
|
||||||
<a href="https://tidelift.com/subscription/pkg/npm-get-stream?utm_source=npm-get-stream&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
|
|
||||||
</b>
|
|
||||||
<br>
|
|
||||||
<sub>
|
|
||||||
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
|
|
||||||
</sub>
|
|
||||||
</div>
|
|
@ -1,201 +0,0 @@
|
|||||||
Apache License
|
|
||||||
Version 2.0, January 2004
|
|
||||||
http://www.apache.org/licenses/
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
||||||
|
|
||||||
1. Definitions.
|
|
||||||
|
|
||||||
"License" shall mean the terms and conditions for use, reproduction,
|
|
||||||
and distribution as defined by Sections 1 through 9 of this document.
|
|
||||||
|
|
||||||
"Licensor" shall mean the copyright owner or entity authorized by
|
|
||||||
the copyright owner that is granting the License.
|
|
||||||
|
|
||||||
"Legal Entity" shall mean the union of the acting entity and all
|
|
||||||
other entities that control, are controlled by, or are under common
|
|
||||||
control with that entity. For the purposes of this definition,
|
|
||||||
"control" means (i) the power, direct or indirect, to cause the
|
|
||||||
direction or management of such entity, whether by contract or
|
|
||||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
||||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
||||||
|
|
||||||
"You" (or "Your") shall mean an individual or Legal Entity
|
|
||||||
exercising permissions granted by this License.
|
|
||||||
|
|
||||||
"Source" form shall mean the preferred form for making modifications,
|
|
||||||
including but not limited to software source code, documentation
|
|
||||||
source, and configuration files.
|
|
||||||
|
|
||||||
"Object" form shall mean any form resulting from mechanical
|
|
||||||
transformation or translation of a Source form, including but
|
|
||||||
not limited to compiled object code, generated documentation,
|
|
||||||
and conversions to other media types.
|
|
||||||
|
|
||||||
"Work" shall mean the work of authorship, whether in Source or
|
|
||||||
Object form, made available under the License, as indicated by a
|
|
||||||
copyright notice that is included in or attached to the work
|
|
||||||
(an example is provided in the Appendix below).
|
|
||||||
|
|
||||||
"Derivative Works" shall mean any work, whether in Source or Object
|
|
||||||
form, that is based on (or derived from) the Work and for which the
|
|
||||||
editorial revisions, annotations, elaborations, or other modifications
|
|
||||||
represent, as a whole, an original work of authorship. For the purposes
|
|
||||||
of this License, Derivative Works shall not include works that remain
|
|
||||||
separable from, or merely link (or bind by name) to the interfaces of,
|
|
||||||
the Work and Derivative Works thereof.
|
|
||||||
|
|
||||||
"Contribution" shall mean any work of authorship, including
|
|
||||||
the original version of the Work and any modifications or additions
|
|
||||||
to that Work or Derivative Works thereof, that is intentionally
|
|
||||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
||||||
or by an individual or Legal Entity authorized to submit on behalf of
|
|
||||||
the copyright owner. For the purposes of this definition, "submitted"
|
|
||||||
means any form of electronic, verbal, or written communication sent
|
|
||||||
to the Licensor or its representatives, including but not limited to
|
|
||||||
communication on electronic mailing lists, source code control systems,
|
|
||||||
and issue tracking systems that are managed by, or on behalf of, the
|
|
||||||
Licensor for the purpose of discussing and improving the Work, but
|
|
||||||
excluding communication that is conspicuously marked or otherwise
|
|
||||||
designated in writing by the copyright owner as "Not a Contribution."
|
|
||||||
|
|
||||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
||||||
on behalf of whom a Contribution has been received by Licensor and
|
|
||||||
subsequently incorporated within the Work.
|
|
||||||
|
|
||||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
copyright license to reproduce, prepare Derivative Works of,
|
|
||||||
publicly display, publicly perform, sublicense, and distribute the
|
|
||||||
Work and such Derivative Works in Source or Object form.
|
|
||||||
|
|
||||||
3. Grant of Patent License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
(except as stated in this section) patent license to make, have made,
|
|
||||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
||||||
where such license applies only to those patent claims licensable
|
|
||||||
by such Contributor that are necessarily infringed by their
|
|
||||||
Contribution(s) alone or by combination of their Contribution(s)
|
|
||||||
with the Work to which such Contribution(s) was submitted. If You
|
|
||||||
institute patent litigation against any entity (including a
|
|
||||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
||||||
or a Contribution incorporated within the Work constitutes direct
|
|
||||||
or contributory patent infringement, then any patent licenses
|
|
||||||
granted to You under this License for that Work shall terminate
|
|
||||||
as of the date such litigation is filed.
|
|
||||||
|
|
||||||
4. Redistribution. You may reproduce and distribute copies of the
|
|
||||||
Work or Derivative Works thereof in any medium, with or without
|
|
||||||
modifications, and in Source or Object form, provided that You
|
|
||||||
meet the following conditions:
|
|
||||||
|
|
||||||
(a) You must give any other recipients of the Work or
|
|
||||||
Derivative Works a copy of this License; and
|
|
||||||
|
|
||||||
(b) You must cause any modified files to carry prominent notices
|
|
||||||
stating that You changed the files; and
|
|
||||||
|
|
||||||
(c) You must retain, in the Source form of any Derivative Works
|
|
||||||
that You distribute, all copyright, patent, trademark, and
|
|
||||||
attribution notices from the Source form of the Work,
|
|
||||||
excluding those notices that do not pertain to any part of
|
|
||||||
the Derivative Works; and
|
|
||||||
|
|
||||||
(d) If the Work includes a "NOTICE" text file as part of its
|
|
||||||
distribution, then any Derivative Works that You distribute must
|
|
||||||
include a readable copy of the attribution notices contained
|
|
||||||
within such NOTICE file, excluding those notices that do not
|
|
||||||
pertain to any part of the Derivative Works, in at least one
|
|
||||||
of the following places: within a NOTICE text file distributed
|
|
||||||
as part of the Derivative Works; within the Source form or
|
|
||||||
documentation, if provided along with the Derivative Works; or,
|
|
||||||
within a display generated by the Derivative Works, if and
|
|
||||||
wherever such third-party notices normally appear. The contents
|
|
||||||
of the NOTICE file are for informational purposes only and
|
|
||||||
do not modify the License. You may add Your own attribution
|
|
||||||
notices within Derivative Works that You distribute, alongside
|
|
||||||
or as an addendum to the NOTICE text from the Work, provided
|
|
||||||
that such additional attribution notices cannot be construed
|
|
||||||
as modifying the License.
|
|
||||||
|
|
||||||
You may add Your own copyright statement to Your modifications and
|
|
||||||
may provide additional or different license terms and conditions
|
|
||||||
for use, reproduction, or distribution of Your modifications, or
|
|
||||||
for any such Derivative Works as a whole, provided Your use,
|
|
||||||
reproduction, and distribution of the Work otherwise complies with
|
|
||||||
the conditions stated in this License.
|
|
||||||
|
|
||||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
||||||
any Contribution intentionally submitted for inclusion in the Work
|
|
||||||
by You to the Licensor shall be under the terms and conditions of
|
|
||||||
this License, without any additional terms or conditions.
|
|
||||||
Notwithstanding the above, nothing herein shall supersede or modify
|
|
||||||
the terms of any separate license agreement you may have executed
|
|
||||||
with Licensor regarding such Contributions.
|
|
||||||
|
|
||||||
6. Trademarks. This License does not grant permission to use the trade
|
|
||||||
names, trademarks, service marks, or product names of the Licensor,
|
|
||||||
except as required for reasonable and customary use in describing the
|
|
||||||
origin of the Work and reproducing the content of the NOTICE file.
|
|
||||||
|
|
||||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
||||||
agreed to in writing, Licensor provides the Work (and each
|
|
||||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
||||||
implied, including, without limitation, any warranties or conditions
|
|
||||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
||||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
||||||
appropriateness of using or redistributing the Work and assume any
|
|
||||||
risks associated with Your exercise of permissions under this License.
|
|
||||||
|
|
||||||
8. Limitation of Liability. In no event and under no legal theory,
|
|
||||||
whether in tort (including negligence), contract, or otherwise,
|
|
||||||
unless required by applicable law (such as deliberate and grossly
|
|
||||||
negligent acts) or agreed to in writing, shall any Contributor be
|
|
||||||
liable to You for damages, including any direct, indirect, special,
|
|
||||||
incidental, or consequential damages of any character arising as a
|
|
||||||
result of this License or out of the use or inability to use the
|
|
||||||
Work (including but not limited to damages for loss of goodwill,
|
|
||||||
work stoppage, computer failure or malfunction, or any and all
|
|
||||||
other commercial damages or losses), even if such Contributor
|
|
||||||
has been advised of the possibility of such damages.
|
|
||||||
|
|
||||||
9. Accepting Warranty or Additional Liability. While redistributing
|
|
||||||
the Work or Derivative Works thereof, You may choose to offer,
|
|
||||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
||||||
or other liability obligations and/or rights consistent with this
|
|
||||||
License. However, in accepting such obligations, You may act only
|
|
||||||
on Your own behalf and on Your sole responsibility, not on behalf
|
|
||||||
of any other Contributor, and only if You agree to indemnify,
|
|
||||||
defend, and hold each Contributor harmless for any liability
|
|
||||||
incurred by, or claims asserted against, such Contributor by reason
|
|
||||||
of your accepting any such warranty or additional liability.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
APPENDIX: How to apply the Apache License to your work.
|
|
||||||
|
|
||||||
To apply the Apache License to your work, attach the following
|
|
||||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
||||||
replaced with your own identifying information. (Don't include
|
|
||||||
the brackets!) The text should be enclosed in the appropriate
|
|
||||||
comment syntax for the file format. We also recommend that a
|
|
||||||
file or class name and description of purpose be included on the
|
|
||||||
same "printed page" as the copyright notice for easier
|
|
||||||
identification within third-party archives.
|
|
||||||
|
|
||||||
Copyright 2021 ehmicky <ehmicky@gmail.com>
|
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
you may not use this file except in compliance with the License.
|
|
||||||
You may obtain a copy of the License at
|
|
||||||
|
|
||||||
http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
|
|
||||||
Unless required by applicable law or agreed to in writing, software
|
|
||||||
distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
See the License for the specific language governing permissions and
|
|
||||||
limitations under the License.
|
|
@ -1,164 +0,0 @@
|
|||||||
[![Codecov](https://img.shields.io/codecov/c/github/ehmicky/human-signals.svg?label=tested&logo=codecov)](https://codecov.io/gh/ehmicky/human-signals)
|
|
||||||
[![Build](https://github.com/ehmicky/human-signals/workflows/Build/badge.svg)](https://github.com/ehmicky/human-signals/actions)
|
|
||||||
[![Node](https://img.shields.io/node/v/human-signals.svg?logo=node.js)](https://www.npmjs.com/package/human-signals)
|
|
||||||
[![Twitter](https://img.shields.io/badge/%E2%80%8B-twitter-4cc61e.svg?logo=twitter)](https://twitter.com/intent/follow?screen_name=ehmicky)
|
|
||||||
[![Medium](https://img.shields.io/badge/%E2%80%8B-medium-4cc61e.svg?logo=medium)](https://medium.com/@ehmicky)
|
|
||||||
|
|
||||||
Human-friendly process signals.
|
|
||||||
|
|
||||||
This is a map of known process signals with some information about each signal.
|
|
||||||
|
|
||||||
Unlike
|
|
||||||
[`os.constants.signals`](https://nodejs.org/api/os.html#os_signal_constants)
|
|
||||||
this includes:
|
|
||||||
|
|
||||||
- human-friendly [descriptions](#description)
|
|
||||||
- [default actions](#action), including whether they [can be prevented](#forced)
|
|
||||||
- whether the signal is [supported](#supported) by the current OS
|
|
||||||
|
|
||||||
# Example
|
|
||||||
|
|
||||||
```js
|
|
||||||
import { signalsByName, signalsByNumber } from 'human-signals'
|
|
||||||
|
|
||||||
console.log(signalsByName.SIGINT)
|
|
||||||
// {
|
|
||||||
// name: 'SIGINT',
|
|
||||||
// number: 2,
|
|
||||||
// description: 'User interruption with CTRL-C',
|
|
||||||
// supported: true,
|
|
||||||
// action: 'terminate',
|
|
||||||
// forced: false,
|
|
||||||
// standard: 'ansi'
|
|
||||||
// }
|
|
||||||
|
|
||||||
console.log(signalsByNumber[8])
|
|
||||||
// {
|
|
||||||
// name: 'SIGFPE',
|
|
||||||
// number: 8,
|
|
||||||
// description: 'Floating point arithmetic error',
|
|
||||||
// supported: true,
|
|
||||||
// action: 'core',
|
|
||||||
// forced: false,
|
|
||||||
// standard: 'ansi'
|
|
||||||
// }
|
|
||||||
```
|
|
||||||
|
|
||||||
# Install
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm install human-signals
|
|
||||||
```
|
|
||||||
|
|
||||||
This package is an ES module and must be loaded using
|
|
||||||
[an `import` or `import()` statement](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c),
|
|
||||||
not `require()`.
|
|
||||||
|
|
||||||
# Usage
|
|
||||||
|
|
||||||
## signalsByName
|
|
||||||
|
|
||||||
_Type_: `object`
|
|
||||||
|
|
||||||
Object whose keys are signal [names](#name) and values are
|
|
||||||
[signal objects](#signal).
|
|
||||||
|
|
||||||
## signalsByNumber
|
|
||||||
|
|
||||||
_Type_: `object`
|
|
||||||
|
|
||||||
Object whose keys are signal [numbers](#number) and values are
|
|
||||||
[signal objects](#signal).
|
|
||||||
|
|
||||||
## signal
|
|
||||||
|
|
||||||
_Type_: `object`
|
|
||||||
|
|
||||||
Signal object with the following properties.
|
|
||||||
|
|
||||||
### name
|
|
||||||
|
|
||||||
_Type_: `string`
|
|
||||||
|
|
||||||
Standard name of the signal, for example `'SIGINT'`.
|
|
||||||
|
|
||||||
### number
|
|
||||||
|
|
||||||
_Type_: `number`
|
|
||||||
|
|
||||||
Code number of the signal, for example `2`. While most `number` are
|
|
||||||
cross-platform, some are different between different OS.
|
|
||||||
|
|
||||||
### description
|
|
||||||
|
|
||||||
_Type_: `string`
|
|
||||||
|
|
||||||
Human-friendly description for the signal, for example
|
|
||||||
`'User interruption with CTRL-C'`.
|
|
||||||
|
|
||||||
### supported
|
|
||||||
|
|
||||||
_Type_: `boolean`
|
|
||||||
|
|
||||||
Whether the current OS can handle this signal in Node.js using
|
|
||||||
[`process.on(name, handler)`](https://nodejs.org/api/process.html#process_signal_events).
|
|
||||||
|
|
||||||
The list of supported signals
|
|
||||||
[is OS-specific](https://github.com/ehmicky/cross-platform-node-guide/blob/main/docs/6_networking_ipc/signals.md#cross-platform-signals).
|
|
||||||
|
|
||||||
### action
|
|
||||||
|
|
||||||
_Type_: `string`\
|
|
||||||
_Enum_: `'terminate'`, `'core'`, `'ignore'`, `'pause'`, `'unpause'`
|
|
||||||
|
|
||||||
What is the default action for this signal when it is not handled.
|
|
||||||
|
|
||||||
### forced
|
|
||||||
|
|
||||||
_Type_: `boolean`
|
|
||||||
|
|
||||||
Whether the signal's default action cannot be prevented. This is `true` for
|
|
||||||
`SIGTERM`, `SIGKILL` and `SIGSTOP`.
|
|
||||||
|
|
||||||
### standard
|
|
||||||
|
|
||||||
_Type_: `string`\
|
|
||||||
_Enum_: `'ansi'`, `'posix'`, `'bsd'`, `'systemv'`, `'other'`
|
|
||||||
|
|
||||||
Which standard defined that signal.
|
|
||||||
|
|
||||||
# Support
|
|
||||||
|
|
||||||
For any question, _don't hesitate_ to [submit an issue on GitHub](../../issues).
|
|
||||||
|
|
||||||
Everyone is welcome regardless of personal background. We enforce a
|
|
||||||
[Code of conduct](CODE_OF_CONDUCT.md) in order to promote a positive and
|
|
||||||
inclusive environment.
|
|
||||||
|
|
||||||
# Contributing
|
|
||||||
|
|
||||||
This project was made with ❤️. The simplest way to give back is by starring and
|
|
||||||
sharing it online.
|
|
||||||
|
|
||||||
If the documentation is unclear or has a typo, please click on the page's `Edit`
|
|
||||||
button (pencil icon) and suggest a correction.
|
|
||||||
|
|
||||||
If you would like to help us fix a bug or add a new feature, please check our
|
|
||||||
[guidelines](CONTRIBUTING.md). Pull requests are welcome!
|
|
||||||
|
|
||||||
Thanks go to our wonderful contributors:
|
|
||||||
|
|
||||||
<!-- ALL-CONTRIBUTORS-LIST:START -->
|
|
||||||
<!-- prettier-ignore-start -->
|
|
||||||
<!-- markdownlint-disable -->
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<td align="center"><a href="https://twitter.com/ehmicky"><img src="https://avatars2.githubusercontent.com/u/8136211?v=4" width="100px;" alt=""/><br /><sub><b>ehmicky</b></sub></a><br /><a href="https://github.com/ehmicky/human-signals/commits?author=ehmicky" title="Code">💻</a> <a href="#design-ehmicky" title="Design">🎨</a> <a href="#ideas-ehmicky" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/ehmicky/human-signals/commits?author=ehmicky" title="Documentation">📖</a></td>
|
|
||||||
<td align="center"><a href="http://www.electrovir.com"><img src="https://avatars0.githubusercontent.com/u/1205860?v=4" width="100px;" alt=""/><br /><sub><b>electrovir</b></sub></a><br /><a href="https://github.com/ehmicky/human-signals/commits?author=electrovir" title="Code">💻</a></td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
<!-- markdownlint-enable -->
|
|
||||||
<!-- prettier-ignore-end -->
|
|
||||||
|
|
||||||
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
|
@ -1,273 +0,0 @@
|
|||||||
|
|
||||||
|
|
||||||
export const SIGNALS=[
|
|
||||||
{
|
|
||||||
name:"SIGHUP",
|
|
||||||
number:1,
|
|
||||||
action:"terminate",
|
|
||||||
description:"Terminal closed",
|
|
||||||
standard:"posix"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGINT",
|
|
||||||
number:2,
|
|
||||||
action:"terminate",
|
|
||||||
description:"User interruption with CTRL-C",
|
|
||||||
standard:"ansi"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGQUIT",
|
|
||||||
number:3,
|
|
||||||
action:"core",
|
|
||||||
description:"User interruption with CTRL-\\",
|
|
||||||
standard:"posix"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGILL",
|
|
||||||
number:4,
|
|
||||||
action:"core",
|
|
||||||
description:"Invalid machine instruction",
|
|
||||||
standard:"ansi"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGTRAP",
|
|
||||||
number:5,
|
|
||||||
action:"core",
|
|
||||||
description:"Debugger breakpoint",
|
|
||||||
standard:"posix"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGABRT",
|
|
||||||
number:6,
|
|
||||||
action:"core",
|
|
||||||
description:"Aborted",
|
|
||||||
standard:"ansi"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGIOT",
|
|
||||||
number:6,
|
|
||||||
action:"core",
|
|
||||||
description:"Aborted",
|
|
||||||
standard:"bsd"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGBUS",
|
|
||||||
number:7,
|
|
||||||
action:"core",
|
|
||||||
description:
|
|
||||||
"Bus error due to misaligned, non-existing address or paging error",
|
|
||||||
standard:"bsd"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGEMT",
|
|
||||||
number:7,
|
|
||||||
action:"terminate",
|
|
||||||
description:"Command should be emulated but is not implemented",
|
|
||||||
standard:"other"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGFPE",
|
|
||||||
number:8,
|
|
||||||
action:"core",
|
|
||||||
description:"Floating point arithmetic error",
|
|
||||||
standard:"ansi"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGKILL",
|
|
||||||
number:9,
|
|
||||||
action:"terminate",
|
|
||||||
description:"Forced termination",
|
|
||||||
standard:"posix",
|
|
||||||
forced:true},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGUSR1",
|
|
||||||
number:10,
|
|
||||||
action:"terminate",
|
|
||||||
description:"Application-specific signal",
|
|
||||||
standard:"posix"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGSEGV",
|
|
||||||
number:11,
|
|
||||||
action:"core",
|
|
||||||
description:"Segmentation fault",
|
|
||||||
standard:"ansi"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGUSR2",
|
|
||||||
number:12,
|
|
||||||
action:"terminate",
|
|
||||||
description:"Application-specific signal",
|
|
||||||
standard:"posix"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGPIPE",
|
|
||||||
number:13,
|
|
||||||
action:"terminate",
|
|
||||||
description:"Broken pipe or socket",
|
|
||||||
standard:"posix"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGALRM",
|
|
||||||
number:14,
|
|
||||||
action:"terminate",
|
|
||||||
description:"Timeout or timer",
|
|
||||||
standard:"posix"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGTERM",
|
|
||||||
number:15,
|
|
||||||
action:"terminate",
|
|
||||||
description:"Termination",
|
|
||||||
standard:"ansi"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGSTKFLT",
|
|
||||||
number:16,
|
|
||||||
action:"terminate",
|
|
||||||
description:"Stack is empty or overflowed",
|
|
||||||
standard:"other"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGCHLD",
|
|
||||||
number:17,
|
|
||||||
action:"ignore",
|
|
||||||
description:"Child process terminated, paused or unpaused",
|
|
||||||
standard:"posix"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGCLD",
|
|
||||||
number:17,
|
|
||||||
action:"ignore",
|
|
||||||
description:"Child process terminated, paused or unpaused",
|
|
||||||
standard:"other"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGCONT",
|
|
||||||
number:18,
|
|
||||||
action:"unpause",
|
|
||||||
description:"Unpaused",
|
|
||||||
standard:"posix",
|
|
||||||
forced:true},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGSTOP",
|
|
||||||
number:19,
|
|
||||||
action:"pause",
|
|
||||||
description:"Paused",
|
|
||||||
standard:"posix",
|
|
||||||
forced:true},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGTSTP",
|
|
||||||
number:20,
|
|
||||||
action:"pause",
|
|
||||||
description:"Paused using CTRL-Z or \"suspend\"",
|
|
||||||
standard:"posix"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGTTIN",
|
|
||||||
number:21,
|
|
||||||
action:"pause",
|
|
||||||
description:"Background process cannot read terminal input",
|
|
||||||
standard:"posix"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGBREAK",
|
|
||||||
number:21,
|
|
||||||
action:"terminate",
|
|
||||||
description:"User interruption with CTRL-BREAK",
|
|
||||||
standard:"other"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGTTOU",
|
|
||||||
number:22,
|
|
||||||
action:"pause",
|
|
||||||
description:"Background process cannot write to terminal output",
|
|
||||||
standard:"posix"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGURG",
|
|
||||||
number:23,
|
|
||||||
action:"ignore",
|
|
||||||
description:"Socket received out-of-band data",
|
|
||||||
standard:"bsd"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGXCPU",
|
|
||||||
number:24,
|
|
||||||
action:"core",
|
|
||||||
description:"Process timed out",
|
|
||||||
standard:"bsd"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGXFSZ",
|
|
||||||
number:25,
|
|
||||||
action:"core",
|
|
||||||
description:"File too big",
|
|
||||||
standard:"bsd"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGVTALRM",
|
|
||||||
number:26,
|
|
||||||
action:"terminate",
|
|
||||||
description:"Timeout or timer",
|
|
||||||
standard:"bsd"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGPROF",
|
|
||||||
number:27,
|
|
||||||
action:"terminate",
|
|
||||||
description:"Timeout or timer",
|
|
||||||
standard:"bsd"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGWINCH",
|
|
||||||
number:28,
|
|
||||||
action:"ignore",
|
|
||||||
description:"Terminal window size changed",
|
|
||||||
standard:"bsd"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGIO",
|
|
||||||
number:29,
|
|
||||||
action:"terminate",
|
|
||||||
description:"I/O is available",
|
|
||||||
standard:"other"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGPOLL",
|
|
||||||
number:29,
|
|
||||||
action:"terminate",
|
|
||||||
description:"Watched event",
|
|
||||||
standard:"other"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGINFO",
|
|
||||||
number:29,
|
|
||||||
action:"ignore",
|
|
||||||
description:"Request for process information",
|
|
||||||
standard:"other"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGPWR",
|
|
||||||
number:30,
|
|
||||||
action:"terminate",
|
|
||||||
description:"Device running out of power",
|
|
||||||
standard:"systemv"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGSYS",
|
|
||||||
number:31,
|
|
||||||
action:"core",
|
|
||||||
description:"Invalid system call",
|
|
||||||
standard:"other"},
|
|
||||||
|
|
||||||
{
|
|
||||||
name:"SIGUNUSED",
|
|
||||||
number:31,
|
|
||||||
action:"terminate",
|
|
||||||
description:"Invalid system call",
|
|
||||||
standard:"other"}];
|
|
||||||
//# sourceMappingURL=core.js.map
|
|
File diff suppressed because one or more lines are too long
@ -1,52 +0,0 @@
|
|||||||
/**
|
|
||||||
* Object whose keys are signal names and values are signal objects.
|
|
||||||
*/
|
|
||||||
export declare const signalsByName: { [signalName: string]: Signal }
|
|
||||||
/**
|
|
||||||
* Object whose keys are signal numbers and values are signal objects.
|
|
||||||
*/
|
|
||||||
export declare const signalsByNumber: { [signalNumber: string]: Signal }
|
|
||||||
|
|
||||||
export declare type SignalAction =
|
|
||||||
| 'terminate'
|
|
||||||
| 'core'
|
|
||||||
| 'ignore'
|
|
||||||
| 'pause'
|
|
||||||
| 'unpause'
|
|
||||||
export declare type SignalStandard =
|
|
||||||
| 'ansi'
|
|
||||||
| 'posix'
|
|
||||||
| 'bsd'
|
|
||||||
| 'systemv'
|
|
||||||
| 'other'
|
|
||||||
|
|
||||||
export declare type Signal = {
|
|
||||||
/**
|
|
||||||
* Standard name of the signal, for example 'SIGINT'.
|
|
||||||
*/
|
|
||||||
name: string
|
|
||||||
/**
|
|
||||||
* Code number of the signal, for example 2. While most number are cross-platform, some are different between different OS.
|
|
||||||
*/
|
|
||||||
number: number
|
|
||||||
/**
|
|
||||||
* Human-friendly description for the signal, for example 'User interruption with CTRL-C'.
|
|
||||||
*/
|
|
||||||
description: string
|
|
||||||
/**
|
|
||||||
* Whether the current OS can handle this signal in Node.js using process.on(name, handler). The list of supported signals is OS-specific.
|
|
||||||
*/
|
|
||||||
supported: boolean
|
|
||||||
/**
|
|
||||||
* What is the default action for this signal when it is not handled.
|
|
||||||
*/
|
|
||||||
action: SignalAction
|
|
||||||
/**
|
|
||||||
* Whether the signal's default action cannot be prevented. This is true for SIGTERM, SIGKILL and SIGSTOP.
|
|
||||||
*/
|
|
||||||
forced: boolean
|
|
||||||
/**
|
|
||||||
* Which standard defined that signal.
|
|
||||||
*/
|
|
||||||
standard: SignalStandard
|
|
||||||
}
|
|
@ -1,71 +0,0 @@
|
|||||||
import{constants}from"os";
|
|
||||||
|
|
||||||
import{SIGRTMAX}from"./realtime.js";
|
|
||||||
import{getSignals}from"./signals.js";
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
const getSignalsByName=function(){
|
|
||||||
const signals=getSignals();
|
|
||||||
return signals.reduce(getSignalByName,{});
|
|
||||||
};
|
|
||||||
|
|
||||||
const getSignalByName=function(
|
|
||||||
signalByNameMemo,
|
|
||||||
{name,number,description,supported,action,forced,standard})
|
|
||||||
{
|
|
||||||
return{
|
|
||||||
...signalByNameMemo,
|
|
||||||
[name]:{name,number,description,supported,action,forced,standard}};
|
|
||||||
|
|
||||||
};
|
|
||||||
|
|
||||||
export const signalsByName=getSignalsByName();
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
const getSignalsByNumber=function(){
|
|
||||||
const signals=getSignals();
|
|
||||||
const length=SIGRTMAX+1;
|
|
||||||
const signalsA=Array.from({length},(value,number)=>
|
|
||||||
getSignalByNumber(number,signals));
|
|
||||||
|
|
||||||
return Object.assign({},...signalsA);
|
|
||||||
};
|
|
||||||
|
|
||||||
const getSignalByNumber=function(number,signals){
|
|
||||||
const signal=findSignalByNumber(number,signals);
|
|
||||||
|
|
||||||
if(signal===undefined){
|
|
||||||
return{};
|
|
||||||
}
|
|
||||||
|
|
||||||
const{name,description,supported,action,forced,standard}=signal;
|
|
||||||
return{
|
|
||||||
[number]:{
|
|
||||||
name,
|
|
||||||
number,
|
|
||||||
description,
|
|
||||||
supported,
|
|
||||||
action,
|
|
||||||
forced,
|
|
||||||
standard}};
|
|
||||||
|
|
||||||
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
const findSignalByNumber=function(number,signals){
|
|
||||||
const signal=signals.find(({name})=>constants.signals[name]===number);
|
|
||||||
|
|
||||||
if(signal!==undefined){
|
|
||||||
return signal;
|
|
||||||
}
|
|
||||||
|
|
||||||
return signals.find((signalA)=>signalA.number===number);
|
|
||||||
};
|
|
||||||
|
|
||||||
export const signalsByNumber=getSignalsByNumber();
|
|
||||||
//# sourceMappingURL=main.js.map
|
|
@ -1 +0,0 @@
|
|||||||
{"version":3,"sources":["../../src/main.js"],"names":["constants","SIGRTMAX","getSignals","getSignalsByName","signals","reduce","getSignalByName","signalByNameMemo","name","number","description","supported","action","forced","standard","signalsByName","getSignalsByNumber","length","signalsA","Array","from","value","getSignalByNumber","Object","assign","signal","findSignalByNumber","undefined","find","signalA","signalsByNumber"],"mappings":"AAAA,OAASA,SAAT,KAA0B,IAA1B;;AAEA,OAASC,QAAT,KAAyB,eAAzB;AACA,OAASC,UAAT,KAA2B,cAA3B;;;;AAIA,KAAMC,CAAAA,gBAAgB,CAAG,UAAY;AACnC,KAAMC,CAAAA,OAAO,CAAGF,UAAU,EAA1B;AACA,MAAOE,CAAAA,OAAO,CAACC,MAAR,CAAeC,eAAf,CAAgC,EAAhC,CAAP;AACD,CAHD;;AAKA,KAAMA,CAAAA,eAAe,CAAG;AACtBC,gBADsB;AAEtB,CAAEC,IAAF,CAAQC,MAAR,CAAgBC,WAAhB,CAA6BC,SAA7B,CAAwCC,MAAxC,CAAgDC,MAAhD,CAAwDC,QAAxD,CAFsB;AAGtB;AACA,MAAO;AACL,GAAGP,gBADE;AAEL,CAACC,IAAD,EAAQ,CAAEA,IAAF,CAAQC,MAAR,CAAgBC,WAAhB,CAA6BC,SAA7B,CAAwCC,MAAxC,CAAgDC,MAAhD,CAAwDC,QAAxD,CAFH,CAAP;;AAID,CARD;;AAUA,MAAO,MAAMC,CAAAA,aAAa,CAAGZ,gBAAgB,EAAtC;;;;;AAKP,KAAMa,CAAAA,kBAAkB,CAAG,UAAY;AACrC,KAAMZ,CAAAA,OAAO,CAAGF,UAAU,EAA1B;AACA,KAAMe,CAAAA,MAAM,CAAGhB,QAAQ,CAAG,CAA1B;AACA,KAAMiB,CAAAA,QAAQ,CAAGC,KAAK,CAACC,IAAN,CAAW,CAAEH,MAAF,CAAX,CAAuB,CAACI,KAAD,CAAQZ,MAAR;AACtCa,iBAAiB,CAACb,MAAD,CAASL,OAAT,CADF,CAAjB;;AAGA,MAAOmB,CAAAA,MAAM,CAACC,MAAP,CAAc,EAAd,CAAkB,GAAGN,QAArB,CAAP;AACD,CAPD;;AASA,KAAMI,CAAAA,iBAAiB,CAAG,SAAUb,MAAV,CAAkBL,OAAlB,CAA2B;AACnD,KAAMqB,CAAAA,MAAM,CAAGC,kBAAkB,CAACjB,MAAD,CAASL,OAAT,CAAjC;;AAEA,GAAIqB,MAAM,GAAKE,SAAf,CAA0B;AACxB,MAAO,EAAP;AACD;;AAED,KAAM,CAAEnB,IAAF,CAAQE,WAAR,CAAqBC,SAArB,CAAgCC,MAAhC,CAAwCC,MAAxC,CAAgDC,QAAhD,EAA6DW,MAAnE;AACA,MAAO;AACL,CAAChB,MAAD,EAAU;AACRD,IADQ;AAERC,MAFQ;AAGRC,WAHQ;AAIRC,SAJQ;AAKRC,MALQ;AAMRC,MANQ;AAORC,QAPQ,CADL,CAAP;;;AAWD,CAnBD;;;;AAuBA,KAAMY,CAAAA,kBAAkB,CAAG,SAAUjB,MAAV,CAAkBL,OAAlB,CAA2B;AACpD,KAAMqB,CAAAA,MAAM,CAAGrB,OAAO,CAACwB,IAAR,CAAa,CAAC,CAAEpB,IAAF,CAAD,GAAcR,SAAS,CAACI,OAAV,CAAkBI,IAAlB,IAA4BC,MAAvD,CAAf;;AAEA,GAAIgB,MAAM,GAAKE,SAAf,CAA0B;AACxB,MAAOF,CAAAA,MAAP;AACD;;AAED,MAAOrB,CAAAA,OAAO,CAACwB,IAAR,CAAa,CAACC,OAAD,GAAaA,OAAO,CAACpB,MAAR,GAAmBA,MAA7C,CAAP;AACD,CARD;;AAUA,MAAO,MAAMqB,CAAAA,eAAe,CAAGd,kBAAkB,EAA1C","sourcesContent":["import { constants } from 'os'\n\nimport { SIGRTMAX } from './realtime.js'\nimport { getSignals } from './signals.js'\n\n// Retrieve `signalsByName`, an object mapping signal name to signal properties.\n// We make sure the object is sorted by `number`.\nconst getSignalsByName = function () {\n const signals = getSignals()\n return signals.reduce(getSignalByName, {})\n}\n\nconst getSignalByName = function (\n signalByNameMemo,\n { name, number, description, supported, action, forced, standard },\n) {\n return {\n ...signalByNameMemo,\n [name]: { name, number, description, supported, action, forced, standard },\n }\n}\n\nexport const signalsByName = getSignalsByName()\n\n// Retrieve `signalsByNumber`, an object mapping signal number to signal\n// properties.\n// We make sure the object is sorted by `number`.\nconst getSignalsByNumber = function () {\n const signals = getSignals()\n const length = SIGRTMAX + 1\n const signalsA = Array.from({ length }, (value, number) =>\n getSignalByNumber(number, signals),\n )\n return Object.assign({}, ...signalsA)\n}\n\nconst getSignalByNumber = function (number, signals) {\n const signal = findSignalByNumber(number, signals)\n\n if (signal === undefined) {\n return {}\n }\n\n const { name, description, supported, action, forced, standard } = signal\n return {\n [number]: {\n name,\n number,\n description,\n supported,\n action,\n forced,\n standard,\n },\n }\n}\n\n// Several signals might end up sharing the same number because of OS-specific\n// numbers, in which case those prevail.\nconst findSignalByNumber = function (number, signals) {\n const signal = signals.find(({ name }) => constants.signals[name] === number)\n\n if (signal !== undefined) {\n return signal\n }\n\n return signals.find((signalA) => signalA.number === number)\n}\n\nexport const signalsByNumber = getSignalsByNumber()\n"],"file":"src/main.js"}
|
|
@ -1,19 +0,0 @@
|
|||||||
|
|
||||||
export const getRealtimeSignals=function(){
|
|
||||||
const length=SIGRTMAX-SIGRTMIN+1;
|
|
||||||
return Array.from({length},getRealtimeSignal);
|
|
||||||
};
|
|
||||||
|
|
||||||
const getRealtimeSignal=function(value,index){
|
|
||||||
return{
|
|
||||||
name:`SIGRT${index+1}`,
|
|
||||||
number:SIGRTMIN+index,
|
|
||||||
action:"terminate",
|
|
||||||
description:"Application-specific signal (realtime)",
|
|
||||||
standard:"posix"};
|
|
||||||
|
|
||||||
};
|
|
||||||
|
|
||||||
const SIGRTMIN=34;
|
|
||||||
export const SIGRTMAX=64;
|
|
||||||
//# sourceMappingURL=realtime.js.map
|
|
@ -1 +0,0 @@
|
|||||||
{"version":3,"sources":["../../src/realtime.js"],"names":["getRealtimeSignals","length","SIGRTMAX","SIGRTMIN","Array","from","getRealtimeSignal","value","index","name","number","action","description","standard"],"mappings":";AACA,MAAO,MAAMA,CAAAA,kBAAkB,CAAG,UAAY;AAC5C,KAAMC,CAAAA,MAAM,CAAGC,QAAQ,CAAGC,QAAX,CAAsB,CAArC;AACA,MAAOC,CAAAA,KAAK,CAACC,IAAN,CAAW,CAAEJ,MAAF,CAAX,CAAuBK,iBAAvB,CAAP;AACD,CAHM;;AAKP,KAAMA,CAAAA,iBAAiB,CAAG,SAAUC,KAAV,CAAiBC,KAAjB,CAAwB;AAChD,MAAO;AACLC,IAAI,CAAG,QAAOD,KAAK,CAAG,CAAE,EADnB;AAELE,MAAM,CAAEP,QAAQ,CAAGK,KAFd;AAGLG,MAAM,CAAE,WAHH;AAILC,WAAW,CAAE,wCAJR;AAKLC,QAAQ,CAAE,OALL,CAAP;;AAOD,CARD;;AAUA,KAAMV,CAAAA,QAAQ,CAAG,EAAjB;AACA,MAAO,MAAMD,CAAAA,QAAQ,CAAG,EAAjB","sourcesContent":["// List of realtime signals with information about them\nexport const getRealtimeSignals = function () {\n const length = SIGRTMAX - SIGRTMIN + 1\n return Array.from({ length }, getRealtimeSignal)\n}\n\nconst getRealtimeSignal = function (value, index) {\n return {\n name: `SIGRT${index + 1}`,\n number: SIGRTMIN + index,\n action: 'terminate',\n description: 'Application-specific signal (realtime)',\n standard: 'posix',\n }\n}\n\nconst SIGRTMIN = 34\nexport const SIGRTMAX = 64\n"],"file":"src/realtime.js"}
|
|
@ -1,35 +0,0 @@
|
|||||||
import{constants}from"os";
|
|
||||||
|
|
||||||
import{SIGNALS}from"./core.js";
|
|
||||||
import{getRealtimeSignals}from"./realtime.js";
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
export const getSignals=function(){
|
|
||||||
const realtimeSignals=getRealtimeSignals();
|
|
||||||
const signals=[...SIGNALS,...realtimeSignals].map(normalizeSignal);
|
|
||||||
return signals;
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
const normalizeSignal=function({
|
|
||||||
name,
|
|
||||||
number:defaultNumber,
|
|
||||||
description,
|
|
||||||
action,
|
|
||||||
forced=false,
|
|
||||||
standard})
|
|
||||||
{
|
|
||||||
const{
|
|
||||||
signals:{[name]:constantSignal}}=
|
|
||||||
constants;
|
|
||||||
const supported=constantSignal!==undefined;
|
|
||||||
const number=supported?constantSignal:defaultNumber;
|
|
||||||
return{name,number,description,supported,action,forced,standard};
|
|
||||||
};
|
|
||||||
//# sourceMappingURL=signals.js.map
|
|
@ -1 +0,0 @@
|
|||||||
{"version":3,"sources":["../../src/signals.js"],"names":["constants","SIGNALS","getRealtimeSignals","getSignals","realtimeSignals","signals","map","normalizeSignal","name","number","defaultNumber","description","action","forced","standard","constantSignal","supported","undefined"],"mappings":"AAAA,OAASA,SAAT,KAA0B,IAA1B;;AAEA,OAASC,OAAT,KAAwB,WAAxB;AACA,OAASC,kBAAT,KAAmC,eAAnC;;;;AAIA,MAAO,MAAMC,CAAAA,UAAU,CAAG,UAAY;AACpC,KAAMC,CAAAA,eAAe,CAAGF,kBAAkB,EAA1C;AACA,KAAMG,CAAAA,OAAO,CAAG,CAAC,GAAGJ,OAAJ,CAAa,GAAGG,eAAhB,EAAiCE,GAAjC,CAAqCC,eAArC,CAAhB;AACA,MAAOF,CAAAA,OAAP;AACD,CAJM;;;;;;;;AAYP,KAAME,CAAAA,eAAe,CAAG,SAAU;AAChCC,IADgC;AAEhCC,MAAM,CAAEC,aAFwB;AAGhCC,WAHgC;AAIhCC,MAJgC;AAKhCC,MAAM,CAAG,KALuB;AAMhCC,QANgC,CAAV;AAOrB;AACD,KAAM;AACJT,OAAO,CAAE,CAAE,CAACG,IAAD,EAAQO,cAAV,CADL;AAEFf,SAFJ;AAGA,KAAMgB,CAAAA,SAAS,CAAGD,cAAc,GAAKE,SAArC;AACA,KAAMR,CAAAA,MAAM,CAAGO,SAAS,CAAGD,cAAH,CAAoBL,aAA5C;AACA,MAAO,CAAEF,IAAF,CAAQC,MAAR,CAAgBE,WAAhB,CAA6BK,SAA7B,CAAwCJ,MAAxC,CAAgDC,MAAhD,CAAwDC,QAAxD,CAAP;AACD,CAdD","sourcesContent":["import { constants } from 'os'\n\nimport { SIGNALS } from './core.js'\nimport { getRealtimeSignals } from './realtime.js'\n\n// Retrieve list of know signals (including realtime) with information about\n// them\nexport const getSignals = function () {\n const realtimeSignals = getRealtimeSignals()\n const signals = [...SIGNALS, ...realtimeSignals].map(normalizeSignal)\n return signals\n}\n\n// Normalize signal:\n// - `number`: signal numbers are OS-specific. This is taken into account by\n// `os.constants.signals`. However we provide a default `number` since some\n// signals are not defined for some OS.\n// - `forced`: set default to `false`\n// - `supported`: set value\nconst normalizeSignal = function ({\n name,\n number: defaultNumber,\n description,\n action,\n forced = false,\n standard,\n}) {\n const {\n signals: { [name]: constantSignal },\n } = constants\n const supported = constantSignal !== undefined\n const number = supported ? constantSignal : defaultNumber\n return { name, number, description, supported, action, forced, standard }\n}\n"],"file":"src/signals.js"}
|
|
@ -1,57 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "human-signals",
|
|
||||||
"version": "3.0.1",
|
|
||||||
"type": "module",
|
|
||||||
"exports": "./build/src/main.js",
|
|
||||||
"main": "./build/src/main.js",
|
|
||||||
"files": [
|
|
||||||
"build/src/**/*.{js,ts,map,json,sh,md}",
|
|
||||||
"examples/**/*.{js,ts,map,json,sh,md}"
|
|
||||||
],
|
|
||||||
"scripts": {
|
|
||||||
"test": "gulp test"
|
|
||||||
},
|
|
||||||
"description": "Human-friendly process signals",
|
|
||||||
"keywords": [
|
|
||||||
"signal",
|
|
||||||
"signals",
|
|
||||||
"handlers",
|
|
||||||
"error-handling",
|
|
||||||
"errors",
|
|
||||||
"interrupts",
|
|
||||||
"sigterm",
|
|
||||||
"sigint",
|
|
||||||
"irq",
|
|
||||||
"process",
|
|
||||||
"exit",
|
|
||||||
"exit-code",
|
|
||||||
"status",
|
|
||||||
"operating-system",
|
|
||||||
"es6",
|
|
||||||
"javascript",
|
|
||||||
"linux",
|
|
||||||
"macos",
|
|
||||||
"windows",
|
|
||||||
"nodejs"
|
|
||||||
],
|
|
||||||
"license": "Apache-2.0",
|
|
||||||
"homepage": "https://git.io/JeluP",
|
|
||||||
"repository": "ehmicky/human-signals",
|
|
||||||
"bugs": {
|
|
||||||
"url": "https://github.com/ehmicky/human-signals/issues"
|
|
||||||
},
|
|
||||||
"author": "ehmicky <ehmicky@gmail.com> (https://github.com/ehmicky)",
|
|
||||||
"directories": {
|
|
||||||
"lib": "src",
|
|
||||||
"test": "test"
|
|
||||||
},
|
|
||||||
"types": "build/src/main.d.ts",
|
|
||||||
"devDependencies": {
|
|
||||||
"@ehmicky/dev-tasks": "^1.0.34",
|
|
||||||
"ajv": "^6.12.6",
|
|
||||||
"test-each": "^3.0.1"
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": ">=12.20.0"
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,81 +0,0 @@
|
|||||||
import {
|
|
||||||
Stream,
|
|
||||||
Writable as WritableStream,
|
|
||||||
Readable as ReadableStream,
|
|
||||||
Duplex as DuplexStream,
|
|
||||||
Transform as TransformStream,
|
|
||||||
} from 'node:stream';
|
|
||||||
|
|
||||||
/**
|
|
||||||
@returns Whether `stream` is a [`Stream`](https://nodejs.org/api/stream.html#stream_stream).
|
|
||||||
|
|
||||||
@example
|
|
||||||
```
|
|
||||||
import fs from 'node:fs';
|
|
||||||
import {isStream} from 'is-stream';
|
|
||||||
|
|
||||||
isStream(fs.createReadStream('unicorn.png'));
|
|
||||||
//=> true
|
|
||||||
|
|
||||||
isStream({});
|
|
||||||
//=> false
|
|
||||||
```
|
|
||||||
*/
|
|
||||||
export function isStream(stream: unknown): stream is Stream;
|
|
||||||
|
|
||||||
/**
|
|
||||||
@returns Whether `stream` is a [`stream.Writable`](https://nodejs.org/api/stream.html#stream_class_stream_writable).
|
|
||||||
|
|
||||||
@example
|
|
||||||
```
|
|
||||||
import fs from 'node:fs';
|
|
||||||
import {isWritableStream} from 'is-stream';
|
|
||||||
|
|
||||||
isWritableStream(fs.createWriteStrem('unicorn.txt'));
|
|
||||||
//=> true
|
|
||||||
```
|
|
||||||
*/
|
|
||||||
export function isWritableStream(stream: unknown): stream is WritableStream;
|
|
||||||
|
|
||||||
/**
|
|
||||||
@returns Whether `stream` is a [`stream.Readable`](https://nodejs.org/api/stream.html#stream_class_stream_readable).
|
|
||||||
|
|
||||||
@example
|
|
||||||
```
|
|
||||||
import fs from 'node:fs';
|
|
||||||
import {isReadableStream} from 'is-stream';
|
|
||||||
|
|
||||||
isReadableStream(fs.createReadStream('unicorn.png'));
|
|
||||||
//=> true
|
|
||||||
```
|
|
||||||
*/
|
|
||||||
export function isReadableStream(stream: unknown): stream is ReadableStream;
|
|
||||||
|
|
||||||
/**
|
|
||||||
@returns Whether `stream` is a [`stream.Duplex`](https://nodejs.org/api/stream.html#stream_class_stream_duplex).
|
|
||||||
|
|
||||||
@example
|
|
||||||
```
|
|
||||||
import {Duplex as DuplexStream} from 'node:stream';
|
|
||||||
import {isDuplexStream} from 'is-stream';
|
|
||||||
|
|
||||||
isDuplexStream(new DuplexStream());
|
|
||||||
//=> true
|
|
||||||
```
|
|
||||||
*/
|
|
||||||
export function isDuplexStream(stream: unknown): stream is DuplexStream;
|
|
||||||
|
|
||||||
/**
|
|
||||||
@returns Whether `stream` is a [`stream.Transform`](https://nodejs.org/api/stream.html#stream_class_stream_transform).
|
|
||||||
|
|
||||||
@example
|
|
||||||
```
|
|
||||||
import fs from 'node:fs';
|
|
||||||
import StringifyStream from 'streaming-json-stringify';
|
|
||||||
import {isTransformStream} from 'is-stream';
|
|
||||||
|
|
||||||
isTransformStream(StringifyStream());
|
|
||||||
//=> true
|
|
||||||
```
|
|
||||||
*/
|
|
||||||
export function isTransformStream(stream: unknown): stream is TransformStream;
|
|
@ -1,29 +0,0 @@
|
|||||||
export function isStream(stream) {
|
|
||||||
return stream !== null
|
|
||||||
&& typeof stream === 'object'
|
|
||||||
&& typeof stream.pipe === 'function';
|
|
||||||
}
|
|
||||||
|
|
||||||
export function isWritableStream(stream) {
|
|
||||||
return isStream(stream)
|
|
||||||
&& stream.writable !== false
|
|
||||||
&& typeof stream._write === 'function'
|
|
||||||
&& typeof stream._writableState === 'object';
|
|
||||||
}
|
|
||||||
|
|
||||||
export function isReadableStream(stream) {
|
|
||||||
return isStream(stream)
|
|
||||||
&& stream.readable !== false
|
|
||||||
&& typeof stream._read === 'function'
|
|
||||||
&& typeof stream._readableState === 'object';
|
|
||||||
}
|
|
||||||
|
|
||||||
export function isDuplexStream(stream) {
|
|
||||||
return isWritableStream(stream)
|
|
||||||
&& isReadableStream(stream);
|
|
||||||
}
|
|
||||||
|
|
||||||
export function isTransformStream(stream) {
|
|
||||||
return isDuplexStream(stream)
|
|
||||||
&& typeof stream._transform === 'function';
|
|
||||||
}
|
|
@ -1,9 +0,0 @@
|
|||||||
MIT License
|
|
||||||
|
|
||||||
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
@ -1,44 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "is-stream",
|
|
||||||
"version": "3.0.0",
|
|
||||||
"description": "Check if something is a Node.js stream",
|
|
||||||
"license": "MIT",
|
|
||||||
"repository": "sindresorhus/is-stream",
|
|
||||||
"funding": "https://github.com/sponsors/sindresorhus",
|
|
||||||
"author": {
|
|
||||||
"name": "Sindre Sorhus",
|
|
||||||
"email": "sindresorhus@gmail.com",
|
|
||||||
"url": "https://sindresorhus.com"
|
|
||||||
},
|
|
||||||
"type": "module",
|
|
||||||
"exports": "./index.js",
|
|
||||||
"engines": {
|
|
||||||
"node": "^12.20.0 || ^14.13.1 || >=16.0.0"
|
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"test": "xo && ava && tsd"
|
|
||||||
},
|
|
||||||
"files": [
|
|
||||||
"index.js",
|
|
||||||
"index.d.ts"
|
|
||||||
],
|
|
||||||
"keywords": [
|
|
||||||
"stream",
|
|
||||||
"type",
|
|
||||||
"streams",
|
|
||||||
"writable",
|
|
||||||
"readable",
|
|
||||||
"duplex",
|
|
||||||
"transform",
|
|
||||||
"check",
|
|
||||||
"detect",
|
|
||||||
"is"
|
|
||||||
],
|
|
||||||
"devDependencies": {
|
|
||||||
"@types/node": "^16.4.13",
|
|
||||||
"ava": "^3.15.0",
|
|
||||||
"tempy": "^1.0.1",
|
|
||||||
"tsd": "^0.17.0",
|
|
||||||
"xo": "^0.44.0"
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,60 +0,0 @@
|
|||||||
# is-stream
|
|
||||||
|
|
||||||
> Check if something is a [Node.js stream](https://nodejs.org/api/stream.html)
|
|
||||||
|
|
||||||
## Install
|
|
||||||
|
|
||||||
```
|
|
||||||
$ npm install is-stream
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```js
|
|
||||||
import fs from 'node:fs';
|
|
||||||
import {isStream} from 'is-stream';
|
|
||||||
|
|
||||||
isStream(fs.createReadStream('unicorn.png'));
|
|
||||||
//=> true
|
|
||||||
|
|
||||||
isStream({});
|
|
||||||
//=> false
|
|
||||||
```
|
|
||||||
|
|
||||||
## API
|
|
||||||
|
|
||||||
### isStream(stream)
|
|
||||||
|
|
||||||
Returns a `boolean` for whether it's a [`Stream`](https://nodejs.org/api/stream.html#stream_stream).
|
|
||||||
|
|
||||||
#### isWritableStream(stream)
|
|
||||||
|
|
||||||
Returns a `boolean` for whether it's a [`stream.Writable`](https://nodejs.org/api/stream.html#stream_class_stream_writable).
|
|
||||||
|
|
||||||
#### isReadableStream(stream)
|
|
||||||
|
|
||||||
Returns a `boolean` for whether it's a [`stream.Readable`](https://nodejs.org/api/stream.html#stream_class_stream_readable).
|
|
||||||
|
|
||||||
#### isDuplexStream(stream)
|
|
||||||
|
|
||||||
Returns a `boolean` for whether it's a [`stream.Duplex`](https://nodejs.org/api/stream.html#stream_class_stream_duplex).
|
|
||||||
|
|
||||||
#### isTransformStream(stream)
|
|
||||||
|
|
||||||
Returns a `boolean` for whether it's a [`stream.Transform`](https://nodejs.org/api/stream.html#stream_class_stream_transform).
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [is-file-stream](https://github.com/jamestalmage/is-file-stream) - Detect if a stream is a file stream
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
<div align="center">
|
|
||||||
<b>
|
|
||||||
<a href="https://tidelift.com/subscription/pkg/npm-is-stream?utm_source=npm-is-stream&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
|
|
||||||
</b>
|
|
||||||
<br>
|
|
||||||
<sub>
|
|
||||||
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
|
|
||||||
</sub>
|
|
||||||
</div>
|
|
@ -1,2 +0,0 @@
|
|||||||
.nyc_output/
|
|
||||||
coverage/
|
|
@ -1,15 +0,0 @@
|
|||||||
The ISC License
|
|
||||||
|
|
||||||
Copyright (c) Isaac Z. Schlueter and Contributors
|
|
||||||
|
|
||||||
Permission to use, copy, modify, and/or distribute this software for any
|
|
||||||
purpose with or without fee is hereby granted, provided that the above
|
|
||||||
copyright notice and this permission notice appear in all copies.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
||||||
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
||||||
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
||||||
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
||||||
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
||||||
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
|
|
||||||
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
@ -1,51 +0,0 @@
|
|||||||
# isexe
|
|
||||||
|
|
||||||
Minimal module to check if a file is executable, and a normal file.
|
|
||||||
|
|
||||||
Uses `fs.stat` and tests against the `PATHEXT` environment variable on
|
|
||||||
Windows.
|
|
||||||
|
|
||||||
## USAGE
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
var isexe = require('isexe')
|
|
||||||
isexe('some-file-name', function (err, isExe) {
|
|
||||||
if (err) {
|
|
||||||
console.error('probably file does not exist or something', err)
|
|
||||||
} else if (isExe) {
|
|
||||||
console.error('this thing can be run')
|
|
||||||
} else {
|
|
||||||
console.error('cannot be run')
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
// same thing but synchronous, throws errors
|
|
||||||
var isExe = isexe.sync('some-file-name')
|
|
||||||
|
|
||||||
// treat errors as just "not executable"
|
|
||||||
isexe('maybe-missing-file', { ignoreErrors: true }, callback)
|
|
||||||
var isExe = isexe.sync('maybe-missing-file', { ignoreErrors: true })
|
|
||||||
```
|
|
||||||
|
|
||||||
## API
|
|
||||||
|
|
||||||
### `isexe(path, [options], [callback])`
|
|
||||||
|
|
||||||
Check if the path is executable. If no callback provided, and a
|
|
||||||
global `Promise` object is available, then a Promise will be returned.
|
|
||||||
|
|
||||||
Will raise whatever errors may be raised by `fs.stat`, unless
|
|
||||||
`options.ignoreErrors` is set to true.
|
|
||||||
|
|
||||||
### `isexe.sync(path, [options])`
|
|
||||||
|
|
||||||
Same as `isexe` but returns the value and throws any errors raised.
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
* `ignoreErrors` Treat all errors as "no, this is not executable", but
|
|
||||||
don't raise them.
|
|
||||||
* `uid` Number to use as the user id
|
|
||||||
* `gid` Number to use as the group id
|
|
||||||
* `pathExt` List of path extensions to use instead of `PATHEXT`
|
|
||||||
environment variable on Windows.
|
|
@ -1,57 +0,0 @@
|
|||||||
var fs = require('fs')
|
|
||||||
var core
|
|
||||||
if (process.platform === 'win32' || global.TESTING_WINDOWS) {
|
|
||||||
core = require('./windows.js')
|
|
||||||
} else {
|
|
||||||
core = require('./mode.js')
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = isexe
|
|
||||||
isexe.sync = sync
|
|
||||||
|
|
||||||
function isexe (path, options, cb) {
|
|
||||||
if (typeof options === 'function') {
|
|
||||||
cb = options
|
|
||||||
options = {}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!cb) {
|
|
||||||
if (typeof Promise !== 'function') {
|
|
||||||
throw new TypeError('callback not provided')
|
|
||||||
}
|
|
||||||
|
|
||||||
return new Promise(function (resolve, reject) {
|
|
||||||
isexe(path, options || {}, function (er, is) {
|
|
||||||
if (er) {
|
|
||||||
reject(er)
|
|
||||||
} else {
|
|
||||||
resolve(is)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
core(path, options || {}, function (er, is) {
|
|
||||||
// ignore EACCES because that just means we aren't allowed to run it
|
|
||||||
if (er) {
|
|
||||||
if (er.code === 'EACCES' || options && options.ignoreErrors) {
|
|
||||||
er = null
|
|
||||||
is = false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
cb(er, is)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
function sync (path, options) {
|
|
||||||
// my kingdom for a filtered catch
|
|
||||||
try {
|
|
||||||
return core.sync(path, options || {})
|
|
||||||
} catch (er) {
|
|
||||||
if (options && options.ignoreErrors || er.code === 'EACCES') {
|
|
||||||
return false
|
|
||||||
} else {
|
|
||||||
throw er
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,41 +0,0 @@
|
|||||||
module.exports = isexe
|
|
||||||
isexe.sync = sync
|
|
||||||
|
|
||||||
var fs = require('fs')
|
|
||||||
|
|
||||||
function isexe (path, options, cb) {
|
|
||||||
fs.stat(path, function (er, stat) {
|
|
||||||
cb(er, er ? false : checkStat(stat, options))
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
function sync (path, options) {
|
|
||||||
return checkStat(fs.statSync(path), options)
|
|
||||||
}
|
|
||||||
|
|
||||||
function checkStat (stat, options) {
|
|
||||||
return stat.isFile() && checkMode(stat, options)
|
|
||||||
}
|
|
||||||
|
|
||||||
function checkMode (stat, options) {
|
|
||||||
var mod = stat.mode
|
|
||||||
var uid = stat.uid
|
|
||||||
var gid = stat.gid
|
|
||||||
|
|
||||||
var myUid = options.uid !== undefined ?
|
|
||||||
options.uid : process.getuid && process.getuid()
|
|
||||||
var myGid = options.gid !== undefined ?
|
|
||||||
options.gid : process.getgid && process.getgid()
|
|
||||||
|
|
||||||
var u = parseInt('100', 8)
|
|
||||||
var g = parseInt('010', 8)
|
|
||||||
var o = parseInt('001', 8)
|
|
||||||
var ug = u | g
|
|
||||||
|
|
||||||
var ret = (mod & o) ||
|
|
||||||
(mod & g) && gid === myGid ||
|
|
||||||
(mod & u) && uid === myUid ||
|
|
||||||
(mod & ug) && myUid === 0
|
|
||||||
|
|
||||||
return ret
|
|
||||||
}
|
|
@ -1,31 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "isexe",
|
|
||||||
"version": "2.0.0",
|
|
||||||
"description": "Minimal module to check if a file is executable.",
|
|
||||||
"main": "index.js",
|
|
||||||
"directories": {
|
|
||||||
"test": "test"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"mkdirp": "^0.5.1",
|
|
||||||
"rimraf": "^2.5.0",
|
|
||||||
"tap": "^10.3.0"
|
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"test": "tap test/*.js --100",
|
|
||||||
"preversion": "npm test",
|
|
||||||
"postversion": "npm publish",
|
|
||||||
"postpublish": "git push origin --all; git push origin --tags"
|
|
||||||
},
|
|
||||||
"author": "Isaac Z. Schlueter <i@izs.me> (http://blog.izs.me/)",
|
|
||||||
"license": "ISC",
|
|
||||||
"repository": {
|
|
||||||
"type": "git",
|
|
||||||
"url": "git+https://github.com/isaacs/isexe.git"
|
|
||||||
},
|
|
||||||
"keywords": [],
|
|
||||||
"bugs": {
|
|
||||||
"url": "https://github.com/isaacs/isexe/issues"
|
|
||||||
},
|
|
||||||
"homepage": "https://github.com/isaacs/isexe#readme"
|
|
||||||
}
|
|
@ -1,221 +0,0 @@
|
|||||||
var t = require('tap')
|
|
||||||
var fs = require('fs')
|
|
||||||
var path = require('path')
|
|
||||||
var fixture = path.resolve(__dirname, 'fixtures')
|
|
||||||
var meow = fixture + '/meow.cat'
|
|
||||||
var mine = fixture + '/mine.cat'
|
|
||||||
var ours = fixture + '/ours.cat'
|
|
||||||
var fail = fixture + '/fail.false'
|
|
||||||
var noent = fixture + '/enoent.exe'
|
|
||||||
var mkdirp = require('mkdirp')
|
|
||||||
var rimraf = require('rimraf')
|
|
||||||
|
|
||||||
var isWindows = process.platform === 'win32'
|
|
||||||
var hasAccess = typeof fs.access === 'function'
|
|
||||||
var winSkip = isWindows && 'windows'
|
|
||||||
var accessSkip = !hasAccess && 'no fs.access function'
|
|
||||||
var hasPromise = typeof Promise === 'function'
|
|
||||||
var promiseSkip = !hasPromise && 'no global Promise'
|
|
||||||
|
|
||||||
function reset () {
|
|
||||||
delete require.cache[require.resolve('../')]
|
|
||||||
return require('../')
|
|
||||||
}
|
|
||||||
|
|
||||||
t.test('setup fixtures', function (t) {
|
|
||||||
rimraf.sync(fixture)
|
|
||||||
mkdirp.sync(fixture)
|
|
||||||
fs.writeFileSync(meow, '#!/usr/bin/env cat\nmeow\n')
|
|
||||||
fs.chmodSync(meow, parseInt('0755', 8))
|
|
||||||
fs.writeFileSync(fail, '#!/usr/bin/env false\n')
|
|
||||||
fs.chmodSync(fail, parseInt('0644', 8))
|
|
||||||
fs.writeFileSync(mine, '#!/usr/bin/env cat\nmine\n')
|
|
||||||
fs.chmodSync(mine, parseInt('0744', 8))
|
|
||||||
fs.writeFileSync(ours, '#!/usr/bin/env cat\nours\n')
|
|
||||||
fs.chmodSync(ours, parseInt('0754', 8))
|
|
||||||
t.end()
|
|
||||||
})
|
|
||||||
|
|
||||||
t.test('promise', { skip: promiseSkip }, function (t) {
|
|
||||||
var isexe = reset()
|
|
||||||
t.test('meow async', function (t) {
|
|
||||||
isexe(meow).then(function (is) {
|
|
||||||
t.ok(is)
|
|
||||||
t.end()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
t.test('fail async', function (t) {
|
|
||||||
isexe(fail).then(function (is) {
|
|
||||||
t.notOk(is)
|
|
||||||
t.end()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
t.test('noent async', function (t) {
|
|
||||||
isexe(noent).catch(function (er) {
|
|
||||||
t.ok(er)
|
|
||||||
t.end()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
t.test('noent ignore async', function (t) {
|
|
||||||
isexe(noent, { ignoreErrors: true }).then(function (is) {
|
|
||||||
t.notOk(is)
|
|
||||||
t.end()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
t.end()
|
|
||||||
})
|
|
||||||
|
|
||||||
t.test('no promise', function (t) {
|
|
||||||
global.Promise = null
|
|
||||||
var isexe = reset()
|
|
||||||
t.throws('try to meow a promise', function () {
|
|
||||||
isexe(meow)
|
|
||||||
})
|
|
||||||
t.end()
|
|
||||||
})
|
|
||||||
|
|
||||||
t.test('access', { skip: accessSkip || winSkip }, function (t) {
|
|
||||||
runTest(t)
|
|
||||||
})
|
|
||||||
|
|
||||||
t.test('mode', { skip: winSkip }, function (t) {
|
|
||||||
delete fs.access
|
|
||||||
delete fs.accessSync
|
|
||||||
var isexe = reset()
|
|
||||||
t.ok(isexe.sync(ours, { uid: 0, gid: 0 }))
|
|
||||||
t.ok(isexe.sync(mine, { uid: 0, gid: 0 }))
|
|
||||||
runTest(t)
|
|
||||||
})
|
|
||||||
|
|
||||||
t.test('windows', function (t) {
|
|
||||||
global.TESTING_WINDOWS = true
|
|
||||||
var pathExt = '.EXE;.CAT;.CMD;.COM'
|
|
||||||
t.test('pathExt option', function (t) {
|
|
||||||
runTest(t, { pathExt: '.EXE;.CAT;.CMD;.COM' })
|
|
||||||
})
|
|
||||||
t.test('pathExt env', function (t) {
|
|
||||||
process.env.PATHEXT = pathExt
|
|
||||||
runTest(t)
|
|
||||||
})
|
|
||||||
t.test('no pathExt', function (t) {
|
|
||||||
// with a pathExt of '', any filename is fine.
|
|
||||||
// so the "fail" one would still pass.
|
|
||||||
runTest(t, { pathExt: '', skipFail: true })
|
|
||||||
})
|
|
||||||
t.test('pathext with empty entry', function (t) {
|
|
||||||
// with a pathExt of '', any filename is fine.
|
|
||||||
// so the "fail" one would still pass.
|
|
||||||
runTest(t, { pathExt: ';' + pathExt, skipFail: true })
|
|
||||||
})
|
|
||||||
t.end()
|
|
||||||
})
|
|
||||||
|
|
||||||
t.test('cleanup', function (t) {
|
|
||||||
rimraf.sync(fixture)
|
|
||||||
t.end()
|
|
||||||
})
|
|
||||||
|
|
||||||
function runTest (t, options) {
|
|
||||||
var isexe = reset()
|
|
||||||
|
|
||||||
var optionsIgnore = Object.create(options || {})
|
|
||||||
optionsIgnore.ignoreErrors = true
|
|
||||||
|
|
||||||
if (!options || !options.skipFail) {
|
|
||||||
t.notOk(isexe.sync(fail, options))
|
|
||||||
}
|
|
||||||
t.notOk(isexe.sync(noent, optionsIgnore))
|
|
||||||
if (!options) {
|
|
||||||
t.ok(isexe.sync(meow))
|
|
||||||
} else {
|
|
||||||
t.ok(isexe.sync(meow, options))
|
|
||||||
}
|
|
||||||
|
|
||||||
t.ok(isexe.sync(mine, options))
|
|
||||||
t.ok(isexe.sync(ours, options))
|
|
||||||
t.throws(function () {
|
|
||||||
isexe.sync(noent, options)
|
|
||||||
})
|
|
||||||
|
|
||||||
t.test('meow async', function (t) {
|
|
||||||
if (!options) {
|
|
||||||
isexe(meow, function (er, is) {
|
|
||||||
if (er) {
|
|
||||||
throw er
|
|
||||||
}
|
|
||||||
t.ok(is)
|
|
||||||
t.end()
|
|
||||||
})
|
|
||||||
} else {
|
|
||||||
isexe(meow, options, function (er, is) {
|
|
||||||
if (er) {
|
|
||||||
throw er
|
|
||||||
}
|
|
||||||
t.ok(is)
|
|
||||||
t.end()
|
|
||||||
})
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
t.test('mine async', function (t) {
|
|
||||||
isexe(mine, options, function (er, is) {
|
|
||||||
if (er) {
|
|
||||||
throw er
|
|
||||||
}
|
|
||||||
t.ok(is)
|
|
||||||
t.end()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
t.test('ours async', function (t) {
|
|
||||||
isexe(ours, options, function (er, is) {
|
|
||||||
if (er) {
|
|
||||||
throw er
|
|
||||||
}
|
|
||||||
t.ok(is)
|
|
||||||
t.end()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
if (!options || !options.skipFail) {
|
|
||||||
t.test('fail async', function (t) {
|
|
||||||
isexe(fail, options, function (er, is) {
|
|
||||||
if (er) {
|
|
||||||
throw er
|
|
||||||
}
|
|
||||||
t.notOk(is)
|
|
||||||
t.end()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
t.test('noent async', function (t) {
|
|
||||||
isexe(noent, options, function (er, is) {
|
|
||||||
t.ok(er)
|
|
||||||
t.notOk(is)
|
|
||||||
t.end()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
t.test('noent ignore async', function (t) {
|
|
||||||
isexe(noent, optionsIgnore, function (er, is) {
|
|
||||||
if (er) {
|
|
||||||
throw er
|
|
||||||
}
|
|
||||||
t.notOk(is)
|
|
||||||
t.end()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
t.test('directory is not executable', function (t) {
|
|
||||||
isexe(__dirname, options, function (er, is) {
|
|
||||||
if (er) {
|
|
||||||
throw er
|
|
||||||
}
|
|
||||||
t.notOk(is)
|
|
||||||
t.end()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
t.end()
|
|
||||||
}
|
|
@ -1,42 +0,0 @@
|
|||||||
module.exports = isexe
|
|
||||||
isexe.sync = sync
|
|
||||||
|
|
||||||
var fs = require('fs')
|
|
||||||
|
|
||||||
function checkPathExt (path, options) {
|
|
||||||
var pathext = options.pathExt !== undefined ?
|
|
||||||
options.pathExt : process.env.PATHEXT
|
|
||||||
|
|
||||||
if (!pathext) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
pathext = pathext.split(';')
|
|
||||||
if (pathext.indexOf('') !== -1) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
for (var i = 0; i < pathext.length; i++) {
|
|
||||||
var p = pathext[i].toLowerCase()
|
|
||||||
if (p && path.substr(-p.length).toLowerCase() === p) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
function checkStat (stat, path, options) {
|
|
||||||
if (!stat.isSymbolicLink() && !stat.isFile()) {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
return checkPathExt(path, options)
|
|
||||||
}
|
|
||||||
|
|
||||||
function isexe (path, options, cb) {
|
|
||||||
fs.stat(path, function (er, stat) {
|
|
||||||
cb(er, er ? false : checkStat(stat, path, options))
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
function sync (path, options) {
|
|
||||||
return checkStat(fs.statSync(path), path, options)
|
|
||||||
}
|
|
@ -1,21 +0,0 @@
|
|||||||
The MIT License (MIT)
|
|
||||||
|
|
||||||
Copyright (c) Stephen Sugden <me@stephensugden.com> (stephensugden.com)
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in
|
|
||||||
all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
||||||
THE SOFTWARE.
|
|
@ -1,78 +0,0 @@
|
|||||||
# merge-stream
|
|
||||||
|
|
||||||
Merge (interleave) a bunch of streams.
|
|
||||||
|
|
||||||
[![build status](https://secure.travis-ci.org/grncdr/merge-stream.svg?branch=master)](http://travis-ci.org/grncdr/merge-stream)
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
var stream1 = new Stream();
|
|
||||||
var stream2 = new Stream();
|
|
||||||
|
|
||||||
var merged = mergeStream(stream1, stream2);
|
|
||||||
|
|
||||||
var stream3 = new Stream();
|
|
||||||
merged.add(stream3);
|
|
||||||
merged.isEmpty();
|
|
||||||
//=> false
|
|
||||||
```
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
This is adapted from [event-stream](https://github.com/dominictarr/event-stream) separated into a new module, using Streams3.
|
|
||||||
|
|
||||||
## API
|
|
||||||
|
|
||||||
### `mergeStream`
|
|
||||||
|
|
||||||
Type: `function`
|
|
||||||
|
|
||||||
Merges an arbitrary number of streams. Returns a merged stream.
|
|
||||||
|
|
||||||
#### `merged.add`
|
|
||||||
|
|
||||||
A method to dynamically add more sources to the stream. The argument supplied to `add` can be either a source or an array of sources.
|
|
||||||
|
|
||||||
#### `merged.isEmpty`
|
|
||||||
|
|
||||||
A method that tells you if the merged stream is empty.
|
|
||||||
|
|
||||||
When a stream is "empty" (aka. no sources were added), it could not be returned to a gulp task.
|
|
||||||
|
|
||||||
So, we could do something like this:
|
|
||||||
|
|
||||||
```js
|
|
||||||
stream = require('merge-stream')();
|
|
||||||
// Something like a loop to add some streams to the merge stream
|
|
||||||
// stream.add(streamA);
|
|
||||||
// stream.add(streamB);
|
|
||||||
return stream.isEmpty() ? null : stream;
|
|
||||||
```
|
|
||||||
|
|
||||||
## Gulp example
|
|
||||||
|
|
||||||
An example use case for **merge-stream** is to combine parts of a task in a project's **gulpfile.js** like this:
|
|
||||||
|
|
||||||
```js
|
|
||||||
const gulp = require('gulp');
|
|
||||||
const htmlValidator = require('gulp-w3c-html-validator');
|
|
||||||
const jsHint = require('gulp-jshint');
|
|
||||||
const mergeStream = require('merge-stream');
|
|
||||||
|
|
||||||
function lint() {
|
|
||||||
return mergeStream(
|
|
||||||
gulp.src('src/*.html')
|
|
||||||
.pipe(htmlValidator())
|
|
||||||
.pipe(htmlValidator.reporter()),
|
|
||||||
gulp.src('src/*.js')
|
|
||||||
.pipe(jsHint())
|
|
||||||
.pipe(jsHint.reporter())
|
|
||||||
);
|
|
||||||
}
|
|
||||||
gulp.task('lint', lint);
|
|
||||||
```
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
MIT
|
|
@ -1,41 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
const { PassThrough } = require('stream');
|
|
||||||
|
|
||||||
module.exports = function (/*streams...*/) {
|
|
||||||
var sources = []
|
|
||||||
var output = new PassThrough({objectMode: true})
|
|
||||||
|
|
||||||
output.setMaxListeners(0)
|
|
||||||
|
|
||||||
output.add = add
|
|
||||||
output.isEmpty = isEmpty
|
|
||||||
|
|
||||||
output.on('unpipe', remove)
|
|
||||||
|
|
||||||
Array.prototype.slice.call(arguments).forEach(add)
|
|
||||||
|
|
||||||
return output
|
|
||||||
|
|
||||||
function add (source) {
|
|
||||||
if (Array.isArray(source)) {
|
|
||||||
source.forEach(add)
|
|
||||||
return this
|
|
||||||
}
|
|
||||||
|
|
||||||
sources.push(source);
|
|
||||||
source.once('end', remove.bind(null, source))
|
|
||||||
source.once('error', output.emit.bind(output, 'error'))
|
|
||||||
source.pipe(output, {end: false})
|
|
||||||
return this
|
|
||||||
}
|
|
||||||
|
|
||||||
function isEmpty () {
|
|
||||||
return sources.length == 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
function remove (source) {
|
|
||||||
sources = sources.filter(function (it) { return it !== source })
|
|
||||||
if (!sources.length && output.readable) { output.end() }
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,19 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "merge-stream",
|
|
||||||
"version": "2.0.0",
|
|
||||||
"description": "Create a stream that emits events from multiple other streams",
|
|
||||||
"files": [
|
|
||||||
"index.js"
|
|
||||||
],
|
|
||||||
"scripts": {
|
|
||||||
"test": "istanbul cover test.js && istanbul check-cover --statements 100 --branches 100"
|
|
||||||
},
|
|
||||||
"repository": "grncdr/merge-stream",
|
|
||||||
"author": "Stephen Sugden <me@stephensugden.com>",
|
|
||||||
"license": "MIT",
|
|
||||||
"dependencies": {},
|
|
||||||
"devDependencies": {
|
|
||||||
"from2": "^2.0.3",
|
|
||||||
"istanbul": "^0.4.5"
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,52 +0,0 @@
|
|||||||
export interface Options {
|
|
||||||
/**
|
|
||||||
Skip modifying [non-configurable properties](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/getOwnPropertyDescriptor#Description) instead of throwing an error.
|
|
||||||
|
|
||||||
@default false
|
|
||||||
*/
|
|
||||||
readonly ignoreNonConfigurable?: boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
Modifies the `to` function to mimic the `from` function. Returns the `to` function.
|
|
||||||
|
|
||||||
`name`, `displayName`, and any other properties of `from` are copied. The `length` property is not copied. Prototype, class, and inherited properties are copied.
|
|
||||||
|
|
||||||
`to.toString()` will return the same as `from.toString()` but prepended with a `Wrapped with to()` comment.
|
|
||||||
|
|
||||||
@param to - Mimicking function.
|
|
||||||
@param from - Function to mimic.
|
|
||||||
@returns The modified `to` function.
|
|
||||||
|
|
||||||
@example
|
|
||||||
```
|
|
||||||
import mimicFunction from 'mimic-fn';
|
|
||||||
|
|
||||||
function foo() {}
|
|
||||||
foo.unicorn = '🦄';
|
|
||||||
|
|
||||||
function wrapper() {
|
|
||||||
return foo();
|
|
||||||
}
|
|
||||||
|
|
||||||
console.log(wrapper.name);
|
|
||||||
//=> 'wrapper'
|
|
||||||
|
|
||||||
mimicFunction(wrapper, foo);
|
|
||||||
|
|
||||||
console.log(wrapper.name);
|
|
||||||
//=> 'foo'
|
|
||||||
|
|
||||||
console.log(wrapper.unicorn);
|
|
||||||
//=> '🦄'
|
|
||||||
```
|
|
||||||
*/
|
|
||||||
export default function mimicFunction<
|
|
||||||
ArgumentsType extends unknown[],
|
|
||||||
ReturnType,
|
|
||||||
FunctionType extends (...arguments: ArgumentsType) => ReturnType
|
|
||||||
>(
|
|
||||||
to: (...arguments: ArgumentsType) => ReturnType,
|
|
||||||
from: FunctionType,
|
|
||||||
options?: Options,
|
|
||||||
): FunctionType;
|
|
@ -1,71 +0,0 @@
|
|||||||
const copyProperty = (to, from, property, ignoreNonConfigurable) => {
|
|
||||||
// `Function#length` should reflect the parameters of `to` not `from` since we keep its body.
|
|
||||||
// `Function#prototype` is non-writable and non-configurable so can never be modified.
|
|
||||||
if (property === 'length' || property === 'prototype') {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// `Function#arguments` and `Function#caller` should not be copied. They were reported to be present in `Reflect.ownKeys` for some devices in React Native (#41), so we explicitly ignore them here.
|
|
||||||
if (property === 'arguments' || property === 'caller') {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const toDescriptor = Object.getOwnPropertyDescriptor(to, property);
|
|
||||||
const fromDescriptor = Object.getOwnPropertyDescriptor(from, property);
|
|
||||||
|
|
||||||
if (!canCopyProperty(toDescriptor, fromDescriptor) && ignoreNonConfigurable) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
Object.defineProperty(to, property, fromDescriptor);
|
|
||||||
};
|
|
||||||
|
|
||||||
// `Object.defineProperty()` throws if the property exists, is not configurable and either:
|
|
||||||
// - one its descriptors is changed
|
|
||||||
// - it is non-writable and its value is changed
|
|
||||||
const canCopyProperty = function (toDescriptor, fromDescriptor) {
|
|
||||||
return toDescriptor === undefined || toDescriptor.configurable || (
|
|
||||||
toDescriptor.writable === fromDescriptor.writable &&
|
|
||||||
toDescriptor.enumerable === fromDescriptor.enumerable &&
|
|
||||||
toDescriptor.configurable === fromDescriptor.configurable &&
|
|
||||||
(toDescriptor.writable || toDescriptor.value === fromDescriptor.value)
|
|
||||||
);
|
|
||||||
};
|
|
||||||
|
|
||||||
const changePrototype = (to, from) => {
|
|
||||||
const fromPrototype = Object.getPrototypeOf(from);
|
|
||||||
if (fromPrototype === Object.getPrototypeOf(to)) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
Object.setPrototypeOf(to, fromPrototype);
|
|
||||||
};
|
|
||||||
|
|
||||||
const wrappedToString = (withName, fromBody) => `/* Wrapped ${withName}*/\n${fromBody}`;
|
|
||||||
|
|
||||||
const toStringDescriptor = Object.getOwnPropertyDescriptor(Function.prototype, 'toString');
|
|
||||||
const toStringName = Object.getOwnPropertyDescriptor(Function.prototype.toString, 'name');
|
|
||||||
|
|
||||||
// We call `from.toString()` early (not lazily) to ensure `from` can be garbage collected.
|
|
||||||
// We use `bind()` instead of a closure for the same reason.
|
|
||||||
// Calling `from.toString()` early also allows caching it in case `to.toString()` is called several times.
|
|
||||||
const changeToString = (to, from, name) => {
|
|
||||||
const withName = name === '' ? '' : `with ${name.trim()}() `;
|
|
||||||
const newToString = wrappedToString.bind(null, withName, from.toString());
|
|
||||||
// Ensure `to.toString.toString` is non-enumerable and has the same `same`
|
|
||||||
Object.defineProperty(newToString, 'name', toStringName);
|
|
||||||
Object.defineProperty(to, 'toString', {...toStringDescriptor, value: newToString});
|
|
||||||
};
|
|
||||||
|
|
||||||
export default function mimicFunction(to, from, {ignoreNonConfigurable = false} = {}) {
|
|
||||||
const {name} = to;
|
|
||||||
|
|
||||||
for (const property of Reflect.ownKeys(from)) {
|
|
||||||
copyProperty(to, from, property, ignoreNonConfigurable);
|
|
||||||
}
|
|
||||||
|
|
||||||
changePrototype(to, from);
|
|
||||||
changeToString(to, from, name);
|
|
||||||
|
|
||||||
return to;
|
|
||||||
}
|
|
@ -1,9 +0,0 @@
|
|||||||
MIT License
|
|
||||||
|
|
||||||
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
@ -1,45 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "mimic-fn",
|
|
||||||
"version": "4.0.0",
|
|
||||||
"description": "Make a function mimic another one",
|
|
||||||
"license": "MIT",
|
|
||||||
"repository": "sindresorhus/mimic-fn",
|
|
||||||
"funding": "https://github.com/sponsors/sindresorhus",
|
|
||||||
"author": {
|
|
||||||
"name": "Sindre Sorhus",
|
|
||||||
"email": "sindresorhus@gmail.com",
|
|
||||||
"url": "https://sindresorhus.com"
|
|
||||||
},
|
|
||||||
"type": "module",
|
|
||||||
"exports": "./index.js",
|
|
||||||
"engines": {
|
|
||||||
"node": ">=12"
|
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"test": "xo && ava && tsd"
|
|
||||||
},
|
|
||||||
"files": [
|
|
||||||
"index.js",
|
|
||||||
"index.d.ts"
|
|
||||||
],
|
|
||||||
"keywords": [
|
|
||||||
"function",
|
|
||||||
"mimic",
|
|
||||||
"imitate",
|
|
||||||
"rename",
|
|
||||||
"copy",
|
|
||||||
"inherit",
|
|
||||||
"properties",
|
|
||||||
"name",
|
|
||||||
"func",
|
|
||||||
"fn",
|
|
||||||
"set",
|
|
||||||
"infer",
|
|
||||||
"change"
|
|
||||||
],
|
|
||||||
"devDependencies": {
|
|
||||||
"ava": "^3.15.0",
|
|
||||||
"tsd": "^0.14.0",
|
|
||||||
"xo": "^0.38.2"
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,90 +0,0 @@
|
|||||||
<img src="media/logo.svg" alt="mimic-fn" width="400">
|
|
||||||
<br>
|
|
||||||
|
|
||||||
> Make a function mimic another one
|
|
||||||
|
|
||||||
Useful when you wrap a function in another function and like to preserve the original name and other properties.
|
|
||||||
|
|
||||||
## Install
|
|
||||||
|
|
||||||
```
|
|
||||||
$ npm install mimic-fn
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```js
|
|
||||||
import mimicFunction from 'mimic-fn';
|
|
||||||
|
|
||||||
function foo() {}
|
|
||||||
foo.unicorn = '🦄';
|
|
||||||
|
|
||||||
function wrapper() {
|
|
||||||
return foo();
|
|
||||||
}
|
|
||||||
|
|
||||||
console.log(wrapper.name);
|
|
||||||
//=> 'wrapper'
|
|
||||||
|
|
||||||
mimicFunction(wrapper, foo);
|
|
||||||
|
|
||||||
console.log(wrapper.name);
|
|
||||||
//=> 'foo'
|
|
||||||
|
|
||||||
console.log(wrapper.unicorn);
|
|
||||||
//=> '🦄'
|
|
||||||
|
|
||||||
console.log(String(wrapper));
|
|
||||||
//=> '/* Wrapped with wrapper() */\nfunction foo() {}'
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## API
|
|
||||||
|
|
||||||
### mimicFunction(to, from, options?)
|
|
||||||
|
|
||||||
Modifies the `to` function to mimic the `from` function. Returns the `to` function.
|
|
||||||
|
|
||||||
`name`, `displayName`, and any other properties of `from` are copied. The `length` property is not copied. Prototype, class, and inherited properties are copied.
|
|
||||||
|
|
||||||
`to.toString()` will return the same as `from.toString()` but prepended with a `Wrapped with to()` comment.
|
|
||||||
|
|
||||||
#### to
|
|
||||||
|
|
||||||
Type: `Function`
|
|
||||||
|
|
||||||
Mimicking function.
|
|
||||||
|
|
||||||
#### from
|
|
||||||
|
|
||||||
Type: `Function`
|
|
||||||
|
|
||||||
Function to mimic.
|
|
||||||
|
|
||||||
#### options
|
|
||||||
|
|
||||||
Type: `object`
|
|
||||||
|
|
||||||
##### ignoreNonConfigurable
|
|
||||||
|
|
||||||
Type: `boolean`\
|
|
||||||
Default: `false`
|
|
||||||
|
|
||||||
Skip modifying [non-configurable properties](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/getOwnPropertyDescriptor#Description) instead of throwing an error.
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [rename-fn](https://github.com/sindresorhus/rename-fn) - Rename a function
|
|
||||||
- [keep-func-props](https://github.com/ehmicky/keep-func-props) - Wrap a function without changing its name and other properties
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
<div align="center">
|
|
||||||
<b>
|
|
||||||
<a href="https://tidelift.com/subscription/pkg/npm-mimic-fn?utm_source=npm-mimic-fn&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
|
|
||||||
</b>
|
|
||||||
<br>
|
|
||||||
<sub>
|
|
||||||
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
|
|
||||||
</sub>
|
|
||||||
</div>
|
|
@ -1,84 +0,0 @@
|
|||||||
export interface RunPathOptions {
|
|
||||||
/**
|
|
||||||
Working directory.
|
|
||||||
|
|
||||||
@default process.cwd()
|
|
||||||
*/
|
|
||||||
readonly cwd?: string | URL;
|
|
||||||
|
|
||||||
/**
|
|
||||||
PATH to be appended. Default: [`PATH`](https://github.com/sindresorhus/path-key).
|
|
||||||
|
|
||||||
Set it to an empty string to exclude the default PATH.
|
|
||||||
*/
|
|
||||||
readonly path?: string;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Path to the Node.js executable to use in child processes if that is different from the current one. Its directory is pushed to the front of PATH.
|
|
||||||
|
|
||||||
This can be either an absolute path or a path relative to the `cwd` option.
|
|
||||||
|
|
||||||
@default process.execPath
|
|
||||||
*/
|
|
||||||
readonly execPath?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export type ProcessEnv = Record<string, string | undefined>;
|
|
||||||
|
|
||||||
export interface EnvOptions {
|
|
||||||
/**
|
|
||||||
The working directory.
|
|
||||||
|
|
||||||
@default process.cwd()
|
|
||||||
*/
|
|
||||||
readonly cwd?: string | URL;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Accepts an object of environment variables, like `process.env`, and modifies the PATH using the correct [PATH key](https://github.com/sindresorhus/path-key). Use this if you're modifying the PATH for use in the `child_process` options.
|
|
||||||
*/
|
|
||||||
readonly env?: ProcessEnv;
|
|
||||||
|
|
||||||
/**
|
|
||||||
The path to the current Node.js executable. Its directory is pushed to the front of PATH.
|
|
||||||
|
|
||||||
This can be either an absolute path or a path relative to the `cwd` option.
|
|
||||||
|
|
||||||
@default process.execPath
|
|
||||||
*/
|
|
||||||
readonly execPath?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
Get your [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) prepended with locally installed binaries.
|
|
||||||
|
|
||||||
@returns The augmented path string.
|
|
||||||
|
|
||||||
@example
|
|
||||||
```
|
|
||||||
import childProcess from 'node:child_process';
|
|
||||||
import {npmRunPath} from 'npm-run-path';
|
|
||||||
|
|
||||||
console.log(process.env.PATH);
|
|
||||||
//=> '/usr/local/bin'
|
|
||||||
|
|
||||||
console.log(npmRunPath());
|
|
||||||
//=> '/Users/sindresorhus/dev/foo/node_modules/.bin:/Users/sindresorhus/dev/node_modules/.bin:/Users/sindresorhus/node_modules/.bin:/Users/node_modules/.bin:/node_modules/.bin:/usr/local/bin'
|
|
||||||
```
|
|
||||||
*/
|
|
||||||
export function npmRunPath(options?: RunPathOptions): string;
|
|
||||||
|
|
||||||
/**
|
|
||||||
@returns The augmented [`process.env`](https://nodejs.org/api/process.html#process_process_env) object.
|
|
||||||
|
|
||||||
@example
|
|
||||||
```
|
|
||||||
import childProcess from 'node:child_process';
|
|
||||||
import {npmRunPathEnv} from 'npm-run-path';
|
|
||||||
|
|
||||||
// `foo` is a locally installed binary
|
|
||||||
childProcess.execFileSync('foo', {
|
|
||||||
env: npmRunPathEnv()
|
|
||||||
});
|
|
||||||
```
|
|
||||||
*/
|
|
||||||
export function npmRunPathEnv(options?: EnvOptions): ProcessEnv;
|
|
@ -1,38 +0,0 @@
|
|||||||
import process from 'node:process';
|
|
||||||
import path from 'node:path';
|
|
||||||
import url from 'node:url';
|
|
||||||
import pathKey from 'path-key';
|
|
||||||
|
|
||||||
export function npmRunPath(options = {}) {
|
|
||||||
const {
|
|
||||||
cwd = process.cwd(),
|
|
||||||
path: path_ = process.env[pathKey()],
|
|
||||||
execPath = process.execPath,
|
|
||||||
} = options;
|
|
||||||
|
|
||||||
let previous;
|
|
||||||
const cwdString = cwd instanceof URL ? url.fileURLToPath(cwd) : cwd;
|
|
||||||
let cwdPath = path.resolve(cwdString);
|
|
||||||
const result = [];
|
|
||||||
|
|
||||||
while (previous !== cwdPath) {
|
|
||||||
result.push(path.join(cwdPath, 'node_modules/.bin'));
|
|
||||||
previous = cwdPath;
|
|
||||||
cwdPath = path.resolve(cwdPath, '..');
|
|
||||||
}
|
|
||||||
|
|
||||||
// Ensure the running `node` binary is used.
|
|
||||||
result.push(path.resolve(cwdString, execPath, '..'));
|
|
||||||
|
|
||||||
return [...result, path_].join(path.delimiter);
|
|
||||||
}
|
|
||||||
|
|
||||||
export function npmRunPathEnv({env = process.env, ...options} = {}) {
|
|
||||||
env = {...env};
|
|
||||||
|
|
||||||
const path = pathKey({env});
|
|
||||||
options.path = env[path];
|
|
||||||
env[path] = npmRunPath(options);
|
|
||||||
|
|
||||||
return env;
|
|
||||||
}
|
|
@ -1,9 +0,0 @@
|
|||||||
MIT License
|
|
||||||
|
|
||||||
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
31
tests/wcag-compliance/node_modules/npm-run-path/node_modules/path-key/index.d.ts
generated
vendored
31
tests/wcag-compliance/node_modules/npm-run-path/node_modules/path-key/index.d.ts
generated
vendored
@ -1,31 +0,0 @@
|
|||||||
export interface Options {
|
|
||||||
/**
|
|
||||||
Use a custom environment variables object.
|
|
||||||
|
|
||||||
Default: [`process.env`](https://nodejs.org/api/process.html#process_process_env).
|
|
||||||
*/
|
|
||||||
readonly env?: Record<string, string | undefined>;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Get the PATH key for a specific platform.
|
|
||||||
|
|
||||||
Default: [`process.platform`](https://nodejs.org/api/process.html#process_process_platform).
|
|
||||||
*/
|
|
||||||
readonly platform?: NodeJS.Platform;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
Get the [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) environment variable key cross-platform.
|
|
||||||
|
|
||||||
@example
|
|
||||||
```
|
|
||||||
import pathKey from 'path-key';
|
|
||||||
|
|
||||||
const key = pathKey();
|
|
||||||
//=> 'PATH'
|
|
||||||
|
|
||||||
const PATH = process.env[key];
|
|
||||||
//=> '/usr/local/bin:/usr/bin:/bin'
|
|
||||||
```
|
|
||||||
*/
|
|
||||||
export default function pathKey(options?: Options): string;
|
|
12
tests/wcag-compliance/node_modules/npm-run-path/node_modules/path-key/index.js
generated
vendored
12
tests/wcag-compliance/node_modules/npm-run-path/node_modules/path-key/index.js
generated
vendored
@ -1,12 +0,0 @@
|
|||||||
export default function pathKey(options = {}) {
|
|
||||||
const {
|
|
||||||
env = process.env,
|
|
||||||
platform = process.platform
|
|
||||||
} = options;
|
|
||||||
|
|
||||||
if (platform !== 'win32') {
|
|
||||||
return 'PATH';
|
|
||||||
}
|
|
||||||
|
|
||||||
return Object.keys(env).reverse().find(key => key.toUpperCase() === 'PATH') || 'Path';
|
|
||||||
}
|
|
@ -1,9 +0,0 @@
|
|||||||
MIT License
|
|
||||||
|
|
||||||
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
41
tests/wcag-compliance/node_modules/npm-run-path/node_modules/path-key/package.json
generated
vendored
41
tests/wcag-compliance/node_modules/npm-run-path/node_modules/path-key/package.json
generated
vendored
@ -1,41 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "path-key",
|
|
||||||
"version": "4.0.0",
|
|
||||||
"description": "Get the PATH environment variable key cross-platform",
|
|
||||||
"license": "MIT",
|
|
||||||
"repository": "sindresorhus/path-key",
|
|
||||||
"funding": "https://github.com/sponsors/sindresorhus",
|
|
||||||
"author": {
|
|
||||||
"name": "Sindre Sorhus",
|
|
||||||
"email": "sindresorhus@gmail.com",
|
|
||||||
"url": "https://sindresorhus.com"
|
|
||||||
},
|
|
||||||
"type": "module",
|
|
||||||
"exports": "./index.js",
|
|
||||||
"engines": {
|
|
||||||
"node": ">=12"
|
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"test": "xo && ava && tsd"
|
|
||||||
},
|
|
||||||
"files": [
|
|
||||||
"index.js",
|
|
||||||
"index.d.ts"
|
|
||||||
],
|
|
||||||
"keywords": [
|
|
||||||
"path",
|
|
||||||
"key",
|
|
||||||
"environment",
|
|
||||||
"env",
|
|
||||||
"variable",
|
|
||||||
"get",
|
|
||||||
"cross-platform",
|
|
||||||
"windows"
|
|
||||||
],
|
|
||||||
"devDependencies": {
|
|
||||||
"@types/node": "^14.14.37",
|
|
||||||
"ava": "^3.15.0",
|
|
||||||
"tsd": "^0.14.0",
|
|
||||||
"xo": "^0.38.2"
|
|
||||||
}
|
|
||||||
}
|
|
57
tests/wcag-compliance/node_modules/npm-run-path/node_modules/path-key/readme.md
generated
vendored
57
tests/wcag-compliance/node_modules/npm-run-path/node_modules/path-key/readme.md
generated
vendored
@ -1,57 +0,0 @@
|
|||||||
# path-key
|
|
||||||
|
|
||||||
> Get the [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) environment variable key cross-platform
|
|
||||||
|
|
||||||
It's usually `PATH` but on Windows it can be any casing like `Path`...
|
|
||||||
|
|
||||||
## Install
|
|
||||||
|
|
||||||
```
|
|
||||||
$ npm install path-key
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```js
|
|
||||||
import pathKey from 'path-key';
|
|
||||||
|
|
||||||
const key = pathKey();
|
|
||||||
//=> 'PATH'
|
|
||||||
|
|
||||||
const PATH = process.env[key];
|
|
||||||
//=> '/usr/local/bin:/usr/bin:/bin'
|
|
||||||
```
|
|
||||||
|
|
||||||
## API
|
|
||||||
|
|
||||||
### pathKey(options?)
|
|
||||||
|
|
||||||
#### options
|
|
||||||
|
|
||||||
Type: `object`
|
|
||||||
|
|
||||||
##### env
|
|
||||||
|
|
||||||
Type: `object`\
|
|
||||||
Default: [`process.env`](https://nodejs.org/api/process.html#process_process_env)
|
|
||||||
|
|
||||||
Use a custom environment variables object.
|
|
||||||
|
|
||||||
#### platform
|
|
||||||
|
|
||||||
Type: `string`\
|
|
||||||
Default: [`process.platform`](https://nodejs.org/api/process.html#process_process_platform)
|
|
||||||
|
|
||||||
Get the PATH key for a specific platform.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
<div align="center">
|
|
||||||
<b>
|
|
||||||
<a href="https://tidelift.com/subscription/pkg/npm-path-key?utm_source=npm-path-key&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
|
|
||||||
</b>
|
|
||||||
<br>
|
|
||||||
<sub>
|
|
||||||
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
|
|
||||||
</sub>
|
|
||||||
</div>
|
|
@ -1,47 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "npm-run-path",
|
|
||||||
"version": "5.1.0",
|
|
||||||
"description": "Get your PATH prepended with locally installed binaries",
|
|
||||||
"license": "MIT",
|
|
||||||
"repository": "sindresorhus/npm-run-path",
|
|
||||||
"funding": "https://github.com/sponsors/sindresorhus",
|
|
||||||
"author": {
|
|
||||||
"name": "Sindre Sorhus",
|
|
||||||
"email": "sindresorhus@gmail.com",
|
|
||||||
"url": "https://sindresorhus.com"
|
|
||||||
},
|
|
||||||
"type": "module",
|
|
||||||
"exports": "./index.js",
|
|
||||||
"engines": {
|
|
||||||
"node": "^12.20.0 || ^14.13.1 || >=16.0.0"
|
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"test": "xo && ava && tsd"
|
|
||||||
},
|
|
||||||
"files": [
|
|
||||||
"index.js",
|
|
||||||
"index.d.ts"
|
|
||||||
],
|
|
||||||
"keywords": [
|
|
||||||
"npm",
|
|
||||||
"run",
|
|
||||||
"path",
|
|
||||||
"package",
|
|
||||||
"bin",
|
|
||||||
"binary",
|
|
||||||
"binaries",
|
|
||||||
"script",
|
|
||||||
"cli",
|
|
||||||
"command-line",
|
|
||||||
"execute",
|
|
||||||
"executable"
|
|
||||||
],
|
|
||||||
"dependencies": {
|
|
||||||
"path-key": "^4.0.0"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"ava": "^3.15.0",
|
|
||||||
"tsd": "^0.17.0",
|
|
||||||
"xo": "^0.45.0"
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,111 +0,0 @@
|
|||||||
# npm-run-path
|
|
||||||
|
|
||||||
> Get your [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) prepended with locally installed binaries
|
|
||||||
|
|
||||||
In [npm run scripts](https://docs.npmjs.com/cli/run-script) you can execute locally installed binaries by name. This enables the same outside npm.
|
|
||||||
|
|
||||||
## Install
|
|
||||||
|
|
||||||
```sh
|
|
||||||
npm install npm-run-path
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```js
|
|
||||||
import childProcess from 'node:child_process';
|
|
||||||
import {npmRunPath, npmRunPathEnv} from 'npm-run-path';
|
|
||||||
|
|
||||||
console.log(process.env.PATH);
|
|
||||||
//=> '/usr/local/bin'
|
|
||||||
|
|
||||||
console.log(npmRunPath());
|
|
||||||
//=> '/Users/sindresorhus/dev/foo/node_modules/.bin:/Users/sindresorhus/dev/node_modules/.bin:/Users/sindresorhus/node_modules/.bin:/Users/node_modules/.bin:/node_modules/.bin:/usr/local/bin'
|
|
||||||
|
|
||||||
// `foo` is a locally installed binary
|
|
||||||
childProcess.execFileSync('foo', {
|
|
||||||
env: npmRunPathEnv()
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
## API
|
|
||||||
|
|
||||||
### npmRunPath(options?)
|
|
||||||
|
|
||||||
Returns the augmented PATH string.
|
|
||||||
|
|
||||||
#### options
|
|
||||||
|
|
||||||
Type: `object`
|
|
||||||
|
|
||||||
##### cwd
|
|
||||||
|
|
||||||
Type: `string | URL`\
|
|
||||||
Default: `process.cwd()`
|
|
||||||
|
|
||||||
The working directory.
|
|
||||||
|
|
||||||
##### path
|
|
||||||
|
|
||||||
Type: `string`\
|
|
||||||
Default: [`PATH`](https://github.com/sindresorhus/path-key)
|
|
||||||
|
|
||||||
The PATH to be appended.
|
|
||||||
|
|
||||||
Set it to an empty string to exclude the default PATH.
|
|
||||||
|
|
||||||
##### execPath
|
|
||||||
|
|
||||||
Type: `string`\
|
|
||||||
Default: `process.execPath`
|
|
||||||
|
|
||||||
The path to the current Node.js executable. Its directory is pushed to the front of PATH.
|
|
||||||
|
|
||||||
This can be either an absolute path or a path relative to the [`cwd` option](#cwd).
|
|
||||||
|
|
||||||
### npmRunPathEnv(options?)
|
|
||||||
|
|
||||||
Returns the augmented [`process.env`](https://nodejs.org/api/process.html#process_process_env) object.
|
|
||||||
|
|
||||||
#### options
|
|
||||||
|
|
||||||
Type: `object`
|
|
||||||
|
|
||||||
##### cwd
|
|
||||||
|
|
||||||
Type: `string | URL`\
|
|
||||||
Default: `process.cwd()`
|
|
||||||
|
|
||||||
The working directory.
|
|
||||||
|
|
||||||
##### env
|
|
||||||
|
|
||||||
Type: `object`
|
|
||||||
|
|
||||||
Accepts an object of environment variables, like `process.env`, and modifies the PATH using the correct [PATH key](https://github.com/sindresorhus/path-key). Use this if you're modifying the PATH for use in the `child_process` options.
|
|
||||||
|
|
||||||
##### execPath
|
|
||||||
|
|
||||||
Type: `string`\
|
|
||||||
Default: `process.execPath`
|
|
||||||
|
|
||||||
The path to the Node.js executable to use in child processes if that is different from the current one. Its directory is pushed to the front of PATH.
|
|
||||||
|
|
||||||
This can be either an absolute path or a path relative to the [`cwd` option](#cwd).
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [npm-run-path-cli](https://github.com/sindresorhus/npm-run-path-cli) - CLI for this module
|
|
||||||
- [execa](https://github.com/sindresorhus/execa) - Execute a locally installed binary
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
<div align="center">
|
|
||||||
<b>
|
|
||||||
<a href="https://tidelift.com/subscription/pkg/npm-npm-run-path?utm_source=npm-npm-run-path&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
|
|
||||||
</b>
|
|
||||||
<br>
|
|
||||||
<sub>
|
|
||||||
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
|
|
||||||
</sub>
|
|
||||||
</div>
|
|
@ -1,59 +0,0 @@
|
|||||||
export interface Options {
|
|
||||||
/**
|
|
||||||
Throw an error when called more than once.
|
|
||||||
|
|
||||||
@default false
|
|
||||||
*/
|
|
||||||
readonly throw?: boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
declare const onetime: {
|
|
||||||
/**
|
|
||||||
Ensure a function is only called once. When called multiple times it will return the return value from the first call.
|
|
||||||
|
|
||||||
@param fn - Function that should only be called once.
|
|
||||||
@returns A function that only calls `fn` once.
|
|
||||||
|
|
||||||
@example
|
|
||||||
```
|
|
||||||
import onetime from 'onetime';
|
|
||||||
|
|
||||||
let index = 0;
|
|
||||||
|
|
||||||
const foo = onetime(() => ++index);
|
|
||||||
|
|
||||||
foo(); //=> 1
|
|
||||||
foo(); //=> 1
|
|
||||||
foo(); //=> 1
|
|
||||||
|
|
||||||
onetime.callCount(foo); //=> 3
|
|
||||||
```
|
|
||||||
*/
|
|
||||||
<ArgumentsType extends unknown[], ReturnType>(
|
|
||||||
fn: (...arguments: ArgumentsType) => ReturnType,
|
|
||||||
options?: Options
|
|
||||||
): (...arguments: ArgumentsType) => ReturnType;
|
|
||||||
|
|
||||||
/**
|
|
||||||
Get the number of times `fn` has been called.
|
|
||||||
|
|
||||||
@param fn - Function to get call count from.
|
|
||||||
@returns A number representing how many times `fn` has been called.
|
|
||||||
|
|
||||||
@example
|
|
||||||
```
|
|
||||||
import onetime from 'onetime';
|
|
||||||
|
|
||||||
const foo = onetime(() => {});
|
|
||||||
foo();
|
|
||||||
foo();
|
|
||||||
foo();
|
|
||||||
|
|
||||||
console.log(onetime.callCount(foo));
|
|
||||||
//=> 3
|
|
||||||
```
|
|
||||||
*/
|
|
||||||
callCount(fn: (...arguments: any[]) => unknown): number;
|
|
||||||
};
|
|
||||||
|
|
||||||
export default onetime;
|
|
@ -1,41 +0,0 @@
|
|||||||
import mimicFunction from 'mimic-fn';
|
|
||||||
|
|
||||||
const calledFunctions = new WeakMap();
|
|
||||||
|
|
||||||
const onetime = (function_, options = {}) => {
|
|
||||||
if (typeof function_ !== 'function') {
|
|
||||||
throw new TypeError('Expected a function');
|
|
||||||
}
|
|
||||||
|
|
||||||
let returnValue;
|
|
||||||
let callCount = 0;
|
|
||||||
const functionName = function_.displayName || function_.name || '<anonymous>';
|
|
||||||
|
|
||||||
const onetime = function (...arguments_) {
|
|
||||||
calledFunctions.set(onetime, ++callCount);
|
|
||||||
|
|
||||||
if (callCount === 1) {
|
|
||||||
returnValue = function_.apply(this, arguments_);
|
|
||||||
function_ = null;
|
|
||||||
} else if (options.throw === true) {
|
|
||||||
throw new Error(`Function \`${functionName}\` can only be called once`);
|
|
||||||
}
|
|
||||||
|
|
||||||
return returnValue;
|
|
||||||
};
|
|
||||||
|
|
||||||
mimicFunction(onetime, function_);
|
|
||||||
calledFunctions.set(onetime, callCount);
|
|
||||||
|
|
||||||
return onetime;
|
|
||||||
};
|
|
||||||
|
|
||||||
onetime.callCount = function_ => {
|
|
||||||
if (!calledFunctions.has(function_)) {
|
|
||||||
throw new Error(`The given function \`${function_.name}\` is not wrapped by the \`onetime\` package`);
|
|
||||||
}
|
|
||||||
|
|
||||||
return calledFunctions.get(function_);
|
|
||||||
};
|
|
||||||
|
|
||||||
export default onetime;
|
|
@ -1,9 +0,0 @@
|
|||||||
MIT License
|
|
||||||
|
|
||||||
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
@ -1,45 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "onetime",
|
|
||||||
"version": "6.0.0",
|
|
||||||
"description": "Ensure a function is only called once",
|
|
||||||
"license": "MIT",
|
|
||||||
"repository": "sindresorhus/onetime",
|
|
||||||
"funding": "https://github.com/sponsors/sindresorhus",
|
|
||||||
"author": {
|
|
||||||
"name": "Sindre Sorhus",
|
|
||||||
"email": "sindresorhus@gmail.com",
|
|
||||||
"url": "https://sindresorhus.com"
|
|
||||||
},
|
|
||||||
"type": "module",
|
|
||||||
"exports": "./index.js",
|
|
||||||
"engines": {
|
|
||||||
"node": ">=12"
|
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"test": "xo && ava && tsd"
|
|
||||||
},
|
|
||||||
"files": [
|
|
||||||
"index.js",
|
|
||||||
"index.d.ts"
|
|
||||||
],
|
|
||||||
"keywords": [
|
|
||||||
"once",
|
|
||||||
"function",
|
|
||||||
"one",
|
|
||||||
"onetime",
|
|
||||||
"func",
|
|
||||||
"fn",
|
|
||||||
"single",
|
|
||||||
"call",
|
|
||||||
"called",
|
|
||||||
"prevent"
|
|
||||||
],
|
|
||||||
"dependencies": {
|
|
||||||
"mimic-fn": "^4.0.0"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"ava": "^3.15.0",
|
|
||||||
"tsd": "^0.14.0",
|
|
||||||
"xo": "^0.38.2"
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,94 +0,0 @@
|
|||||||
# onetime
|
|
||||||
|
|
||||||
> Ensure a function is only called once
|
|
||||||
|
|
||||||
When called multiple times it will return the return value from the first call.
|
|
||||||
|
|
||||||
*Unlike the module [once](https://github.com/isaacs/once), this one isn't naughty and extending `Function.prototype`.*
|
|
||||||
|
|
||||||
## Install
|
|
||||||
|
|
||||||
```
|
|
||||||
$ npm install onetime
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```js
|
|
||||||
import onetime from 'onetime';
|
|
||||||
|
|
||||||
let index = 0;
|
|
||||||
|
|
||||||
const foo = onetime(() => ++index);
|
|
||||||
|
|
||||||
foo(); //=> 1
|
|
||||||
foo(); //=> 1
|
|
||||||
foo(); //=> 1
|
|
||||||
|
|
||||||
onetime.callCount(foo); //=> 3
|
|
||||||
```
|
|
||||||
|
|
||||||
```js
|
|
||||||
import onetime from 'onetime';
|
|
||||||
|
|
||||||
const foo = onetime(() => {}, {throw: true});
|
|
||||||
|
|
||||||
foo();
|
|
||||||
|
|
||||||
foo();
|
|
||||||
//=> Error: Function `foo` can only be called once
|
|
||||||
```
|
|
||||||
|
|
||||||
## API
|
|
||||||
|
|
||||||
### onetime(fn, options?)
|
|
||||||
|
|
||||||
Returns a function that only calls `fn` once.
|
|
||||||
|
|
||||||
#### fn
|
|
||||||
|
|
||||||
Type: `Function`
|
|
||||||
|
|
||||||
Function that should only be called once.
|
|
||||||
|
|
||||||
#### options
|
|
||||||
|
|
||||||
Type: `object`
|
|
||||||
|
|
||||||
##### throw
|
|
||||||
|
|
||||||
Type: `boolean`\
|
|
||||||
Default: `false`
|
|
||||||
|
|
||||||
Throw an error when called more than once.
|
|
||||||
|
|
||||||
### onetime.callCount(fn)
|
|
||||||
|
|
||||||
Returns a number representing how many times `fn` has been called.
|
|
||||||
|
|
||||||
Note: It throws an error if you pass in a function that is not wrapped by `onetime`.
|
|
||||||
|
|
||||||
```js
|
|
||||||
import onetime from 'onetime';
|
|
||||||
|
|
||||||
const foo = onetime(() => {});
|
|
||||||
|
|
||||||
foo();
|
|
||||||
foo();
|
|
||||||
foo();
|
|
||||||
|
|
||||||
console.log(onetime.callCount(foo));
|
|
||||||
//=> 3
|
|
||||||
```
|
|
||||||
|
|
||||||
#### fn
|
|
||||||
|
|
||||||
Type: `Function`
|
|
||||||
|
|
||||||
Function to get call count from.
|
|
||||||
|
|
||||||
## onetime for enterprise
|
|
||||||
|
|
||||||
Available as part of the Tidelift Subscription.
|
|
||||||
|
|
||||||
The maintainers of onetime and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-onetime?utm_source=npm-onetime&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)
|
|
@ -1,40 +0,0 @@
|
|||||||
/// <reference types="node" />
|
|
||||||
|
|
||||||
declare namespace pathKey {
|
|
||||||
interface Options {
|
|
||||||
/**
|
|
||||||
Use a custom environment variables object. Default: [`process.env`](https://nodejs.org/api/process.html#process_process_env).
|
|
||||||
*/
|
|
||||||
readonly env?: {[key: string]: string | undefined};
|
|
||||||
|
|
||||||
/**
|
|
||||||
Get the PATH key for a specific platform. Default: [`process.platform`](https://nodejs.org/api/process.html#process_process_platform).
|
|
||||||
*/
|
|
||||||
readonly platform?: NodeJS.Platform;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
declare const pathKey: {
|
|
||||||
/**
|
|
||||||
Get the [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) environment variable key cross-platform.
|
|
||||||
|
|
||||||
@example
|
|
||||||
```
|
|
||||||
import pathKey = require('path-key');
|
|
||||||
|
|
||||||
const key = pathKey();
|
|
||||||
//=> 'PATH'
|
|
||||||
|
|
||||||
const PATH = process.env[key];
|
|
||||||
//=> '/usr/local/bin:/usr/bin:/bin'
|
|
||||||
```
|
|
||||||
*/
|
|
||||||
(options?: pathKey.Options): string;
|
|
||||||
|
|
||||||
// TODO: Remove this for the next major release, refactor the whole definition to:
|
|
||||||
// declare function pathKey(options?: pathKey.Options): string;
|
|
||||||
// export = pathKey;
|
|
||||||
default: typeof pathKey;
|
|
||||||
};
|
|
||||||
|
|
||||||
export = pathKey;
|
|
@ -1,16 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
const pathKey = (options = {}) => {
|
|
||||||
const environment = options.env || process.env;
|
|
||||||
const platform = options.platform || process.platform;
|
|
||||||
|
|
||||||
if (platform !== 'win32') {
|
|
||||||
return 'PATH';
|
|
||||||
}
|
|
||||||
|
|
||||||
return Object.keys(environment).reverse().find(key => key.toUpperCase() === 'PATH') || 'Path';
|
|
||||||
};
|
|
||||||
|
|
||||||
module.exports = pathKey;
|
|
||||||
// TODO: Remove this for the next major release
|
|
||||||
module.exports.default = pathKey;
|
|
@ -1,9 +0,0 @@
|
|||||||
MIT License
|
|
||||||
|
|
||||||
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
@ -1,39 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "path-key",
|
|
||||||
"version": "3.1.1",
|
|
||||||
"description": "Get the PATH environment variable key cross-platform",
|
|
||||||
"license": "MIT",
|
|
||||||
"repository": "sindresorhus/path-key",
|
|
||||||
"author": {
|
|
||||||
"name": "Sindre Sorhus",
|
|
||||||
"email": "sindresorhus@gmail.com",
|
|
||||||
"url": "sindresorhus.com"
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": ">=8"
|
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"test": "xo && ava && tsd"
|
|
||||||
},
|
|
||||||
"files": [
|
|
||||||
"index.js",
|
|
||||||
"index.d.ts"
|
|
||||||
],
|
|
||||||
"keywords": [
|
|
||||||
"path",
|
|
||||||
"key",
|
|
||||||
"environment",
|
|
||||||
"env",
|
|
||||||
"variable",
|
|
||||||
"var",
|
|
||||||
"get",
|
|
||||||
"cross-platform",
|
|
||||||
"windows"
|
|
||||||
],
|
|
||||||
"devDependencies": {
|
|
||||||
"@types/node": "^11.13.0",
|
|
||||||
"ava": "^1.4.1",
|
|
||||||
"tsd": "^0.7.2",
|
|
||||||
"xo": "^0.24.0"
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,61 +0,0 @@
|
|||||||
# path-key [![Build Status](https://travis-ci.org/sindresorhus/path-key.svg?branch=master)](https://travis-ci.org/sindresorhus/path-key)
|
|
||||||
|
|
||||||
> Get the [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) environment variable key cross-platform
|
|
||||||
|
|
||||||
It's usually `PATH`, but on Windows it can be any casing like `Path`...
|
|
||||||
|
|
||||||
|
|
||||||
## Install
|
|
||||||
|
|
||||||
```
|
|
||||||
$ npm install path-key
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```js
|
|
||||||
const pathKey = require('path-key');
|
|
||||||
|
|
||||||
const key = pathKey();
|
|
||||||
//=> 'PATH'
|
|
||||||
|
|
||||||
const PATH = process.env[key];
|
|
||||||
//=> '/usr/local/bin:/usr/bin:/bin'
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## API
|
|
||||||
|
|
||||||
### pathKey(options?)
|
|
||||||
|
|
||||||
#### options
|
|
||||||
|
|
||||||
Type: `object`
|
|
||||||
|
|
||||||
##### env
|
|
||||||
|
|
||||||
Type: `object`<br>
|
|
||||||
Default: [`process.env`](https://nodejs.org/api/process.html#process_process_env)
|
|
||||||
|
|
||||||
Use a custom environment variables object.
|
|
||||||
|
|
||||||
#### platform
|
|
||||||
|
|
||||||
Type: `string`<br>
|
|
||||||
Default: [`process.platform`](https://nodejs.org/api/process.html#process_process_platform)
|
|
||||||
|
|
||||||
Get the PATH key for a specific platform.
|
|
||||||
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
<div align="center">
|
|
||||||
<b>
|
|
||||||
<a href="https://tidelift.com/subscription/pkg/npm-path-key?utm_source=npm-path-key&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
|
|
||||||
</b>
|
|
||||||
<br>
|
|
||||||
<sub>
|
|
||||||
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
|
|
||||||
</sub>
|
|
||||||
</div>
|
|
@ -1,19 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
const shebangRegex = require('shebang-regex');
|
|
||||||
|
|
||||||
module.exports = (string = '') => {
|
|
||||||
const match = string.match(shebangRegex);
|
|
||||||
|
|
||||||
if (!match) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
const [path, argument] = match[0].replace(/#! ?/, '').split(' ');
|
|
||||||
const binary = path.split('/').pop();
|
|
||||||
|
|
||||||
if (binary === 'env') {
|
|
||||||
return argument;
|
|
||||||
}
|
|
||||||
|
|
||||||
return argument ? `${binary} ${argument}` : binary;
|
|
||||||
};
|
|
@ -1,9 +0,0 @@
|
|||||||
MIT License
|
|
||||||
|
|
||||||
Copyright (c) Kevin Mårtensson <kevinmartensson@gmail.com> (github.com/kevva)
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
@ -1,34 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "shebang-command",
|
|
||||||
"version": "2.0.0",
|
|
||||||
"description": "Get the command from a shebang",
|
|
||||||
"license": "MIT",
|
|
||||||
"repository": "kevva/shebang-command",
|
|
||||||
"author": {
|
|
||||||
"name": "Kevin Mårtensson",
|
|
||||||
"email": "kevinmartensson@gmail.com",
|
|
||||||
"url": "github.com/kevva"
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": ">=8"
|
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"test": "xo && ava"
|
|
||||||
},
|
|
||||||
"files": [
|
|
||||||
"index.js"
|
|
||||||
],
|
|
||||||
"keywords": [
|
|
||||||
"cmd",
|
|
||||||
"command",
|
|
||||||
"parse",
|
|
||||||
"shebang"
|
|
||||||
],
|
|
||||||
"dependencies": {
|
|
||||||
"shebang-regex": "^3.0.0"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"ava": "^2.3.0",
|
|
||||||
"xo": "^0.24.0"
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,34 +0,0 @@
|
|||||||
# shebang-command [![Build Status](https://travis-ci.org/kevva/shebang-command.svg?branch=master)](https://travis-ci.org/kevva/shebang-command)
|
|
||||||
|
|
||||||
> Get the command from a shebang
|
|
||||||
|
|
||||||
|
|
||||||
## Install
|
|
||||||
|
|
||||||
```
|
|
||||||
$ npm install shebang-command
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```js
|
|
||||||
const shebangCommand = require('shebang-command');
|
|
||||||
|
|
||||||
shebangCommand('#!/usr/bin/env node');
|
|
||||||
//=> 'node'
|
|
||||||
|
|
||||||
shebangCommand('#!/bin/bash');
|
|
||||||
//=> 'bash'
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## API
|
|
||||||
|
|
||||||
### shebangCommand(string)
|
|
||||||
|
|
||||||
#### string
|
|
||||||
|
|
||||||
Type: `string`
|
|
||||||
|
|
||||||
String containing a shebang.
|
|
@ -1,22 +0,0 @@
|
|||||||
/**
|
|
||||||
Regular expression for matching a [shebang](https://en.wikipedia.org/wiki/Shebang_(Unix)) line.
|
|
||||||
|
|
||||||
@example
|
|
||||||
```
|
|
||||||
import shebangRegex = require('shebang-regex');
|
|
||||||
|
|
||||||
const string = '#!/usr/bin/env node\nconsole.log("unicorns");';
|
|
||||||
|
|
||||||
shebangRegex.test(string);
|
|
||||||
//=> true
|
|
||||||
|
|
||||||
shebangRegex.exec(string)[0];
|
|
||||||
//=> '#!/usr/bin/env node'
|
|
||||||
|
|
||||||
shebangRegex.exec(string)[1];
|
|
||||||
//=> '/usr/bin/env node'
|
|
||||||
```
|
|
||||||
*/
|
|
||||||
declare const shebangRegex: RegExp;
|
|
||||||
|
|
||||||
export = shebangRegex;
|
|
@ -1,2 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
module.exports = /^#!(.*)/;
|
|
@ -1,9 +0,0 @@
|
|||||||
MIT License
|
|
||||||
|
|
||||||
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
@ -1,35 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "shebang-regex",
|
|
||||||
"version": "3.0.0",
|
|
||||||
"description": "Regular expression for matching a shebang line",
|
|
||||||
"license": "MIT",
|
|
||||||
"repository": "sindresorhus/shebang-regex",
|
|
||||||
"author": {
|
|
||||||
"name": "Sindre Sorhus",
|
|
||||||
"email": "sindresorhus@gmail.com",
|
|
||||||
"url": "sindresorhus.com"
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": ">=8"
|
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"test": "xo && ava && tsd"
|
|
||||||
},
|
|
||||||
"files": [
|
|
||||||
"index.js",
|
|
||||||
"index.d.ts"
|
|
||||||
],
|
|
||||||
"keywords": [
|
|
||||||
"regex",
|
|
||||||
"regexp",
|
|
||||||
"shebang",
|
|
||||||
"match",
|
|
||||||
"test",
|
|
||||||
"line"
|
|
||||||
],
|
|
||||||
"devDependencies": {
|
|
||||||
"ava": "^1.4.1",
|
|
||||||
"tsd": "^0.7.2",
|
|
||||||
"xo": "^0.24.0"
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,33 +0,0 @@
|
|||||||
# shebang-regex [![Build Status](https://travis-ci.org/sindresorhus/shebang-regex.svg?branch=master)](https://travis-ci.org/sindresorhus/shebang-regex)
|
|
||||||
|
|
||||||
> Regular expression for matching a [shebang](https://en.wikipedia.org/wiki/Shebang_(Unix)) line
|
|
||||||
|
|
||||||
|
|
||||||
## Install
|
|
||||||
|
|
||||||
```
|
|
||||||
$ npm install shebang-regex
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```js
|
|
||||||
const shebangRegex = require('shebang-regex');
|
|
||||||
|
|
||||||
const string = '#!/usr/bin/env node\nconsole.log("unicorns");';
|
|
||||||
|
|
||||||
shebangRegex.test(string);
|
|
||||||
//=> true
|
|
||||||
|
|
||||||
shebangRegex.exec(string)[0];
|
|
||||||
//=> '#!/usr/bin/env node'
|
|
||||||
|
|
||||||
shebangRegex.exec(string)[1];
|
|
||||||
//=> '/usr/bin/env node'
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
MIT © [Sindre Sorhus](https://sindresorhus.com)
|
|
@ -1,16 +0,0 @@
|
|||||||
The ISC License
|
|
||||||
|
|
||||||
Copyright (c) 2015, Contributors
|
|
||||||
|
|
||||||
Permission to use, copy, modify, and/or distribute this software
|
|
||||||
for any purpose with or without fee is hereby granted, provided
|
|
||||||
that the above copyright notice and this permission notice
|
|
||||||
appear in all copies.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
||||||
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
|
|
||||||
OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE
|
|
||||||
LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES
|
|
||||||
OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
|
|
||||||
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
|
|
||||||
ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
@ -1,39 +0,0 @@
|
|||||||
# signal-exit
|
|
||||||
|
|
||||||
[![Build Status](https://travis-ci.org/tapjs/signal-exit.png)](https://travis-ci.org/tapjs/signal-exit)
|
|
||||||
[![Coverage](https://coveralls.io/repos/tapjs/signal-exit/badge.svg?branch=master)](https://coveralls.io/r/tapjs/signal-exit?branch=master)
|
|
||||||
[![NPM version](https://img.shields.io/npm/v/signal-exit.svg)](https://www.npmjs.com/package/signal-exit)
|
|
||||||
[![Standard Version](https://img.shields.io/badge/release-standard%20version-brightgreen.svg)](https://github.com/conventional-changelog/standard-version)
|
|
||||||
|
|
||||||
When you want to fire an event no matter how a process exits:
|
|
||||||
|
|
||||||
* reaching the end of execution.
|
|
||||||
* explicitly having `process.exit(code)` called.
|
|
||||||
* having `process.kill(pid, sig)` called.
|
|
||||||
* receiving a fatal signal from outside the process
|
|
||||||
|
|
||||||
Use `signal-exit`.
|
|
||||||
|
|
||||||
```js
|
|
||||||
var onExit = require('signal-exit')
|
|
||||||
|
|
||||||
onExit(function (code, signal) {
|
|
||||||
console.log('process exited!')
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
## API
|
|
||||||
|
|
||||||
`var remove = onExit(function (code, signal) {}, options)`
|
|
||||||
|
|
||||||
The return value of the function is a function that will remove the
|
|
||||||
handler.
|
|
||||||
|
|
||||||
Note that the function *only* fires for signals if the signal would
|
|
||||||
cause the process to exit. That is, there are no other listeners, and
|
|
||||||
it is a fatal signal.
|
|
||||||
|
|
||||||
## Options
|
|
||||||
|
|
||||||
* `alwaysLast`: Run this handler after any other signal or exit
|
|
||||||
handlers. This causes `process.emit` to be monkeypatched.
|
|
@ -1,202 +0,0 @@
|
|||||||
// Note: since nyc uses this module to output coverage, any lines
|
|
||||||
// that are in the direct sync flow of nyc's outputCoverage are
|
|
||||||
// ignored, since we can never get coverage for them.
|
|
||||||
// grab a reference to node's real process object right away
|
|
||||||
var process = global.process
|
|
||||||
|
|
||||||
const processOk = function (process) {
|
|
||||||
return process &&
|
|
||||||
typeof process === 'object' &&
|
|
||||||
typeof process.removeListener === 'function' &&
|
|
||||||
typeof process.emit === 'function' &&
|
|
||||||
typeof process.reallyExit === 'function' &&
|
|
||||||
typeof process.listeners === 'function' &&
|
|
||||||
typeof process.kill === 'function' &&
|
|
||||||
typeof process.pid === 'number' &&
|
|
||||||
typeof process.on === 'function'
|
|
||||||
}
|
|
||||||
|
|
||||||
// some kind of non-node environment, just no-op
|
|
||||||
/* istanbul ignore if */
|
|
||||||
if (!processOk(process)) {
|
|
||||||
module.exports = function () {
|
|
||||||
return function () {}
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
var assert = require('assert')
|
|
||||||
var signals = require('./signals.js')
|
|
||||||
var isWin = /^win/i.test(process.platform)
|
|
||||||
|
|
||||||
var EE = require('events')
|
|
||||||
/* istanbul ignore if */
|
|
||||||
if (typeof EE !== 'function') {
|
|
||||||
EE = EE.EventEmitter
|
|
||||||
}
|
|
||||||
|
|
||||||
var emitter
|
|
||||||
if (process.__signal_exit_emitter__) {
|
|
||||||
emitter = process.__signal_exit_emitter__
|
|
||||||
} else {
|
|
||||||
emitter = process.__signal_exit_emitter__ = new EE()
|
|
||||||
emitter.count = 0
|
|
||||||
emitter.emitted = {}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Because this emitter is a global, we have to check to see if a
|
|
||||||
// previous version of this library failed to enable infinite listeners.
|
|
||||||
// I know what you're about to say. But literally everything about
|
|
||||||
// signal-exit is a compromise with evil. Get used to it.
|
|
||||||
if (!emitter.infinite) {
|
|
||||||
emitter.setMaxListeners(Infinity)
|
|
||||||
emitter.infinite = true
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = function (cb, opts) {
|
|
||||||
/* istanbul ignore if */
|
|
||||||
if (!processOk(global.process)) {
|
|
||||||
return function () {}
|
|
||||||
}
|
|
||||||
assert.equal(typeof cb, 'function', 'a callback must be provided for exit handler')
|
|
||||||
|
|
||||||
if (loaded === false) {
|
|
||||||
load()
|
|
||||||
}
|
|
||||||
|
|
||||||
var ev = 'exit'
|
|
||||||
if (opts && opts.alwaysLast) {
|
|
||||||
ev = 'afterexit'
|
|
||||||
}
|
|
||||||
|
|
||||||
var remove = function () {
|
|
||||||
emitter.removeListener(ev, cb)
|
|
||||||
if (emitter.listeners('exit').length === 0 &&
|
|
||||||
emitter.listeners('afterexit').length === 0) {
|
|
||||||
unload()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
emitter.on(ev, cb)
|
|
||||||
|
|
||||||
return remove
|
|
||||||
}
|
|
||||||
|
|
||||||
var unload = function unload () {
|
|
||||||
if (!loaded || !processOk(global.process)) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
loaded = false
|
|
||||||
|
|
||||||
signals.forEach(function (sig) {
|
|
||||||
try {
|
|
||||||
process.removeListener(sig, sigListeners[sig])
|
|
||||||
} catch (er) {}
|
|
||||||
})
|
|
||||||
process.emit = originalProcessEmit
|
|
||||||
process.reallyExit = originalProcessReallyExit
|
|
||||||
emitter.count -= 1
|
|
||||||
}
|
|
||||||
module.exports.unload = unload
|
|
||||||
|
|
||||||
var emit = function emit (event, code, signal) {
|
|
||||||
/* istanbul ignore if */
|
|
||||||
if (emitter.emitted[event]) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
emitter.emitted[event] = true
|
|
||||||
emitter.emit(event, code, signal)
|
|
||||||
}
|
|
||||||
|
|
||||||
// { <signal>: <listener fn>, ... }
|
|
||||||
var sigListeners = {}
|
|
||||||
signals.forEach(function (sig) {
|
|
||||||
sigListeners[sig] = function listener () {
|
|
||||||
/* istanbul ignore if */
|
|
||||||
if (!processOk(global.process)) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
// If there are no other listeners, an exit is coming!
|
|
||||||
// Simplest way: remove us and then re-send the signal.
|
|
||||||
// We know that this will kill the process, so we can
|
|
||||||
// safely emit now.
|
|
||||||
var listeners = process.listeners(sig)
|
|
||||||
if (listeners.length === emitter.count) {
|
|
||||||
unload()
|
|
||||||
emit('exit', null, sig)
|
|
||||||
/* istanbul ignore next */
|
|
||||||
emit('afterexit', null, sig)
|
|
||||||
/* istanbul ignore next */
|
|
||||||
if (isWin && sig === 'SIGHUP') {
|
|
||||||
// "SIGHUP" throws an `ENOSYS` error on Windows,
|
|
||||||
// so use a supported signal instead
|
|
||||||
sig = 'SIGINT'
|
|
||||||
}
|
|
||||||
/* istanbul ignore next */
|
|
||||||
process.kill(process.pid, sig)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
module.exports.signals = function () {
|
|
||||||
return signals
|
|
||||||
}
|
|
||||||
|
|
||||||
var loaded = false
|
|
||||||
|
|
||||||
var load = function load () {
|
|
||||||
if (loaded || !processOk(global.process)) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
loaded = true
|
|
||||||
|
|
||||||
// This is the number of onSignalExit's that are in play.
|
|
||||||
// It's important so that we can count the correct number of
|
|
||||||
// listeners on signals, and don't wait for the other one to
|
|
||||||
// handle it instead of us.
|
|
||||||
emitter.count += 1
|
|
||||||
|
|
||||||
signals = signals.filter(function (sig) {
|
|
||||||
try {
|
|
||||||
process.on(sig, sigListeners[sig])
|
|
||||||
return true
|
|
||||||
} catch (er) {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
process.emit = processEmit
|
|
||||||
process.reallyExit = processReallyExit
|
|
||||||
}
|
|
||||||
module.exports.load = load
|
|
||||||
|
|
||||||
var originalProcessReallyExit = process.reallyExit
|
|
||||||
var processReallyExit = function processReallyExit (code) {
|
|
||||||
/* istanbul ignore if */
|
|
||||||
if (!processOk(global.process)) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
process.exitCode = code || /* istanbul ignore next */ 0
|
|
||||||
emit('exit', process.exitCode, null)
|
|
||||||
/* istanbul ignore next */
|
|
||||||
emit('afterexit', process.exitCode, null)
|
|
||||||
/* istanbul ignore next */
|
|
||||||
originalProcessReallyExit.call(process, process.exitCode)
|
|
||||||
}
|
|
||||||
|
|
||||||
var originalProcessEmit = process.emit
|
|
||||||
var processEmit = function processEmit (ev, arg) {
|
|
||||||
if (ev === 'exit' && processOk(global.process)) {
|
|
||||||
/* istanbul ignore else */
|
|
||||||
if (arg !== undefined) {
|
|
||||||
process.exitCode = arg
|
|
||||||
}
|
|
||||||
var ret = originalProcessEmit.apply(this, arguments)
|
|
||||||
/* istanbul ignore next */
|
|
||||||
emit('exit', process.exitCode, null)
|
|
||||||
/* istanbul ignore next */
|
|
||||||
emit('afterexit', process.exitCode, null)
|
|
||||||
/* istanbul ignore next */
|
|
||||||
return ret
|
|
||||||
} else {
|
|
||||||
return originalProcessEmit.apply(this, arguments)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,38 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "signal-exit",
|
|
||||||
"version": "3.0.7",
|
|
||||||
"description": "when you want to fire an event no matter how a process exits.",
|
|
||||||
"main": "index.js",
|
|
||||||
"scripts": {
|
|
||||||
"test": "tap",
|
|
||||||
"snap": "tap",
|
|
||||||
"preversion": "npm test",
|
|
||||||
"postversion": "npm publish",
|
|
||||||
"prepublishOnly": "git push origin --follow-tags"
|
|
||||||
},
|
|
||||||
"files": [
|
|
||||||
"index.js",
|
|
||||||
"signals.js"
|
|
||||||
],
|
|
||||||
"repository": {
|
|
||||||
"type": "git",
|
|
||||||
"url": "https://github.com/tapjs/signal-exit.git"
|
|
||||||
},
|
|
||||||
"keywords": [
|
|
||||||
"signal",
|
|
||||||
"exit"
|
|
||||||
],
|
|
||||||
"author": "Ben Coe <ben@npmjs.com>",
|
|
||||||
"license": "ISC",
|
|
||||||
"bugs": {
|
|
||||||
"url": "https://github.com/tapjs/signal-exit/issues"
|
|
||||||
},
|
|
||||||
"homepage": "https://github.com/tapjs/signal-exit",
|
|
||||||
"devDependencies": {
|
|
||||||
"chai": "^3.5.0",
|
|
||||||
"coveralls": "^3.1.1",
|
|
||||||
"nyc": "^15.1.0",
|
|
||||||
"standard-version": "^9.3.1",
|
|
||||||
"tap": "^15.1.1"
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,53 +0,0 @@
|
|||||||
// This is not the set of all possible signals.
|
|
||||||
//
|
|
||||||
// It IS, however, the set of all signals that trigger
|
|
||||||
// an exit on either Linux or BSD systems. Linux is a
|
|
||||||
// superset of the signal names supported on BSD, and
|
|
||||||
// the unknown signals just fail to register, so we can
|
|
||||||
// catch that easily enough.
|
|
||||||
//
|
|
||||||
// Don't bother with SIGKILL. It's uncatchable, which
|
|
||||||
// means that we can't fire any callbacks anyway.
|
|
||||||
//
|
|
||||||
// If a user does happen to register a handler on a non-
|
|
||||||
// fatal signal like SIGWINCH or something, and then
|
|
||||||
// exit, it'll end up firing `process.emit('exit')`, so
|
|
||||||
// the handler will be fired anyway.
|
|
||||||
//
|
|
||||||
// SIGBUS, SIGFPE, SIGSEGV and SIGILL, when not raised
|
|
||||||
// artificially, inherently leave the process in a
|
|
||||||
// state from which it is not safe to try and enter JS
|
|
||||||
// listeners.
|
|
||||||
module.exports = [
|
|
||||||
'SIGABRT',
|
|
||||||
'SIGALRM',
|
|
||||||
'SIGHUP',
|
|
||||||
'SIGINT',
|
|
||||||
'SIGTERM'
|
|
||||||
]
|
|
||||||
|
|
||||||
if (process.platform !== 'win32') {
|
|
||||||
module.exports.push(
|
|
||||||
'SIGVTALRM',
|
|
||||||
'SIGXCPU',
|
|
||||||
'SIGXFSZ',
|
|
||||||
'SIGUSR2',
|
|
||||||
'SIGTRAP',
|
|
||||||
'SIGSYS',
|
|
||||||
'SIGQUIT',
|
|
||||||
'SIGIOT'
|
|
||||||
// should detect profiler and enable/disable accordingly.
|
|
||||||
// see #21
|
|
||||||
// 'SIGPROF'
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
if (process.platform === 'linux') {
|
|
||||||
module.exports.push(
|
|
||||||
'SIGIO',
|
|
||||||
'SIGPOLL',
|
|
||||||
'SIGPWR',
|
|
||||||
'SIGSTKFLT',
|
|
||||||
'SIGUNUSED'
|
|
||||||
)
|
|
||||||
}
|
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue