Updated code bcryptjs
parent
39a2a96558
commit
2c7c371615
@ -1,16 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
|
||||||
|
|
||||||
case `uname` in
|
|
||||||
*CYGWIN*|*MINGW*|*MSYS*)
|
|
||||||
if command -v cygpath > /dev/null 2>&1; then
|
|
||||||
basedir=`cygpath -w "$basedir"`
|
|
||||||
fi
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
|
|
||||||
if [ -x "$basedir/node" ]; then
|
|
||||||
exec "$basedir/node" "$basedir/../color-support/bin.js" "$@"
|
|
||||||
else
|
|
||||||
exec node "$basedir/../color-support/bin.js" "$@"
|
|
||||||
fi
|
|
||||||
@ -1,17 +0,0 @@
|
|||||||
@ECHO off
|
|
||||||
GOTO start
|
|
||||||
:find_dp0
|
|
||||||
SET dp0=%~dp0
|
|
||||||
EXIT /b
|
|
||||||
:start
|
|
||||||
SETLOCAL
|
|
||||||
CALL :find_dp0
|
|
||||||
|
|
||||||
IF EXIST "%dp0%\node.exe" (
|
|
||||||
SET "_prog=%dp0%\node.exe"
|
|
||||||
) ELSE (
|
|
||||||
SET "_prog=node"
|
|
||||||
SET PATHEXT=%PATHEXT:;.JS;=;%
|
|
||||||
)
|
|
||||||
|
|
||||||
endLocal & goto #_undefined_# 2>NUL || title %COMSPEC% & "%_prog%" "%dp0%\..\color-support\bin.js" %*
|
|
||||||
@ -1,28 +0,0 @@
|
|||||||
#!/usr/bin/env pwsh
|
|
||||||
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
|
||||||
|
|
||||||
$exe=""
|
|
||||||
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
|
||||||
# Fix case when both the Windows and Linux builds of Node
|
|
||||||
# are installed in the same directory
|
|
||||||
$exe=".exe"
|
|
||||||
}
|
|
||||||
$ret=0
|
|
||||||
if (Test-Path "$basedir/node$exe") {
|
|
||||||
# Support pipeline input
|
|
||||||
if ($MyInvocation.ExpectingInput) {
|
|
||||||
$input | & "$basedir/node$exe" "$basedir/../color-support/bin.js" $args
|
|
||||||
} else {
|
|
||||||
& "$basedir/node$exe" "$basedir/../color-support/bin.js" $args
|
|
||||||
}
|
|
||||||
$ret=$LASTEXITCODE
|
|
||||||
} else {
|
|
||||||
# Support pipeline input
|
|
||||||
if ($MyInvocation.ExpectingInput) {
|
|
||||||
$input | & "node$exe" "$basedir/../color-support/bin.js" $args
|
|
||||||
} else {
|
|
||||||
& "node$exe" "$basedir/../color-support/bin.js" $args
|
|
||||||
}
|
|
||||||
$ret=$LASTEXITCODE
|
|
||||||
}
|
|
||||||
exit $ret
|
|
||||||
@ -1,16 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
|
||||||
|
|
||||||
case `uname` in
|
|
||||||
*CYGWIN*|*MINGW*|*MSYS*)
|
|
||||||
if command -v cygpath > /dev/null 2>&1; then
|
|
||||||
basedir=`cygpath -w "$basedir"`
|
|
||||||
fi
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
|
|
||||||
if [ -x "$basedir/node" ]; then
|
|
||||||
exec "$basedir/node" "$basedir/../mkdirp/bin/cmd.js" "$@"
|
|
||||||
else
|
|
||||||
exec node "$basedir/../mkdirp/bin/cmd.js" "$@"
|
|
||||||
fi
|
|
||||||
@ -1,17 +0,0 @@
|
|||||||
@ECHO off
|
|
||||||
GOTO start
|
|
||||||
:find_dp0
|
|
||||||
SET dp0=%~dp0
|
|
||||||
EXIT /b
|
|
||||||
:start
|
|
||||||
SETLOCAL
|
|
||||||
CALL :find_dp0
|
|
||||||
|
|
||||||
IF EXIST "%dp0%\node.exe" (
|
|
||||||
SET "_prog=%dp0%\node.exe"
|
|
||||||
) ELSE (
|
|
||||||
SET "_prog=node"
|
|
||||||
SET PATHEXT=%PATHEXT:;.JS;=;%
|
|
||||||
)
|
|
||||||
|
|
||||||
endLocal & goto #_undefined_# 2>NUL || title %COMSPEC% & "%_prog%" "%dp0%\..\mkdirp\bin\cmd.js" %*
|
|
||||||
@ -1,28 +0,0 @@
|
|||||||
#!/usr/bin/env pwsh
|
|
||||||
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
|
||||||
|
|
||||||
$exe=""
|
|
||||||
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
|
||||||
# Fix case when both the Windows and Linux builds of Node
|
|
||||||
# are installed in the same directory
|
|
||||||
$exe=".exe"
|
|
||||||
}
|
|
||||||
$ret=0
|
|
||||||
if (Test-Path "$basedir/node$exe") {
|
|
||||||
# Support pipeline input
|
|
||||||
if ($MyInvocation.ExpectingInput) {
|
|
||||||
$input | & "$basedir/node$exe" "$basedir/../mkdirp/bin/cmd.js" $args
|
|
||||||
} else {
|
|
||||||
& "$basedir/node$exe" "$basedir/../mkdirp/bin/cmd.js" $args
|
|
||||||
}
|
|
||||||
$ret=$LASTEXITCODE
|
|
||||||
} else {
|
|
||||||
# Support pipeline input
|
|
||||||
if ($MyInvocation.ExpectingInput) {
|
|
||||||
$input | & "node$exe" "$basedir/../mkdirp/bin/cmd.js" $args
|
|
||||||
} else {
|
|
||||||
& "node$exe" "$basedir/../mkdirp/bin/cmd.js" $args
|
|
||||||
}
|
|
||||||
$ret=$LASTEXITCODE
|
|
||||||
}
|
|
||||||
exit $ret
|
|
||||||
@ -1,16 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
|
||||||
|
|
||||||
case `uname` in
|
|
||||||
*CYGWIN*|*MINGW*|*MSYS*)
|
|
||||||
if command -v cygpath > /dev/null 2>&1; then
|
|
||||||
basedir=`cygpath -w "$basedir"`
|
|
||||||
fi
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
|
|
||||||
if [ -x "$basedir/node" ]; then
|
|
||||||
exec "$basedir/node" "$basedir/../@mapbox/node-pre-gyp/bin/node-pre-gyp" "$@"
|
|
||||||
else
|
|
||||||
exec node "$basedir/../@mapbox/node-pre-gyp/bin/node-pre-gyp" "$@"
|
|
||||||
fi
|
|
||||||
@ -1,17 +0,0 @@
|
|||||||
@ECHO off
|
|
||||||
GOTO start
|
|
||||||
:find_dp0
|
|
||||||
SET dp0=%~dp0
|
|
||||||
EXIT /b
|
|
||||||
:start
|
|
||||||
SETLOCAL
|
|
||||||
CALL :find_dp0
|
|
||||||
|
|
||||||
IF EXIST "%dp0%\node.exe" (
|
|
||||||
SET "_prog=%dp0%\node.exe"
|
|
||||||
) ELSE (
|
|
||||||
SET "_prog=node"
|
|
||||||
SET PATHEXT=%PATHEXT:;.JS;=;%
|
|
||||||
)
|
|
||||||
|
|
||||||
endLocal & goto #_undefined_# 2>NUL || title %COMSPEC% & "%_prog%" "%dp0%\..\@mapbox\node-pre-gyp\bin\node-pre-gyp" %*
|
|
||||||
@ -1,28 +0,0 @@
|
|||||||
#!/usr/bin/env pwsh
|
|
||||||
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
|
||||||
|
|
||||||
$exe=""
|
|
||||||
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
|
||||||
# Fix case when both the Windows and Linux builds of Node
|
|
||||||
# are installed in the same directory
|
|
||||||
$exe=".exe"
|
|
||||||
}
|
|
||||||
$ret=0
|
|
||||||
if (Test-Path "$basedir/node$exe") {
|
|
||||||
# Support pipeline input
|
|
||||||
if ($MyInvocation.ExpectingInput) {
|
|
||||||
$input | & "$basedir/node$exe" "$basedir/../@mapbox/node-pre-gyp/bin/node-pre-gyp" $args
|
|
||||||
} else {
|
|
||||||
& "$basedir/node$exe" "$basedir/../@mapbox/node-pre-gyp/bin/node-pre-gyp" $args
|
|
||||||
}
|
|
||||||
$ret=$LASTEXITCODE
|
|
||||||
} else {
|
|
||||||
# Support pipeline input
|
|
||||||
if ($MyInvocation.ExpectingInput) {
|
|
||||||
$input | & "node$exe" "$basedir/../@mapbox/node-pre-gyp/bin/node-pre-gyp" $args
|
|
||||||
} else {
|
|
||||||
& "node$exe" "$basedir/../@mapbox/node-pre-gyp/bin/node-pre-gyp" $args
|
|
||||||
}
|
|
||||||
$ret=$LASTEXITCODE
|
|
||||||
}
|
|
||||||
exit $ret
|
|
||||||
@ -1,16 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
|
||||||
|
|
||||||
case `uname` in
|
|
||||||
*CYGWIN*|*MINGW*|*MSYS*)
|
|
||||||
if command -v cygpath > /dev/null 2>&1; then
|
|
||||||
basedir=`cygpath -w "$basedir"`
|
|
||||||
fi
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
|
|
||||||
if [ -x "$basedir/node" ]; then
|
|
||||||
exec "$basedir/node" "$basedir/../nopt/bin/nopt.js" "$@"
|
|
||||||
else
|
|
||||||
exec node "$basedir/../nopt/bin/nopt.js" "$@"
|
|
||||||
fi
|
|
||||||
@ -1,17 +0,0 @@
|
|||||||
@ECHO off
|
|
||||||
GOTO start
|
|
||||||
:find_dp0
|
|
||||||
SET dp0=%~dp0
|
|
||||||
EXIT /b
|
|
||||||
:start
|
|
||||||
SETLOCAL
|
|
||||||
CALL :find_dp0
|
|
||||||
|
|
||||||
IF EXIST "%dp0%\node.exe" (
|
|
||||||
SET "_prog=%dp0%\node.exe"
|
|
||||||
) ELSE (
|
|
||||||
SET "_prog=node"
|
|
||||||
SET PATHEXT=%PATHEXT:;.JS;=;%
|
|
||||||
)
|
|
||||||
|
|
||||||
endLocal & goto #_undefined_# 2>NUL || title %COMSPEC% & "%_prog%" "%dp0%\..\nopt\bin\nopt.js" %*
|
|
||||||
@ -1,28 +0,0 @@
|
|||||||
#!/usr/bin/env pwsh
|
|
||||||
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
|
||||||
|
|
||||||
$exe=""
|
|
||||||
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
|
||||||
# Fix case when both the Windows and Linux builds of Node
|
|
||||||
# are installed in the same directory
|
|
||||||
$exe=".exe"
|
|
||||||
}
|
|
||||||
$ret=0
|
|
||||||
if (Test-Path "$basedir/node$exe") {
|
|
||||||
# Support pipeline input
|
|
||||||
if ($MyInvocation.ExpectingInput) {
|
|
||||||
$input | & "$basedir/node$exe" "$basedir/../nopt/bin/nopt.js" $args
|
|
||||||
} else {
|
|
||||||
& "$basedir/node$exe" "$basedir/../nopt/bin/nopt.js" $args
|
|
||||||
}
|
|
||||||
$ret=$LASTEXITCODE
|
|
||||||
} else {
|
|
||||||
# Support pipeline input
|
|
||||||
if ($MyInvocation.ExpectingInput) {
|
|
||||||
$input | & "node$exe" "$basedir/../nopt/bin/nopt.js" $args
|
|
||||||
} else {
|
|
||||||
& "node$exe" "$basedir/../nopt/bin/nopt.js" $args
|
|
||||||
}
|
|
||||||
$ret=$LASTEXITCODE
|
|
||||||
}
|
|
||||||
exit $ret
|
|
||||||
@ -1,16 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
|
||||||
|
|
||||||
case `uname` in
|
|
||||||
*CYGWIN*|*MINGW*|*MSYS*)
|
|
||||||
if command -v cygpath > /dev/null 2>&1; then
|
|
||||||
basedir=`cygpath -w "$basedir"`
|
|
||||||
fi
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
|
|
||||||
if [ -x "$basedir/node" ]; then
|
|
||||||
exec "$basedir/node" "$basedir/../rimraf/bin.js" "$@"
|
|
||||||
else
|
|
||||||
exec node "$basedir/../rimraf/bin.js" "$@"
|
|
||||||
fi
|
|
||||||
@ -1,17 +0,0 @@
|
|||||||
@ECHO off
|
|
||||||
GOTO start
|
|
||||||
:find_dp0
|
|
||||||
SET dp0=%~dp0
|
|
||||||
EXIT /b
|
|
||||||
:start
|
|
||||||
SETLOCAL
|
|
||||||
CALL :find_dp0
|
|
||||||
|
|
||||||
IF EXIST "%dp0%\node.exe" (
|
|
||||||
SET "_prog=%dp0%\node.exe"
|
|
||||||
) ELSE (
|
|
||||||
SET "_prog=node"
|
|
||||||
SET PATHEXT=%PATHEXT:;.JS;=;%
|
|
||||||
)
|
|
||||||
|
|
||||||
endLocal & goto #_undefined_# 2>NUL || title %COMSPEC% & "%_prog%" "%dp0%\..\rimraf\bin.js" %*
|
|
||||||
@ -1,28 +0,0 @@
|
|||||||
#!/usr/bin/env pwsh
|
|
||||||
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
|
||||||
|
|
||||||
$exe=""
|
|
||||||
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
|
||||||
# Fix case when both the Windows and Linux builds of Node
|
|
||||||
# are installed in the same directory
|
|
||||||
$exe=".exe"
|
|
||||||
}
|
|
||||||
$ret=0
|
|
||||||
if (Test-Path "$basedir/node$exe") {
|
|
||||||
# Support pipeline input
|
|
||||||
if ($MyInvocation.ExpectingInput) {
|
|
||||||
$input | & "$basedir/node$exe" "$basedir/../rimraf/bin.js" $args
|
|
||||||
} else {
|
|
||||||
& "$basedir/node$exe" "$basedir/../rimraf/bin.js" $args
|
|
||||||
}
|
|
||||||
$ret=$LASTEXITCODE
|
|
||||||
} else {
|
|
||||||
# Support pipeline input
|
|
||||||
if ($MyInvocation.ExpectingInput) {
|
|
||||||
$input | & "node$exe" "$basedir/../rimraf/bin.js" $args
|
|
||||||
} else {
|
|
||||||
& "node$exe" "$basedir/../rimraf/bin.js" $args
|
|
||||||
}
|
|
||||||
$ret=$LASTEXITCODE
|
|
||||||
}
|
|
||||||
exit $ret
|
|
||||||
@ -1,510 +0,0 @@
|
|||||||
# node-pre-gyp changelog
|
|
||||||
|
|
||||||
## 1.0.11
|
|
||||||
- Fixes dependabot alert [CVE-2021-44906](https://nvd.nist.gov/vuln/detail/CVE-2021-44906)
|
|
||||||
|
|
||||||
## 1.0.10
|
|
||||||
- Upgraded minimist to 1.2.6 to address dependabot alert [CVE-2021-44906](https://nvd.nist.gov/vuln/detail/CVE-2021-44906)
|
|
||||||
|
|
||||||
## 1.0.9
|
|
||||||
- Upgraded node-fetch to 2.6.7 to address [CVE-2022-0235](https://www.cve.org/CVERecord?id=CVE-2022-0235)
|
|
||||||
- Upgraded detect-libc to 2.0.0 to use non-blocking NodeJS(>=12) Report API
|
|
||||||
|
|
||||||
## 1.0.8
|
|
||||||
- Downgraded npmlog to maintain node v10 and v8 support (https://github.com/mapbox/node-pre-gyp/pull/624)
|
|
||||||
|
|
||||||
## 1.0.7
|
|
||||||
- Upgraded nyc and npmlog to address https://github.com/advisories/GHSA-93q8-gq69-wqmw
|
|
||||||
|
|
||||||
## 1.0.6
|
|
||||||
- Added node v17 to the internal node releases listing
|
|
||||||
- Upgraded various dependencies declared in package.json to latest major versions (node-fetch from 2.6.1 to 2.6.5, npmlog from 4.1.2 to 5.01, semver from 7.3.4 to 7.3.5, and tar from 6.1.0 to 6.1.11)
|
|
||||||
- Fixed bug in `staging_host` parameter (https://github.com/mapbox/node-pre-gyp/pull/590)
|
|
||||||
|
|
||||||
|
|
||||||
## 1.0.5
|
|
||||||
- Fix circular reference warning with node >= v14
|
|
||||||
|
|
||||||
## 1.0.4
|
|
||||||
- Added node v16 to the internal node releases listing
|
|
||||||
|
|
||||||
## 1.0.3
|
|
||||||
- Improved support configuring s3 uploads (solves https://github.com/mapbox/node-pre-gyp/issues/571)
|
|
||||||
- New options added in https://github.com/mapbox/node-pre-gyp/pull/576: 'bucket', 'region', and `s3ForcePathStyle`
|
|
||||||
|
|
||||||
## 1.0.2
|
|
||||||
- Fixed regression in proxy support (https://github.com/mapbox/node-pre-gyp/issues/572)
|
|
||||||
|
|
||||||
## 1.0.1
|
|
||||||
- Switched from mkdirp@1.0.4 to make-dir@3.1.0 to avoid this bug: https://github.com/isaacs/node-mkdirp/issues/31
|
|
||||||
|
|
||||||
## 1.0.0
|
|
||||||
- Module is now name-spaced at `@mapbox/node-pre-gyp` and the original `node-pre-gyp` is deprecated.
|
|
||||||
- New: support for staging and production s3 targets (see README.md)
|
|
||||||
- BREAKING: no longer supporting `node_pre_gyp_accessKeyId` & `node_pre_gyp_secretAccessKey`, use `AWS_ACCESS_KEY_ID` & `AWS_SECRET_ACCESS_KEY` instead to authenticate against s3 for `info`, `publish`, and `unpublish` commands.
|
|
||||||
- Dropped node v6 support, added node v14 support
|
|
||||||
- Switched tests to use mapbox-owned bucket for testing
|
|
||||||
- Added coverage tracking and linting with eslint
|
|
||||||
- Added back support for symlinks inside the tarball
|
|
||||||
- Upgraded all test apps to N-API/node-addon-api
|
|
||||||
- New: support for staging and production s3 targets (see README.md)
|
|
||||||
- Added `node_pre_gyp_s3_host` env var which has priority over the `--s3_host` option or default.
|
|
||||||
- Replaced needle with node-fetch
|
|
||||||
- Added proxy support for node-fetch
|
|
||||||
- Upgraded to mkdirp@1.x
|
|
||||||
|
|
||||||
## 0.17.0
|
|
||||||
- Got travis + appveyor green again
|
|
||||||
- Added support for more node versions
|
|
||||||
|
|
||||||
## 0.16.0
|
|
||||||
|
|
||||||
- Added Node 15 support in the local database (https://github.com/mapbox/node-pre-gyp/pull/520)
|
|
||||||
|
|
||||||
## 0.15.0
|
|
||||||
|
|
||||||
- Bump dependency on `mkdirp` from `^0.5.1` to `^0.5.3` (https://github.com/mapbox/node-pre-gyp/pull/492)
|
|
||||||
- Bump dependency on `needle` from `^2.2.1` to `^2.5.0` (https://github.com/mapbox/node-pre-gyp/pull/502)
|
|
||||||
- Added Node 14 support in the local database (https://github.com/mapbox/node-pre-gyp/pull/501)
|
|
||||||
|
|
||||||
## 0.14.0
|
|
||||||
|
|
||||||
- Defer modules requires in napi.js (https://github.com/mapbox/node-pre-gyp/pull/434)
|
|
||||||
- Bump dependency on `tar` from `^4` to `^4.4.2` (https://github.com/mapbox/node-pre-gyp/pull/454)
|
|
||||||
- Support extracting compiled binary from local offline mirror (https://github.com/mapbox/node-pre-gyp/pull/459)
|
|
||||||
- Added Node 13 support in the local database (https://github.com/mapbox/node-pre-gyp/pull/483)
|
|
||||||
|
|
||||||
## 0.13.0
|
|
||||||
|
|
||||||
- Added Node 12 support in the local database (https://github.com/mapbox/node-pre-gyp/pull/449)
|
|
||||||
|
|
||||||
## 0.12.0
|
|
||||||
|
|
||||||
- Fixed double-build problem with node v10 (https://github.com/mapbox/node-pre-gyp/pull/428)
|
|
||||||
- Added node 11 support in the local database (https://github.com/mapbox/node-pre-gyp/pull/422)
|
|
||||||
|
|
||||||
## 0.11.0
|
|
||||||
|
|
||||||
- Fixed double-install problem with node v10
|
|
||||||
- Significant N-API improvements (https://github.com/mapbox/node-pre-gyp/pull/405)
|
|
||||||
|
|
||||||
## 0.10.3
|
|
||||||
|
|
||||||
- Now will use `request` over `needle` if request is installed. By default `needle` is used for `https`. This should unbreak proxy support that regressed in v0.9.0
|
|
||||||
|
|
||||||
## 0.10.2
|
|
||||||
|
|
||||||
- Fixed rc/deep-extent security vulnerability
|
|
||||||
- Fixed broken reinstall script do to incorrectly named get_best_napi_version
|
|
||||||
|
|
||||||
## 0.10.1
|
|
||||||
|
|
||||||
- Fix needle error event (@medns)
|
|
||||||
|
|
||||||
## 0.10.0
|
|
||||||
|
|
||||||
- Allow for a single-level module path when packing @allenluce (https://github.com/mapbox/node-pre-gyp/pull/371)
|
|
||||||
- Log warnings instead of errors when falling back @xzyfer (https://github.com/mapbox/node-pre-gyp/pull/366)
|
|
||||||
- Add Node.js v10 support to tests (https://github.com/mapbox/node-pre-gyp/pull/372)
|
|
||||||
- Remove retire.js from CI (https://github.com/mapbox/node-pre-gyp/pull/372)
|
|
||||||
- Remove support for Node.js v4 due to [EOL on April 30th, 2018](https://github.com/nodejs/Release/blob/7dd52354049cae99eed0e9fe01345b0722a86fde/schedule.json#L14)
|
|
||||||
- Update appveyor tests to install default NPM version instead of NPM v2.x for all Windows builds (https://github.com/mapbox/node-pre-gyp/pull/375)
|
|
||||||
|
|
||||||
## 0.9.1
|
|
||||||
|
|
||||||
- Fixed regression (in v0.9.0) with support for http redirects @allenluce (https://github.com/mapbox/node-pre-gyp/pull/361)
|
|
||||||
|
|
||||||
## 0.9.0
|
|
||||||
|
|
||||||
- Switched from using `request` to `needle` to reduce size of module deps (https://github.com/mapbox/node-pre-gyp/pull/350)
|
|
||||||
|
|
||||||
## 0.8.0
|
|
||||||
|
|
||||||
- N-API support (@inspiredware)
|
|
||||||
|
|
||||||
## 0.7.1
|
|
||||||
|
|
||||||
- Upgraded to tar v4.x
|
|
||||||
|
|
||||||
## 0.7.0
|
|
||||||
|
|
||||||
- Updated request and hawk (#347)
|
|
||||||
- Dropped node v0.10.x support
|
|
||||||
|
|
||||||
## 0.6.40
|
|
||||||
|
|
||||||
- Improved error reporting if an install fails
|
|
||||||
|
|
||||||
## 0.6.39
|
|
||||||
|
|
||||||
- Support for node v9
|
|
||||||
- Support for versioning on `{libc}` to allow binaries to work on non-glic linux systems like alpine linux
|
|
||||||
|
|
||||||
|
|
||||||
## 0.6.38
|
|
||||||
|
|
||||||
- Maintaining compatibility (for v0.6.x series) with node v0.10.x
|
|
||||||
|
|
||||||
## 0.6.37
|
|
||||||
|
|
||||||
- Solved one part of #276: now now deduce the node ABI from the major version for node >= 2 even when not stored in the abi_crosswalk.json
|
|
||||||
- Fixed docs to avoid mentioning the deprecated and dangerous `prepublish` in package.json (#291)
|
|
||||||
- Add new node versions to crosswalk
|
|
||||||
- Ported tests to use tape instead of mocha
|
|
||||||
- Got appveyor tests passing by downgrading npm and node-gyp
|
|
||||||
|
|
||||||
## 0.6.36
|
|
||||||
|
|
||||||
- Removed the running of `testbinary` during install. Because this was regressed for so long, it is too dangerous to re-enable by default. Developers needing validation can call `node-pre-gyp testbinary` directory.
|
|
||||||
- Fixed regression in v0.6.35 for electron installs (now skipping binary validation which is not yet supported for electron)
|
|
||||||
|
|
||||||
## 0.6.35
|
|
||||||
|
|
||||||
- No longer recommending `npm ls` in `prepublish` (#291)
|
|
||||||
- Fixed testbinary command (#283) @szdavid92
|
|
||||||
|
|
||||||
## 0.6.34
|
|
||||||
|
|
||||||
- Added new node versions to crosswalk, including v8
|
|
||||||
- Upgraded deps to latest versions, started using `^` instead of `~` for all deps.
|
|
||||||
|
|
||||||
## 0.6.33
|
|
||||||
|
|
||||||
- Improved support for yarn
|
|
||||||
|
|
||||||
## 0.6.32
|
|
||||||
|
|
||||||
- Honor npm configuration for CA bundles (@heikkipora)
|
|
||||||
- Add node-pre-gyp and npm versions to user agent (@addaleax)
|
|
||||||
- Updated various deps
|
|
||||||
- Add known node version for v7.x
|
|
||||||
|
|
||||||
## 0.6.31
|
|
||||||
|
|
||||||
- Updated various deps
|
|
||||||
|
|
||||||
## 0.6.30
|
|
||||||
|
|
||||||
- Update to npmlog@4.x and semver@5.3.x
|
|
||||||
- Add known node version for v6.5.0
|
|
||||||
|
|
||||||
## 0.6.29
|
|
||||||
|
|
||||||
- Add known node versions for v0.10.45, v0.12.14, v4.4.4, v5.11.1, and v6.1.0
|
|
||||||
|
|
||||||
## 0.6.28
|
|
||||||
|
|
||||||
- Now more verbose when remote binaries are not available. This is needed since npm is increasingly more quiet by default
|
|
||||||
and users need to know why builds are falling back to source compiles that might then error out.
|
|
||||||
|
|
||||||
## 0.6.27
|
|
||||||
|
|
||||||
- Add known node version for node v6
|
|
||||||
- Stopped bundling dependencies
|
|
||||||
- Documented method for module authors to avoid bundling node-pre-gyp
|
|
||||||
- See https://github.com/mapbox/node-pre-gyp/tree/master#configuring for details
|
|
||||||
|
|
||||||
## 0.6.26
|
|
||||||
|
|
||||||
- Skip validation for nw runtime (https://github.com/mapbox/node-pre-gyp/pull/181) via @fleg
|
|
||||||
|
|
||||||
## 0.6.25
|
|
||||||
|
|
||||||
- Improved support for auto-detection of electron runtime in `node-pre-gyp.find()`
|
|
||||||
- Pull request from @enlight - https://github.com/mapbox/node-pre-gyp/pull/187
|
|
||||||
- Add known node version for 4.4.1 and 5.9.1
|
|
||||||
|
|
||||||
## 0.6.24
|
|
||||||
|
|
||||||
- Add known node version for 5.8.0, 5.9.0, and 4.4.0.
|
|
||||||
|
|
||||||
## 0.6.23
|
|
||||||
|
|
||||||
- Add known node version for 0.10.43, 0.12.11, 4.3.2, and 5.7.1.
|
|
||||||
|
|
||||||
## 0.6.22
|
|
||||||
|
|
||||||
- Add known node version for 4.3.1, and 5.7.0.
|
|
||||||
|
|
||||||
## 0.6.21
|
|
||||||
|
|
||||||
- Add known node version for 0.10.42, 0.12.10, 4.3.0, and 5.6.0.
|
|
||||||
|
|
||||||
## 0.6.20
|
|
||||||
|
|
||||||
- Add known node version for 4.2.5, 4.2.6, 5.4.0, 5.4.1,and 5.5.0.
|
|
||||||
|
|
||||||
## 0.6.19
|
|
||||||
|
|
||||||
- Add known node version for 4.2.4
|
|
||||||
|
|
||||||
## 0.6.18
|
|
||||||
|
|
||||||
- Add new known node versions for 0.10.x, 0.12.x, 4.x, and 5.x
|
|
||||||
|
|
||||||
## 0.6.17
|
|
||||||
|
|
||||||
- Re-tagged to fix packaging problem of `Error: Cannot find module 'isarray'`
|
|
||||||
|
|
||||||
## 0.6.16
|
|
||||||
|
|
||||||
- Added known version in crosswalk for 5.1.0.
|
|
||||||
|
|
||||||
## 0.6.15
|
|
||||||
|
|
||||||
- Upgraded tar-pack (https://github.com/mapbox/node-pre-gyp/issues/182)
|
|
||||||
- Support custom binary hosting mirror (https://github.com/mapbox/node-pre-gyp/pull/170)
|
|
||||||
- Added known version in crosswalk for 4.2.2.
|
|
||||||
|
|
||||||
## 0.6.14
|
|
||||||
|
|
||||||
- Added node 5.x version
|
|
||||||
|
|
||||||
## 0.6.13
|
|
||||||
|
|
||||||
- Added more known node 4.x versions
|
|
||||||
|
|
||||||
## 0.6.12
|
|
||||||
|
|
||||||
- Added support for [Electron](http://electron.atom.io/). Just pass the `--runtime=electron` flag when building/installing. Thanks @zcbenz
|
|
||||||
|
|
||||||
## 0.6.11
|
|
||||||
|
|
||||||
- Added known node and io.js versions including more 3.x and 4.x versions
|
|
||||||
|
|
||||||
## 0.6.10
|
|
||||||
|
|
||||||
- Added known node and io.js versions including 3.x and 4.x versions
|
|
||||||
- Upgraded `tar` dep
|
|
||||||
|
|
||||||
## 0.6.9
|
|
||||||
|
|
||||||
- Upgraded `rc` dep
|
|
||||||
- Updated known io.js version: v2.4.0
|
|
||||||
|
|
||||||
## 0.6.8
|
|
||||||
|
|
||||||
- Upgraded `semver` and `rimraf` deps
|
|
||||||
- Updated known node and io.js versions
|
|
||||||
|
|
||||||
## 0.6.7
|
|
||||||
|
|
||||||
- Fixed `node_abi` versions for io.js 1.1.x -> 1.8.x (should be 43, but was stored as 42) (refs https://github.com/iojs/build/issues/94)
|
|
||||||
|
|
||||||
## 0.6.6
|
|
||||||
|
|
||||||
- Updated with known io.js 2.0.0 version
|
|
||||||
|
|
||||||
## 0.6.5
|
|
||||||
|
|
||||||
- Now respecting `npm_config_node_gyp` (https://github.com/npm/npm/pull/4887)
|
|
||||||
- Updated to semver@4.3.2
|
|
||||||
- Updated known node v0.12.x versions and io.js 1.x versions.
|
|
||||||
|
|
||||||
## 0.6.4
|
|
||||||
|
|
||||||
- Improved support for `io.js` (@fengmk2)
|
|
||||||
- Test coverage improvements (@mikemorris)
|
|
||||||
- Fixed support for `--dist-url` that regressed in 0.6.3
|
|
||||||
|
|
||||||
## 0.6.3
|
|
||||||
|
|
||||||
- Added support for passing raw options to node-gyp using `--` separator. Flags passed after
|
|
||||||
the `--` to `node-pre-gyp configure` will be passed directly to gyp while flags passed
|
|
||||||
after the `--` will be passed directly to make/visual studio.
|
|
||||||
- Added `node-pre-gyp configure` command to be able to call `node-gyp configure` directly
|
|
||||||
- Fix issue with require validation not working on windows 7 (@edgarsilva)
|
|
||||||
|
|
||||||
## 0.6.2
|
|
||||||
|
|
||||||
- Support for io.js >= v1.0.2
|
|
||||||
- Deferred require of `request` and `tar` to help speed up command line usage of `node-pre-gyp`.
|
|
||||||
|
|
||||||
## 0.6.1
|
|
||||||
|
|
||||||
- Fixed bundled `tar` version
|
|
||||||
|
|
||||||
## 0.6.0
|
|
||||||
|
|
||||||
- BREAKING: node odd releases like v0.11.x now use `major.minor.patch` for `{node_abi}` instead of `NODE_MODULE_VERSION` (#124)
|
|
||||||
- Added support for `toolset` option in versioning. By default is an empty string but `--toolset` can be passed to publish or install to select alternative binaries that target a custom toolset like C++11. For example to target Visual Studio 2014 modules like node-sqlite3 use `--toolset=v140`.
|
|
||||||
- Added support for `--no-rollback` option to request that a failed binary test does not remove the binary module leaves it in place.
|
|
||||||
- Added support for `--update-binary` option to request an existing binary be re-installed and the check for a valid local module be skipped.
|
|
||||||
- Added support for passing build options from `npm` through `node-pre-gyp` to `node-gyp`: `--nodedir`, `--disturl`, `--python`, and `--msvs_version`
|
|
||||||
|
|
||||||
## 0.5.31
|
|
||||||
|
|
||||||
- Added support for deducing node_abi for node.js runtime from previous release if the series is even
|
|
||||||
- Added support for --target=0.10.33
|
|
||||||
|
|
||||||
## 0.5.30
|
|
||||||
|
|
||||||
- Repackaged with latest bundled deps
|
|
||||||
|
|
||||||
## 0.5.29
|
|
||||||
|
|
||||||
- Added support for semver `build`.
|
|
||||||
- Fixed support for downloading from urls that include `+`.
|
|
||||||
|
|
||||||
## 0.5.28
|
|
||||||
|
|
||||||
- Now reporting unix style paths only in reveal command
|
|
||||||
|
|
||||||
## 0.5.27
|
|
||||||
|
|
||||||
- Fixed support for auto-detecting s3 bucket name when it contains `.` - @taavo
|
|
||||||
- Fixed support for installing when path contains a `'` - @halfdan
|
|
||||||
- Ported tests to mocha
|
|
||||||
|
|
||||||
## 0.5.26
|
|
||||||
|
|
||||||
- Fix node-webkit support when `--target` option is not provided
|
|
||||||
|
|
||||||
## 0.5.25
|
|
||||||
|
|
||||||
- Fix bundling of deps
|
|
||||||
|
|
||||||
## 0.5.24
|
|
||||||
|
|
||||||
- Updated ABI crosswalk to incldue node v0.10.30 and v0.10.31
|
|
||||||
|
|
||||||
## 0.5.23
|
|
||||||
|
|
||||||
- Added `reveal` command. Pass no options to get all versioning data as json. Pass a second arg to grab a single versioned property value
|
|
||||||
- Added support for `--silent` (shortcut for `--loglevel=silent`)
|
|
||||||
|
|
||||||
## 0.5.22
|
|
||||||
|
|
||||||
- Fixed node-webkit versioning name (NOTE: node-webkit support still experimental)
|
|
||||||
|
|
||||||
## 0.5.21
|
|
||||||
|
|
||||||
- New package to fix `shasum check failed` error with v0.5.20
|
|
||||||
|
|
||||||
## 0.5.20
|
|
||||||
|
|
||||||
- Now versioning node-webkit binaries based on major.minor.patch - assuming no compatible ABI across versions (#90)
|
|
||||||
|
|
||||||
## 0.5.19
|
|
||||||
|
|
||||||
- Updated to know about more node-webkit releases
|
|
||||||
|
|
||||||
## 0.5.18
|
|
||||||
|
|
||||||
- Updated to know about more node-webkit releases
|
|
||||||
|
|
||||||
## 0.5.17
|
|
||||||
|
|
||||||
- Updated to know about node v0.10.29 release
|
|
||||||
|
|
||||||
## 0.5.16
|
|
||||||
|
|
||||||
- Now supporting all aws-sdk configuration parameters (http://docs.aws.amazon.com/AWSJavaScriptSDK/guide/node-configuring.html) (#86)
|
|
||||||
|
|
||||||
## 0.5.15
|
|
||||||
|
|
||||||
- Fixed installation of windows packages sub directories on unix systems (#84)
|
|
||||||
|
|
||||||
## 0.5.14
|
|
||||||
|
|
||||||
- Finished support for cross building using `--target_platform` option (#82)
|
|
||||||
- Now skipping binary validation on install if target arch/platform do not match the host.
|
|
||||||
- Removed multi-arch validing for OS X since it required a FAT node.js binary
|
|
||||||
|
|
||||||
## 0.5.13
|
|
||||||
|
|
||||||
- Fix problem in 0.5.12 whereby the wrong versions of mkdirp and semver where bundled.
|
|
||||||
|
|
||||||
## 0.5.12
|
|
||||||
|
|
||||||
- Improved support for node-webkit (@Mithgol)
|
|
||||||
|
|
||||||
## 0.5.11
|
|
||||||
|
|
||||||
- Updated target versions listing
|
|
||||||
|
|
||||||
## 0.5.10
|
|
||||||
|
|
||||||
- Fixed handling of `-debug` flag passed directory to node-pre-gyp (#72)
|
|
||||||
- Added optional second arg to `node_pre_gyp.find` to customize the default versioning options used to locate the runtime binary
|
|
||||||
- Failed install due to `testbinary` check failure no longer leaves behind binary (#70)
|
|
||||||
|
|
||||||
## 0.5.9
|
|
||||||
|
|
||||||
- Fixed regression in `testbinary` command causing installs to fail on windows with 0.5.7 (#60)
|
|
||||||
|
|
||||||
## 0.5.8
|
|
||||||
|
|
||||||
- Started bundling deps
|
|
||||||
|
|
||||||
## 0.5.7
|
|
||||||
|
|
||||||
- Fixed the `testbinary` check, which is used to determine whether to re-download or source compile, to work even in complex dependency situations (#63)
|
|
||||||
- Exposed the internal `testbinary` command in node-pre-gyp command line tool
|
|
||||||
- Fixed minor bug so that `fallback_to_build` option is always respected
|
|
||||||
|
|
||||||
## 0.5.6
|
|
||||||
|
|
||||||
- Added support for versioning on the `name` value in `package.json` (#57).
|
|
||||||
- Moved to using streams for reading tarball when publishing (#52)
|
|
||||||
|
|
||||||
## 0.5.5
|
|
||||||
|
|
||||||
- Improved binary validation that also now works with node-webkit (@Mithgol)
|
|
||||||
- Upgraded test apps to work with node v0.11.x
|
|
||||||
- Improved test coverage
|
|
||||||
|
|
||||||
## 0.5.4
|
|
||||||
|
|
||||||
- No longer depends on external install of node-gyp for compiling builds.
|
|
||||||
|
|
||||||
## 0.5.3
|
|
||||||
|
|
||||||
- Reverted fix for debian/nodejs since it broke windows (#45)
|
|
||||||
|
|
||||||
## 0.5.2
|
|
||||||
|
|
||||||
- Support for debian systems where the node binary is named `nodejs` (#45)
|
|
||||||
- Added `bin/node-pre-gyp.cmd` to be able to run command on windows locally (npm creates an .npm automatically when globally installed)
|
|
||||||
- Updated abi-crosswalk with node v0.10.26 entry.
|
|
||||||
|
|
||||||
## 0.5.1
|
|
||||||
|
|
||||||
- Various minor bug fixes, several improving windows support for publishing.
|
|
||||||
|
|
||||||
## 0.5.0
|
|
||||||
|
|
||||||
- Changed property names in `binary` object: now required are `module_name`, `module_path`, and `host`.
|
|
||||||
- Now `module_path` supports versioning, which allows developers to opt-in to using a versioned install path (#18).
|
|
||||||
- Added `remote_path` which also supports versioning.
|
|
||||||
- Changed `remote_uri` to `host`.
|
|
||||||
|
|
||||||
## 0.4.2
|
|
||||||
|
|
||||||
- Added support for `--target` flag to request cross-compile against a specific node/node-webkit version.
|
|
||||||
- Added preliminary support for node-webkit
|
|
||||||
- Fixed support for `--target_arch` option being respected in all cases.
|
|
||||||
|
|
||||||
## 0.4.1
|
|
||||||
|
|
||||||
- Fixed exception when only stderr is available in binary test (@bendi / #31)
|
|
||||||
|
|
||||||
## 0.4.0
|
|
||||||
|
|
||||||
- Enforce only `https:` based remote publishing access.
|
|
||||||
- Added `node-pre-gyp info` command to display listing of published binaries
|
|
||||||
- Added support for changing the directory node-pre-gyp should build in with the `-C/--directory` option.
|
|
||||||
- Added support for S3 prefixes.
|
|
||||||
|
|
||||||
## 0.3.1
|
|
||||||
|
|
||||||
- Added `unpublish` command.
|
|
||||||
- Fixed module path construction in tests.
|
|
||||||
- Added ability to disable falling back to build behavior via `npm install --fallback-to-build=false` which overrides setting in a depedencies package.json `install` target.
|
|
||||||
|
|
||||||
## 0.3.0
|
|
||||||
|
|
||||||
- Support for packaging all files in `module_path` directory - see `app4` for example
|
|
||||||
- Added `testpackage` command.
|
|
||||||
- Changed `clean` command to only delete `.node` not entire `build` directory since node-gyp will handle that.
|
|
||||||
- `.node` modules must be in a folder of there own since tar-pack will remove everything when it unpacks.
|
|
||||||
@ -1,27 +0,0 @@
|
|||||||
Copyright (c), Mapbox
|
|
||||||
|
|
||||||
All rights reserved.
|
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without modification,
|
|
||||||
are permitted provided that the following conditions are met:
|
|
||||||
|
|
||||||
* Redistributions of source code must retain the above copyright notice,
|
|
||||||
this list of conditions and the following disclaimer.
|
|
||||||
* Redistributions in binary form must reproduce the above copyright notice,
|
|
||||||
this list of conditions and the following disclaimer in the documentation
|
|
||||||
and/or other materials provided with the distribution.
|
|
||||||
* Neither the name of node-pre-gyp nor the names of its contributors
|
|
||||||
may be used to endorse or promote products derived from this software
|
|
||||||
without specific prior written permission.
|
|
||||||
|
|
||||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
||||||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
||||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
||||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
|
|
||||||
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
|
||||||
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
||||||
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
|
||||||
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
|
||||||
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
|
||||||
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
||||||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
||||||
@ -1,742 +0,0 @@
|
|||||||
# @mapbox/node-pre-gyp
|
|
||||||
|
|
||||||
#### @mapbox/node-pre-gyp makes it easy to publish and install Node.js C++ addons from binaries
|
|
||||||
|
|
||||||
[](https://travis-ci.com/mapbox/node-pre-gyp)
|
|
||||||
[](https://ci.appveyor.com/project/Mapbox/node-pre-gyp)
|
|
||||||
|
|
||||||
`@mapbox/node-pre-gyp` stands between [npm](https://github.com/npm/npm) and [node-gyp](https://github.com/Tootallnate/node-gyp) and offers a cross-platform method of binary deployment.
|
|
||||||
|
|
||||||
### Special note on previous package
|
|
||||||
|
|
||||||
On Feb 9th, 2021 `@mapbox/node-pre-gyp@1.0.0` was [released](./CHANGELOG.md). Older, unscoped versions that are not part of the `@mapbox` org are deprecated and only `@mapbox/node-pre-gyp` will see updates going forward. To upgrade to the new package do:
|
|
||||||
|
|
||||||
```
|
|
||||||
npm uninstall node-pre-gyp --save
|
|
||||||
npm install @mapbox/node-pre-gyp --save
|
|
||||||
```
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
- A command line tool called `node-pre-gyp` that can install your package's C++ module from a binary.
|
|
||||||
- A variety of developer targeted commands for packaging, testing, and publishing binaries.
|
|
||||||
- A JavaScript module that can dynamically require your installed binary: `require('@mapbox/node-pre-gyp').find`
|
|
||||||
|
|
||||||
For a hello world example of a module packaged with `node-pre-gyp` see <https://github.com/springmeyer/node-addon-example> and [the wiki ](https://github.com/mapbox/node-pre-gyp/wiki/Modules-using-node-pre-gyp) for real world examples.
|
|
||||||
|
|
||||||
## Credits
|
|
||||||
|
|
||||||
- The module is modeled after [node-gyp](https://github.com/Tootallnate/node-gyp) by [@Tootallnate](https://github.com/Tootallnate)
|
|
||||||
- Motivation for initial development came from [@ErisDS](https://github.com/ErisDS) and the [Ghost Project](https://github.com/TryGhost/Ghost).
|
|
||||||
- Development is sponsored by [Mapbox](https://www.mapbox.com/)
|
|
||||||
|
|
||||||
## FAQ
|
|
||||||
|
|
||||||
See the [Frequently Ask Questions](https://github.com/mapbox/node-pre-gyp/wiki/FAQ).
|
|
||||||
|
|
||||||
## Depends
|
|
||||||
|
|
||||||
- Node.js >= node v8.x
|
|
||||||
|
|
||||||
## Install
|
|
||||||
|
|
||||||
`node-pre-gyp` is designed to be installed as a local dependency of your Node.js C++ addon and accessed like:
|
|
||||||
|
|
||||||
./node_modules/.bin/node-pre-gyp --help
|
|
||||||
|
|
||||||
But you can also install it globally:
|
|
||||||
|
|
||||||
npm install @mapbox/node-pre-gyp -g
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
### Commands
|
|
||||||
|
|
||||||
View all possible commands:
|
|
||||||
|
|
||||||
node-pre-gyp --help
|
|
||||||
|
|
||||||
- clean - Remove the entire folder containing the compiled .node module
|
|
||||||
- install - Install pre-built binary for module
|
|
||||||
- reinstall - Run "clean" and "install" at once
|
|
||||||
- build - Compile the module by dispatching to node-gyp or nw-gyp
|
|
||||||
- rebuild - Run "clean" and "build" at once
|
|
||||||
- package - Pack binary into tarball
|
|
||||||
- testpackage - Test that the staged package is valid
|
|
||||||
- publish - Publish pre-built binary
|
|
||||||
- unpublish - Unpublish pre-built binary
|
|
||||||
- info - Fetch info on published binaries
|
|
||||||
|
|
||||||
You can also chain commands:
|
|
||||||
|
|
||||||
node-pre-gyp clean build unpublish publish info
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
Options include:
|
|
||||||
|
|
||||||
- `-C/--directory`: run the command in this directory
|
|
||||||
- `--build-from-source`: build from source instead of using pre-built binary
|
|
||||||
- `--update-binary`: reinstall by replacing previously installed local binary with remote binary
|
|
||||||
- `--runtime=node-webkit`: customize the runtime: `node`, `electron` and `node-webkit` are the valid options
|
|
||||||
- `--fallback-to-build`: fallback to building from source if pre-built binary is not available
|
|
||||||
- `--target=0.4.0`: Pass the target node or node-webkit version to compile against
|
|
||||||
- `--target_arch=ia32`: Pass the target arch and override the host `arch`. Any value that is [supported by Node.js](https://nodejs.org/api/os.html#osarch) is valid.
|
|
||||||
- `--target_platform=win32`: Pass the target platform and override the host `platform`. Valid values are `linux`, `darwin`, `win32`, `sunos`, `freebsd`, `openbsd`, and `aix`.
|
|
||||||
|
|
||||||
Both `--build-from-source` and `--fallback-to-build` can be passed alone or they can provide values. You can pass `--fallback-to-build=false` to override the option as declared in package.json. In addition to being able to pass `--build-from-source` you can also pass `--build-from-source=myapp` where `myapp` is the name of your module.
|
|
||||||
|
|
||||||
For example: `npm install --build-from-source=myapp`. This is useful if:
|
|
||||||
|
|
||||||
- `myapp` is referenced in the package.json of a larger app and therefore `myapp` is being installed as a dependency with `npm install`.
|
|
||||||
- The larger app also depends on other modules installed with `node-pre-gyp`
|
|
||||||
- You only want to trigger a source compile for `myapp` and the other modules.
|
|
||||||
|
|
||||||
### Configuring
|
|
||||||
|
|
||||||
This is a guide to configuring your module to use node-pre-gyp.
|
|
||||||
|
|
||||||
#### 1) Add new entries to your `package.json`
|
|
||||||
|
|
||||||
- Add `@mapbox/node-pre-gyp` to `dependencies`
|
|
||||||
- Add `aws-sdk` as a `devDependency`
|
|
||||||
- Add a custom `install` script
|
|
||||||
- Declare a `binary` object
|
|
||||||
|
|
||||||
This looks like:
|
|
||||||
|
|
||||||
```js
|
|
||||||
"dependencies" : {
|
|
||||||
"@mapbox/node-pre-gyp": "1.x"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"aws-sdk": "2.x"
|
|
||||||
}
|
|
||||||
"scripts": {
|
|
||||||
"install": "node-pre-gyp install --fallback-to-build"
|
|
||||||
},
|
|
||||||
"binary": {
|
|
||||||
"module_name": "your_module",
|
|
||||||
"module_path": "./lib/binding/",
|
|
||||||
"host": "https://your_module.s3-us-west-1.amazonaws.com"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
For a full example see [node-addon-examples's package.json](https://github.com/springmeyer/node-addon-example/blob/master/package.json).
|
|
||||||
|
|
||||||
Let's break this down:
|
|
||||||
|
|
||||||
- Dependencies need to list `node-pre-gyp`
|
|
||||||
- Your devDependencies should list `aws-sdk` so that you can run `node-pre-gyp publish` locally or a CI system. We recommend using `devDependencies` only since `aws-sdk` is large and not needed for `node-pre-gyp install` since it only uses http to fetch binaries
|
|
||||||
- Your `scripts` section should override the `install` target with `"install": "node-pre-gyp install --fallback-to-build"`. This allows node-pre-gyp to be used instead of the default npm behavior of always source compiling with `node-gyp` directly.
|
|
||||||
- Your package.json should contain a `binary` section describing key properties you provide to allow node-pre-gyp to package optimally. They are detailed below.
|
|
||||||
|
|
||||||
Note: in the past we recommended putting `@mapbox/node-pre-gyp` in the `bundledDependencies`, but we no longer recommend this. In the past there were npm bugs (with node versions 0.10.x) that could lead to node-pre-gyp not being available at the right time during install (unless we bundled). This should no longer be the case. Also, for a time we recommended using `"preinstall": "npm install @mapbox/node-pre-gyp"` as an alternative method to avoid needing to bundle. But this did not behave predictably across all npm versions - see https://github.com/mapbox/node-pre-gyp/issues/260 for the details. So we do not recommend using `preinstall` to install `@mapbox/node-pre-gyp`. More history on this at https://github.com/strongloop/fsevents/issues/157#issuecomment-265545908.
|
|
||||||
|
|
||||||
##### The `binary` object has three required properties
|
|
||||||
|
|
||||||
###### module_name
|
|
||||||
|
|
||||||
The name of your native node module. This value must:
|
|
||||||
|
|
||||||
- Match the name passed to [the NODE_MODULE macro](http://nodejs.org/api/addons.html#addons_hello_world)
|
|
||||||
- Must be a valid C variable name (e.g. it cannot contain `-`)
|
|
||||||
- Should not include the `.node` extension.
|
|
||||||
|
|
||||||
###### module_path
|
|
||||||
|
|
||||||
The location your native module is placed after a build. This should be an empty directory without other Javascript files. This entire directory will be packaged in the binary tarball. When installing from a remote package this directory will be overwritten with the contents of the tarball.
|
|
||||||
|
|
||||||
Note: This property supports variables based on [Versioning](#versioning).
|
|
||||||
|
|
||||||
###### host
|
|
||||||
|
|
||||||
A url to the remote location where you've published tarball binaries (must be `https` not `http`).
|
|
||||||
|
|
||||||
It is highly recommended that you use Amazon S3. The reasons are:
|
|
||||||
|
|
||||||
- Various node-pre-gyp commands like `publish` and `info` only work with an S3 host.
|
|
||||||
- S3 is a very solid hosting platform for distributing large files.
|
|
||||||
- We provide detail documentation for using [S3 hosting](#s3-hosting) with node-pre-gyp.
|
|
||||||
|
|
||||||
Why then not require S3? Because while some applications using node-pre-gyp need to distribute binaries as large as 20-30 MB, others might have very small binaries and might wish to store them in a GitHub repo. This is not recommended, but if an author really wants to host in a non-S3 location then it should be possible.
|
|
||||||
|
|
||||||
It should also be mentioned that there is an optional and entirely separate npm module called [node-pre-gyp-github](https://github.com/bchr02/node-pre-gyp-github) which is intended to complement node-pre-gyp and be installed along with it. It provides the ability to store and publish your binaries within your repositories GitHub Releases if you would rather not use S3 directly. Installation and usage instructions can be found [here](https://github.com/bchr02/node-pre-gyp-github), but the basic premise is that instead of using the ```node-pre-gyp publish``` command you would use ```node-pre-gyp-github publish```.
|
|
||||||
|
|
||||||
##### The `binary` object other optional S3 properties
|
|
||||||
|
|
||||||
If you are not using a standard s3 path like `bucket_name.s3(.-)region.amazonaws.com`, you might get an error on `publish` because node-pre-gyp extracts the region and bucket from the `host` url. For example, you may have an on-premises s3-compatible storage server, or may have configured a specific dns redirecting to an s3 endpoint. In these cases, you can explicitly set the `region` and `bucket` properties to tell node-pre-gyp to use these values instead of guessing from the `host` property. The following values can be used in the `binary` section:
|
|
||||||
|
|
||||||
###### host
|
|
||||||
|
|
||||||
The url to the remote server root location (must be `https` not `http`).
|
|
||||||
|
|
||||||
###### bucket
|
|
||||||
|
|
||||||
The bucket name where your tarball binaries should be located.
|
|
||||||
|
|
||||||
###### region
|
|
||||||
|
|
||||||
Your S3 server region.
|
|
||||||
|
|
||||||
###### s3ForcePathStyle
|
|
||||||
|
|
||||||
Set `s3ForcePathStyle` to true if the endpoint url should not be prefixed with the bucket name. If false (default), the server endpoint would be constructed as `bucket_name.your_server.com`.
|
|
||||||
|
|
||||||
##### The `binary` object has optional properties
|
|
||||||
|
|
||||||
###### remote_path
|
|
||||||
|
|
||||||
It **is recommended** that you customize this property. This is an extra path to use for publishing and finding remote tarballs. The default value for `remote_path` is `""` meaning that if you do not provide it then all packages will be published at the base of the `host`. It is recommended to provide a value like `./{name}/v{version}` to help organize remote packages in the case that you choose to publish multiple node addons to the same `host`.
|
|
||||||
|
|
||||||
Note: This property supports variables based on [Versioning](#versioning).
|
|
||||||
|
|
||||||
###### package_name
|
|
||||||
|
|
||||||
It is **not recommended** to override this property unless you are also overriding the `remote_path`. This is the versioned name of the remote tarball containing the binary `.node` module and any supporting files you've placed inside the `module_path` directory. Unless you specify `package_name` in your `package.json` then it defaults to `{module_name}-v{version}-{node_abi}-{platform}-{arch}.tar.gz` which allows your binary to work across node versions, platforms, and architectures. If you are using `remote_path` that is also versioned by `./{module_name}/v{version}` then you could remove these variables from the `package_name` and just use: `{node_abi}-{platform}-{arch}.tar.gz`. Then your remote tarball will be looked up at, for example, `https://example.com/your-module/v0.1.0/node-v11-linux-x64.tar.gz`.
|
|
||||||
|
|
||||||
Avoiding the version of your module in the `package_name` and instead only embedding in a directory name can be useful when you want to make a quick tag of your module that does not change any C++ code. In this case you can just copy binaries to the new version behind the scenes like:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
aws s3 sync --acl public-read s3://mapbox-node-binary/sqlite3/v3.0.3/ s3://mapbox-node-binary/sqlite3/v3.0.4/
|
|
||||||
```
|
|
||||||
|
|
||||||
Note: This property supports variables based on [Versioning](#versioning).
|
|
||||||
|
|
||||||
#### 2) Add a new target to binding.gyp
|
|
||||||
|
|
||||||
`node-pre-gyp` calls out to `node-gyp` to compile the module and passes variables along like [module_name](#module_name) and [module_path](#module_path).
|
|
||||||
|
|
||||||
A new target must be added to `binding.gyp` that moves the compiled `.node` module from `./build/Release/module_name.node` into the directory specified by `module_path`.
|
|
||||||
|
|
||||||
Add a target like this at the end of your `targets` list:
|
|
||||||
|
|
||||||
```js
|
|
||||||
{
|
|
||||||
"target_name": "action_after_build",
|
|
||||||
"type": "none",
|
|
||||||
"dependencies": [ "<(module_name)" ],
|
|
||||||
"copies": [
|
|
||||||
{
|
|
||||||
"files": [ "<(PRODUCT_DIR)/<(module_name).node" ],
|
|
||||||
"destination": "<(module_path)"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
For a full example see [node-addon-example's binding.gyp](https://github.com/springmeyer/node-addon-example/blob/2ff60a8ded7f042864ad21db00c3a5a06cf47075/binding.gyp).
|
|
||||||
|
|
||||||
#### 3) Dynamically require your `.node`
|
|
||||||
|
|
||||||
Inside the main js file that requires your addon module you are likely currently doing:
|
|
||||||
|
|
||||||
```js
|
|
||||||
var binding = require('../build/Release/binding.node');
|
|
||||||
```
|
|
||||||
|
|
||||||
or:
|
|
||||||
|
|
||||||
```js
|
|
||||||
var bindings = require('./bindings')
|
|
||||||
```
|
|
||||||
|
|
||||||
Change those lines to:
|
|
||||||
|
|
||||||
```js
|
|
||||||
var binary = require('@mapbox/node-pre-gyp');
|
|
||||||
var path = require('path');
|
|
||||||
var binding_path = binary.find(path.resolve(path.join(__dirname,'./package.json')));
|
|
||||||
var binding = require(binding_path);
|
|
||||||
```
|
|
||||||
|
|
||||||
For a full example see [node-addon-example's index.js](https://github.com/springmeyer/node-addon-example/blob/2ff60a8ded7f042864ad21db00c3a5a06cf47075/index.js#L1-L4)
|
|
||||||
|
|
||||||
#### 4) Build and package your app
|
|
||||||
|
|
||||||
Now build your module from source:
|
|
||||||
|
|
||||||
npm install --build-from-source
|
|
||||||
|
|
||||||
The `--build-from-source` tells `node-pre-gyp` to not look for a remote package and instead dispatch to node-gyp to build.
|
|
||||||
|
|
||||||
Now `node-pre-gyp` should now also be installed as a local dependency so the command line tool it offers can be found at `./node_modules/.bin/node-pre-gyp`.
|
|
||||||
|
|
||||||
#### 5) Test
|
|
||||||
|
|
||||||
Now `npm test` should work just as it did before.
|
|
||||||
|
|
||||||
#### 6) Publish the tarball
|
|
||||||
|
|
||||||
Then package your app:
|
|
||||||
|
|
||||||
./node_modules/.bin/node-pre-gyp package
|
|
||||||
|
|
||||||
Once packaged, now you can publish:
|
|
||||||
|
|
||||||
./node_modules/.bin/node-pre-gyp publish
|
|
||||||
|
|
||||||
Currently the `publish` command pushes your binary to S3. This requires:
|
|
||||||
|
|
||||||
- You have installed `aws-sdk` with `npm install aws-sdk`
|
|
||||||
- You have created a bucket already.
|
|
||||||
- The `host` points to an S3 http or https endpoint.
|
|
||||||
- You have configured node-pre-gyp to read your S3 credentials (see [S3 hosting](#s3-hosting) for details).
|
|
||||||
|
|
||||||
You can also host your binaries elsewhere. To do this requires:
|
|
||||||
|
|
||||||
- You manually publish the binary created by the `package` command to an `https` endpoint
|
|
||||||
- Ensure that the `host` value points to your custom `https` endpoint.
|
|
||||||
|
|
||||||
#### 7) Automate builds
|
|
||||||
|
|
||||||
Now you need to publish builds for all the platforms and node versions you wish to support. This is best automated.
|
|
||||||
|
|
||||||
- See [Appveyor Automation](#appveyor-automation) for how to auto-publish builds on Windows.
|
|
||||||
- See [Travis Automation](#travis-automation) for how to auto-publish builds on OS X and Linux.
|
|
||||||
|
|
||||||
#### 8) You're done!
|
|
||||||
|
|
||||||
Now publish your module to the npm registry. Users will now be able to install your module from a binary.
|
|
||||||
|
|
||||||
What will happen is this:
|
|
||||||
|
|
||||||
1. `npm install <your package>` will pull from the npm registry
|
|
||||||
2. npm will run the `install` script which will call out to `node-pre-gyp`
|
|
||||||
3. `node-pre-gyp` will fetch the binary `.node` module and unpack in the right place
|
|
||||||
4. Assuming that all worked, you are done
|
|
||||||
|
|
||||||
If a a binary was not available for a given platform and `--fallback-to-build` was used then `node-gyp rebuild` will be called to try to source compile the module.
|
|
||||||
|
|
||||||
#### 9) One more option
|
|
||||||
|
|
||||||
It may be that you want to work with two s3 buckets, one for staging and one for production; this
|
|
||||||
arrangement makes it less likely to accidentally overwrite a production binary. It also allows the production
|
|
||||||
environment to have more restrictive permissions than staging while still enabling publishing when
|
|
||||||
developing and testing.
|
|
||||||
|
|
||||||
The binary.host property can be set at execution time. In order to do so all of the following conditions
|
|
||||||
must be true.
|
|
||||||
|
|
||||||
- binary.host is falsey or not present
|
|
||||||
- binary.staging_host is not empty
|
|
||||||
- binary.production_host is not empty
|
|
||||||
|
|
||||||
If any of these checks fail then the operation will not perform execution time determination of the s3 target.
|
|
||||||
|
|
||||||
If the command being executed is either "publish" or "unpublish" then the default is set to `binary.staging_host`. In all other cases
|
|
||||||
the default is `binary.production_host`.
|
|
||||||
|
|
||||||
The command-line options `--s3_host=staging` or `--s3_host=production` override the default. If `s3_host`
|
|
||||||
is present and not `staging` or `production` an exception is thrown.
|
|
||||||
|
|
||||||
This allows installing from staging by specifying `--s3_host=staging`. And it requires specifying
|
|
||||||
`--s3_option=production` in order to publish to, or unpublish from, production, making accidental errors less likely.
|
|
||||||
|
|
||||||
## Node-API Considerations
|
|
||||||
|
|
||||||
[Node-API](https://nodejs.org/api/n-api.html#n_api_node_api), which was previously known as N-API, is an ABI-stable alternative to previous technologies such as [nan](https://github.com/nodejs/nan) which are tied to a specific Node runtime engine. Node-API is Node runtime engine agnostic and guarantees modules created today will continue to run, without changes, into the future.
|
|
||||||
|
|
||||||
Using `node-pre-gyp` with Node-API projects requires a handful of additional configuration values and imposes some additional requirements.
|
|
||||||
|
|
||||||
The most significant difference is that an Node-API module can be coded to target multiple Node-API versions. Therefore, an Node-API module must declare in its `package.json` file which Node-API versions the module is designed to run against. In addition, since multiple builds may be required for a single module, path and file names must be specified in way that avoids naming conflicts.
|
|
||||||
|
|
||||||
### The `napi_versions` array property
|
|
||||||
|
|
||||||
A Node-API module must declare in its `package.json` file, the Node-API versions the module is intended to support. This is accomplished by including an `napi-versions` array property in the `binary` object. For example:
|
|
||||||
|
|
||||||
```js
|
|
||||||
"binary": {
|
|
||||||
"module_name": "your_module",
|
|
||||||
"module_path": "your_module_path",
|
|
||||||
"host": "https://your_bucket.s3-us-west-1.amazonaws.com",
|
|
||||||
"napi_versions": [1,3]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
If the `napi_versions` array property is *not* present, `node-pre-gyp` operates as it always has. Including the `napi_versions` array property instructs `node-pre-gyp` that this is a Node-API module build.
|
|
||||||
|
|
||||||
When the `napi_versions` array property is present, `node-pre-gyp` fires off multiple operations, one for each of the Node-API versions in the array. In the example above, two operations are initiated, one for Node-API version 1 and second for Node-API version 3. How this version number is communicated is described next.
|
|
||||||
|
|
||||||
### The `napi_build_version` value
|
|
||||||
|
|
||||||
For each of the Node-API module operations `node-pre-gyp` initiates, it ensures that the `napi_build_version` is set appropriately.
|
|
||||||
|
|
||||||
This value is of importance in two areas:
|
|
||||||
|
|
||||||
1. The C/C++ code which needs to know against which Node-API version it should compile.
|
|
||||||
2. `node-pre-gyp` itself which must assign appropriate path and file names to avoid collisions.
|
|
||||||
|
|
||||||
### Defining `NAPI_VERSION` for the C/C++ code
|
|
||||||
|
|
||||||
The `napi_build_version` value is communicated to the C/C++ code by adding this code to the `binding.gyp` file:
|
|
||||||
|
|
||||||
```
|
|
||||||
"defines": [
|
|
||||||
"NAPI_VERSION=<(napi_build_version)",
|
|
||||||
]
|
|
||||||
```
|
|
||||||
|
|
||||||
This ensures that `NAPI_VERSION`, an integer value, is declared appropriately to the C/C++ code for each build.
|
|
||||||
|
|
||||||
> Note that earlier versions of this document recommended defining the symbol `NAPI_BUILD_VERSION`. `NAPI_VERSION` is preferred because it used by the Node-API C/C++ headers to configure the specific Node-API versions being requested.
|
|
||||||
|
|
||||||
### Path and file naming requirements in `package.json`
|
|
||||||
|
|
||||||
Since `node-pre-gyp` fires off multiple operations for each request, it is essential that path and file names be created in such a way as to avoid collisions. This is accomplished by imposing additional path and file naming requirements.
|
|
||||||
|
|
||||||
Specifically, when performing Node-API builds, the `{napi_build_version}` text configuration value *must* be present in the `module_path` property. In addition, the `{napi_build_version}` text configuration value *must* be present in either the `remote_path` or `package_name` property. (No problem if it's in both.)
|
|
||||||
|
|
||||||
Here's an example:
|
|
||||||
|
|
||||||
```js
|
|
||||||
"binary": {
|
|
||||||
"module_name": "your_module",
|
|
||||||
"module_path": "./lib/binding/napi-v{napi_build_version}",
|
|
||||||
"remote_path": "./{module_name}/v{version}/{configuration}/",
|
|
||||||
"package_name": "{platform}-{arch}-napi-v{napi_build_version}.tar.gz",
|
|
||||||
"host": "https://your_bucket.s3-us-west-1.amazonaws.com",
|
|
||||||
"napi_versions": [1,3]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Supporting both Node-API and NAN builds
|
|
||||||
|
|
||||||
You may have a legacy native add-on that you wish to continue supporting for those versions of Node that do not support Node-API, as you add Node-API support for later Node versions. This can be accomplished by specifying the `node_napi_label` configuration value in the package.json `binary.package_name` property.
|
|
||||||
|
|
||||||
Placing the configuration value `node_napi_label` in the package.json `binary.package_name` property instructs `node-pre-gyp` to build all viable Node-API binaries supported by the current Node instance. If the current Node instance does not support Node-API, `node-pre-gyp` will request a traditional, non-Node-API build.
|
|
||||||
|
|
||||||
The configuration value `node_napi_label` is set by `node-pre-gyp` to the type of build created, `napi` or `node`, and the version number. For Node-API builds, the string contains the Node-API version nad has values like `napi-v3`. For traditional, non-Node-API builds, the string contains the ABI version with values like `node-v46`.
|
|
||||||
|
|
||||||
Here's how the `binary` configuration above might be changed to support both Node-API and NAN builds:
|
|
||||||
|
|
||||||
```js
|
|
||||||
"binary": {
|
|
||||||
"module_name": "your_module",
|
|
||||||
"module_path": "./lib/binding/{node_napi_label}",
|
|
||||||
"remote_path": "./{module_name}/v{version}/{configuration}/",
|
|
||||||
"package_name": "{platform}-{arch}-{node_napi_label}.tar.gz",
|
|
||||||
"host": "https://your_bucket.s3-us-west-1.amazonaws.com",
|
|
||||||
"napi_versions": [1,3]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
The C/C++ symbol `NAPI_VERSION` can be used to distinguish Node-API and non-Node-API builds. The value of `NAPI_VERSION` is set to the integer Node-API version for Node-API builds and is set to `0` for non-Node-API builds.
|
|
||||||
|
|
||||||
For example:
|
|
||||||
|
|
||||||
```C
|
|
||||||
#if NAPI_VERSION
|
|
||||||
// Node-API code goes here
|
|
||||||
#else
|
|
||||||
// NAN code goes here
|
|
||||||
#endif
|
|
||||||
```
|
|
||||||
|
|
||||||
### Two additional configuration values
|
|
||||||
|
|
||||||
The following two configuration values, which were implemented in previous versions of `node-pre-gyp`, continue to exist, but have been replaced by the `node_napi_label` configuration value described above.
|
|
||||||
|
|
||||||
1. `napi_version` If Node-API is supported by the currently executing Node instance, this value is the Node-API version number supported by Node. If Node-API is not supported, this value is an empty string.
|
|
||||||
|
|
||||||
2. `node_abi_napi` If the value returned for `napi_version` is non empty, this value is `'napi'`. If the value returned for `napi_version` is empty, this value is the value returned for `node_abi`.
|
|
||||||
|
|
||||||
These values are present for use in the `binding.gyp` file and may be used as `{napi_version}` and `{node_abi_napi}` for text substituion in the `binary` properties of the `package.json` file.
|
|
||||||
|
|
||||||
## S3 Hosting
|
|
||||||
|
|
||||||
You can host wherever you choose but S3 is cheap, `node-pre-gyp publish` expects it, and S3 can be integrated well with [Travis.ci](http://travis-ci.org) to automate builds for OS X and Ubuntu, and with [Appveyor](http://appveyor.com) to automate builds for Windows. Here is an approach to do this:
|
|
||||||
|
|
||||||
First, get setup locally and test the workflow:
|
|
||||||
|
|
||||||
#### 1) Create an S3 bucket
|
|
||||||
|
|
||||||
And have your **key** and **secret key** ready for writing to the bucket.
|
|
||||||
|
|
||||||
It is recommended to create a IAM user with a policy that only gives permissions to the specific bucket you plan to publish to. This can be done in the [IAM console](https://console.aws.amazon.com/iam/) by: 1) adding a new user, 2) choosing `Attach User Policy`, 3) Using the `Policy Generator`, 4) selecting `Amazon S3` for the service, 5) adding the actions: `DeleteObject`, `GetObject`, `GetObjectAcl`, `ListBucket`, `HeadBucket`, `PutObject`, `PutObjectAcl`, 6) adding an ARN of `arn:aws:s3:::bucket/*` (replacing `bucket` with your bucket name), and finally 7) clicking `Add Statement` and saving the policy. It should generate a policy like:
|
|
||||||
|
|
||||||
```js
|
|
||||||
{
|
|
||||||
"Version": "2012-10-17",
|
|
||||||
"Statement": [
|
|
||||||
{
|
|
||||||
"Sid": "objects",
|
|
||||||
"Effect": "Allow",
|
|
||||||
"Action": [
|
|
||||||
"s3:PutObject",
|
|
||||||
"s3:GetObjectAcl",
|
|
||||||
"s3:GetObject",
|
|
||||||
"s3:DeleteObject",
|
|
||||||
"s3:PutObjectAcl"
|
|
||||||
],
|
|
||||||
"Resource": "arn:aws:s3:::your-bucket-name/*"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"Sid": "bucket",
|
|
||||||
"Effect": "Allow",
|
|
||||||
"Action": "s3:ListBucket",
|
|
||||||
"Resource": "arn:aws:s3:::your-bucket-name"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"Sid": "buckets",
|
|
||||||
"Effect": "Allow",
|
|
||||||
"Action": "s3:HeadBucket",
|
|
||||||
"Resource": "*"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
#### 2) Install node-pre-gyp
|
|
||||||
|
|
||||||
Either install it globally:
|
|
||||||
|
|
||||||
npm install node-pre-gyp -g
|
|
||||||
|
|
||||||
Or put the local version on your PATH
|
|
||||||
|
|
||||||
export PATH=`pwd`/node_modules/.bin/:$PATH
|
|
||||||
|
|
||||||
#### 3) Configure AWS credentials
|
|
||||||
|
|
||||||
It is recommended to configure the AWS JS SDK v2 used internally by `node-pre-gyp` by setting these environment variables:
|
|
||||||
|
|
||||||
- AWS_ACCESS_KEY_ID
|
|
||||||
- AWS_SECRET_ACCESS_KEY
|
|
||||||
|
|
||||||
But also you can also use the `Shared Config File` mentioned [in the AWS JS SDK v2 docs](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/configuring-the-jssdk.html)
|
|
||||||
|
|
||||||
#### 4) Package and publish your build
|
|
||||||
|
|
||||||
Install the `aws-sdk`:
|
|
||||||
|
|
||||||
npm install aws-sdk
|
|
||||||
|
|
||||||
Then publish:
|
|
||||||
|
|
||||||
node-pre-gyp package publish
|
|
||||||
|
|
||||||
Note: if you hit an error like `Hostname/IP doesn't match certificate's altnames` it may mean that you need to provide the `region` option in your config.
|
|
||||||
|
|
||||||
## Appveyor Automation
|
|
||||||
|
|
||||||
[Appveyor](http://www.appveyor.com/) can build binaries and publish the results per commit and supports:
|
|
||||||
|
|
||||||
- Windows Visual Studio 2013 and related compilers
|
|
||||||
- Both 64 bit (x64) and 32 bit (x86) build configurations
|
|
||||||
- Multiple Node.js versions
|
|
||||||
|
|
||||||
For an example of doing this see [node-sqlite3's appveyor.yml](https://github.com/mapbox/node-sqlite3/blob/master/appveyor.yml).
|
|
||||||
|
|
||||||
Below is a guide to getting set up:
|
|
||||||
|
|
||||||
#### 1) Create a free Appveyor account
|
|
||||||
|
|
||||||
Go to https://ci.appveyor.com/signup/free and sign in with your GitHub account.
|
|
||||||
|
|
||||||
#### 2) Create a new project
|
|
||||||
|
|
||||||
Go to https://ci.appveyor.com/projects/new and select the GitHub repo for your module
|
|
||||||
|
|
||||||
#### 3) Add appveyor.yml and push it
|
|
||||||
|
|
||||||
Once you have committed an `appveyor.yml` ([appveyor.yml reference](http://www.appveyor.com/docs/appveyor-yml)) to your GitHub repo and pushed it AppVeyor should automatically start building your project.
|
|
||||||
|
|
||||||
#### 4) Create secure variables
|
|
||||||
|
|
||||||
Encrypt your S3 AWS keys by going to <https://ci.appveyor.com/tools/encrypt> and hitting the `encrypt` button.
|
|
||||||
|
|
||||||
Then paste the result into your `appveyor.yml`
|
|
||||||
|
|
||||||
```yml
|
|
||||||
environment:
|
|
||||||
AWS_ACCESS_KEY_ID:
|
|
||||||
secure: Dn9HKdLNYvDgPdQOzRq/DqZ/MPhjknRHB1o+/lVU8MA=
|
|
||||||
AWS_SECRET_ACCESS_KEY:
|
|
||||||
secure: W1rwNoSnOku1r+28gnoufO8UA8iWADmL1LiiwH9IOkIVhDTNGdGPJqAlLjNqwLnL
|
|
||||||
```
|
|
||||||
|
|
||||||
NOTE: keys are per account but not per repo (this is difference than Travis where keys are per repo but not related to the account used to encrypt them).
|
|
||||||
|
|
||||||
#### 5) Hook up publishing
|
|
||||||
|
|
||||||
Just put `node-pre-gyp package publish` in your `appveyor.yml` after `npm install`.
|
|
||||||
|
|
||||||
#### 6) Publish when you want
|
|
||||||
|
|
||||||
You might wish to publish binaries only on a specific commit. To do this you could borrow from the [Travis CI idea of commit keywords](http://about.travis-ci.org/docs/user/how-to-skip-a-build/) and add special handling for commit messages with `[publish binary]`:
|
|
||||||
|
|
||||||
SET CM=%APPVEYOR_REPO_COMMIT_MESSAGE%
|
|
||||||
if not "%CM%" == "%CM:[publish binary]=%" node-pre-gyp --msvs_version=2013 publish
|
|
||||||
|
|
||||||
If your commit message contains special characters (e.g. `&`) this method might fail. An alternative is to use PowerShell, which gives you additional possibilities, like ignoring case by using `ToLower()`:
|
|
||||||
|
|
||||||
ps: if($env:APPVEYOR_REPO_COMMIT_MESSAGE.ToLower().Contains('[publish binary]')) { node-pre-gyp --msvs_version=2013 publish }
|
|
||||||
|
|
||||||
Remember this publishing is not the same as `npm publish`. We're just talking about the binary module here and not your entire npm package.
|
|
||||||
|
|
||||||
## Travis Automation
|
|
||||||
|
|
||||||
[Travis](https://travis-ci.org/) can push to S3 after a successful build and supports both:
|
|
||||||
|
|
||||||
- Ubuntu Precise and OS X (64 bit)
|
|
||||||
- Multiple Node.js versions
|
|
||||||
|
|
||||||
For an example of doing this see [node-add-example's .travis.yml](https://github.com/springmeyer/node-addon-example/blob/2ff60a8ded7f042864ad21db00c3a5a06cf47075/.travis.yml).
|
|
||||||
|
|
||||||
Note: if you need 32 bit binaries, this can be done from a 64 bit Travis machine. See [the node-sqlite3 scripts for an example of doing this](https://github.com/mapbox/node-sqlite3/blob/bae122aa6a2b8a45f6b717fab24e207740e32b5d/scripts/build_against_node.sh#L54-L74).
|
|
||||||
|
|
||||||
Below is a guide to getting set up:
|
|
||||||
|
|
||||||
#### 1) Install the Travis gem
|
|
||||||
|
|
||||||
gem install travis
|
|
||||||
|
|
||||||
#### 2) Create secure variables
|
|
||||||
|
|
||||||
Make sure you run this command from within the directory of your module.
|
|
||||||
|
|
||||||
Use `travis-encrypt` like:
|
|
||||||
|
|
||||||
travis encrypt AWS_ACCESS_KEY_ID=${node_pre_gyp_accessKeyId}
|
|
||||||
travis encrypt AWS_SECRET_ACCESS_KEY=${node_pre_gyp_secretAccessKey}
|
|
||||||
|
|
||||||
Then put those values in your `.travis.yml` like:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
env:
|
|
||||||
global:
|
|
||||||
- secure: F+sEL/v56CzHqmCSSES4pEyC9NeQlkoR0Gs/ZuZxX1ytrj8SKtp3MKqBj7zhIclSdXBz4Ev966Da5ctmcTd410p0b240MV6BVOkLUtkjZJyErMBOkeb8n8yVfSoeMx8RiIhBmIvEn+rlQq+bSFis61/JkE9rxsjkGRZi14hHr4M=
|
|
||||||
- secure: o2nkUQIiABD139XS6L8pxq3XO5gch27hvm/gOdV+dzNKc/s2KomVPWcOyXNxtJGhtecAkABzaW8KHDDi5QL1kNEFx6BxFVMLO8rjFPsMVaBG9Ks6JiDQkkmrGNcnVdxI/6EKTLHTH5WLsz8+J7caDBzvKbEfTux5EamEhxIWgrI=
|
|
||||||
```
|
|
||||||
|
|
||||||
More details on Travis encryption at http://about.travis-ci.org/docs/user/encryption-keys/.
|
|
||||||
|
|
||||||
#### 3) Hook up publishing
|
|
||||||
|
|
||||||
Just put `node-pre-gyp package publish` in your `.travis.yml` after `npm install`.
|
|
||||||
|
|
||||||
##### OS X publishing
|
|
||||||
|
|
||||||
If you want binaries for OS X in addition to linux you can enable [multi-os for Travis](http://docs.travis-ci.com/user/multi-os/#Setting-.travis.yml)
|
|
||||||
|
|
||||||
Use a configuration like:
|
|
||||||
|
|
||||||
```yml
|
|
||||||
|
|
||||||
language: cpp
|
|
||||||
|
|
||||||
os:
|
|
||||||
- linux
|
|
||||||
- osx
|
|
||||||
|
|
||||||
env:
|
|
||||||
matrix:
|
|
||||||
- NODE_VERSION="4"
|
|
||||||
- NODE_VERSION="6"
|
|
||||||
|
|
||||||
before_install:
|
|
||||||
- rm -rf ~/.nvm/ && git clone --depth 1 https://github.com/creationix/nvm.git ~/.nvm
|
|
||||||
- source ~/.nvm/nvm.sh
|
|
||||||
- nvm install $NODE_VERSION
|
|
||||||
- nvm use $NODE_VERSION
|
|
||||||
```
|
|
||||||
|
|
||||||
See [Travis OS X Gotchas](#travis-os-x-gotchas) for why we replace `language: node_js` and `node_js:` sections with `language: cpp` and a custom matrix.
|
|
||||||
|
|
||||||
Also create platform specific sections for any deps that need install. For example if you need libpng:
|
|
||||||
|
|
||||||
```yml
|
|
||||||
- if [ $(uname -s) == 'Linux' ]; then apt-get install libpng-dev; fi;
|
|
||||||
- if [ $(uname -s) == 'Darwin' ]; then brew install libpng; fi;
|
|
||||||
```
|
|
||||||
|
|
||||||
For detailed multi-OS examples see [node-mapnik](https://github.com/mapnik/node-mapnik/blob/master/.travis.yml) and [node-sqlite3](https://github.com/mapbox/node-sqlite3/blob/master/.travis.yml).
|
|
||||||
|
|
||||||
##### Travis OS X Gotchas
|
|
||||||
|
|
||||||
First, unlike the Travis Linux machines, the OS X machines do not put `node-pre-gyp` on PATH by default. To do so you will need to:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
export PATH=$(pwd)/node_modules/.bin:${PATH}
|
|
||||||
```
|
|
||||||
|
|
||||||
Second, the OS X machines do not support using a matrix for installing different Node.js versions. So you need to bootstrap the installation of Node.js in a cross platform way.
|
|
||||||
|
|
||||||
By doing:
|
|
||||||
|
|
||||||
```yml
|
|
||||||
env:
|
|
||||||
matrix:
|
|
||||||
- NODE_VERSION="4"
|
|
||||||
- NODE_VERSION="6"
|
|
||||||
|
|
||||||
before_install:
|
|
||||||
- rm -rf ~/.nvm/ && git clone --depth 1 https://github.com/creationix/nvm.git ~/.nvm
|
|
||||||
- source ~/.nvm/nvm.sh
|
|
||||||
- nvm install $NODE_VERSION
|
|
||||||
- nvm use $NODE_VERSION
|
|
||||||
```
|
|
||||||
|
|
||||||
You can easily recreate the previous behavior of this matrix:
|
|
||||||
|
|
||||||
```yml
|
|
||||||
node_js:
|
|
||||||
- "4"
|
|
||||||
- "6"
|
|
||||||
```
|
|
||||||
|
|
||||||
#### 4) Publish when you want
|
|
||||||
|
|
||||||
You might wish to publish binaries only on a specific commit. To do this you could borrow from the [Travis CI idea of commit keywords](http://about.travis-ci.org/docs/user/how-to-skip-a-build/) and add special handling for commit messages with `[publish binary]`:
|
|
||||||
|
|
||||||
COMMIT_MESSAGE=$(git log --format=%B --no-merges -n 1 | tr -d '\n')
|
|
||||||
if [[ ${COMMIT_MESSAGE} =~ "[publish binary]" ]]; then node-pre-gyp publish; fi;
|
|
||||||
|
|
||||||
Then you can trigger new binaries to be built like:
|
|
||||||
|
|
||||||
git commit -a -m "[publish binary]"
|
|
||||||
|
|
||||||
Or, if you don't have any changes to make simply run:
|
|
||||||
|
|
||||||
git commit --allow-empty -m "[publish binary]"
|
|
||||||
|
|
||||||
WARNING: if you are working in a pull request and publishing binaries from there then you will want to avoid double publishing when Travis CI builds both the `push` and `pr`. You only want to run the publish on the `push` commit. See https://github.com/Project-OSRM/node-osrm/blob/8eb837abe2e2e30e595093d16e5354bc5c573575/scripts/is_pr_merge.sh which is called from https://github.com/Project-OSRM/node-osrm/blob/8eb837abe2e2e30e595093d16e5354bc5c573575/scripts/publish.sh for an example of how to do this.
|
|
||||||
|
|
||||||
Remember this publishing is not the same as `npm publish`. We're just talking about the binary module here and not your entire npm package. To automate the publishing of your entire package to npm on Travis see http://about.travis-ci.org/docs/user/deployment/npm/
|
|
||||||
|
|
||||||
# Versioning
|
|
||||||
|
|
||||||
The `binary` properties of `module_path`, `remote_path`, and `package_name` support variable substitution. The strings are evaluated by `node-pre-gyp` depending on your system and any custom build flags you passed.
|
|
||||||
|
|
||||||
- `node_abi`: The node C++ `ABI` number. This value is available in Javascript as `process.versions.modules` as of [`>= v0.10.4 >= v0.11.7`](https://github.com/joyent/node/commit/ccabd4a6fa8a6eb79d29bc3bbe9fe2b6531c2d8e) and in C++ as the `NODE_MODULE_VERSION` define much earlier. For versions of Node before this was available we fallback to the V8 major and minor version.
|
|
||||||
- `platform` matches node's `process.platform` like `linux`, `darwin`, and `win32` unless the user passed the `--target_platform` option to override.
|
|
||||||
- `arch` matches node's `process.arch` like `x64` or `ia32` unless the user passes the `--target_arch` option to override.
|
|
||||||
- `libc` matches `require('detect-libc').family` like `glibc` or `musl` unless the user passes the `--target_libc` option to override.
|
|
||||||
- `configuration` - Either 'Release' or 'Debug' depending on if `--debug` is passed during the build.
|
|
||||||
- `module_name` - the `binary.module_name` attribute from `package.json`.
|
|
||||||
- `version` - the semver `version` value for your module from `package.json` (NOTE: ignores the `semver.build` property).
|
|
||||||
- `major`, `minor`, `patch`, and `prelease` match the individual semver values for your module's `version`
|
|
||||||
- `build` - the sevmer `build` value. For example it would be `this.that` if your package.json `version` was `v1.0.0+this.that`
|
|
||||||
- `prerelease` - the semver `prerelease` value. For example it would be `alpha.beta` if your package.json `version` was `v1.0.0-alpha.beta`
|
|
||||||
|
|
||||||
|
|
||||||
The options are visible in the code at <https://github.com/mapbox/node-pre-gyp/blob/612b7bca2604508d881e1187614870ba19a7f0c5/lib/util/versioning.js#L114-L127>
|
|
||||||
|
|
||||||
# Download binary files from a mirror
|
|
||||||
|
|
||||||
S3 is broken in China for the well known reason.
|
|
||||||
|
|
||||||
Using the `npm` config argument: `--{module_name}_binary_host_mirror` can download binary files through a mirror, `-` in `module_name` will be replaced with `_`.
|
|
||||||
|
|
||||||
e.g.: Install [v8-profiler](https://www.npmjs.com/package/v8-profiler) from `npm`.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ npm install v8-profiler --profiler_binary_host_mirror=https://npm.taobao.org/mirrors/node-inspector/
|
|
||||||
```
|
|
||||||
|
|
||||||
e.g.: Install [canvas-prebuilt](https://www.npmjs.com/package/canvas-prebuilt) from `npm`.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ npm install canvas-prebuilt --canvas_prebuilt_binary_host_mirror=https://npm.taobao.org/mirrors/canvas-prebuilt/
|
|
||||||
```
|
|
||||||
@ -1,4 +0,0 @@
|
|||||||
#!/usr/bin/env node
|
|
||||||
'use strict';
|
|
||||||
|
|
||||||
require('../lib/main');
|
|
||||||
@ -1,2 +0,0 @@
|
|||||||
@echo off
|
|
||||||
node "%~dp0\node-pre-gyp" %*
|
|
||||||
@ -1,10 +0,0 @@
|
|||||||
# Contributing
|
|
||||||
|
|
||||||
|
|
||||||
### Releasing a new version:
|
|
||||||
|
|
||||||
- Ensure tests are passing on travis and appveyor
|
|
||||||
- Run `node scripts/abi_crosswalk.js` and commit any changes
|
|
||||||
- Update the changelog
|
|
||||||
- Tag a new release like: `git tag -a v0.6.34 -m "tagging v0.6.34" && git push --tags`
|
|
||||||
- Run `npm publish`
|
|
||||||
@ -1,51 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
module.exports = exports = build;
|
|
||||||
|
|
||||||
exports.usage = 'Attempts to compile the module by dispatching to node-gyp or nw-gyp';
|
|
||||||
|
|
||||||
const napi = require('./util/napi.js');
|
|
||||||
const compile = require('./util/compile.js');
|
|
||||||
const handle_gyp_opts = require('./util/handle_gyp_opts.js');
|
|
||||||
const configure = require('./configure.js');
|
|
||||||
|
|
||||||
function do_build(gyp, argv, callback) {
|
|
||||||
handle_gyp_opts(gyp, argv, (err, result) => {
|
|
||||||
let final_args = ['build'].concat(result.gyp).concat(result.pre);
|
|
||||||
if (result.unparsed.length > 0) {
|
|
||||||
final_args = final_args.
|
|
||||||
concat(['--']).
|
|
||||||
concat(result.unparsed);
|
|
||||||
}
|
|
||||||
if (!err && result.opts.napi_build_version) {
|
|
||||||
napi.swap_build_dir_in(result.opts.napi_build_version);
|
|
||||||
}
|
|
||||||
compile.run_gyp(final_args, result.opts, (err2) => {
|
|
||||||
if (result.opts.napi_build_version) {
|
|
||||||
napi.swap_build_dir_out(result.opts.napi_build_version);
|
|
||||||
}
|
|
||||||
return callback(err2);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
function build(gyp, argv, callback) {
|
|
||||||
|
|
||||||
// Form up commands to pass to node-gyp:
|
|
||||||
// We map `node-pre-gyp build` to `node-gyp configure build` so that we do not
|
|
||||||
// trigger a clean and therefore do not pay the penalty of a full recompile
|
|
||||||
if (argv.length && (argv.indexOf('rebuild') > -1)) {
|
|
||||||
argv.shift(); // remove `rebuild`
|
|
||||||
// here we map `node-pre-gyp rebuild` to `node-gyp rebuild` which internally means
|
|
||||||
// "clean + configure + build" and triggers a full recompile
|
|
||||||
compile.run_gyp(['clean'], {}, (err3) => {
|
|
||||||
if (err3) return callback(err3);
|
|
||||||
configure(gyp, argv, (err4) => {
|
|
||||||
if (err4) return callback(err4);
|
|
||||||
return do_build(gyp, argv, callback);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
} else {
|
|
||||||
return do_build(gyp, argv, callback);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,31 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
module.exports = exports = clean;
|
|
||||||
|
|
||||||
exports.usage = 'Removes the entire folder containing the compiled .node module';
|
|
||||||
|
|
||||||
const rm = require('rimraf');
|
|
||||||
const exists = require('fs').exists || require('path').exists;
|
|
||||||
const versioning = require('./util/versioning.js');
|
|
||||||
const napi = require('./util/napi.js');
|
|
||||||
const path = require('path');
|
|
||||||
|
|
||||||
function clean(gyp, argv, callback) {
|
|
||||||
const package_json = gyp.package_json;
|
|
||||||
const napi_build_version = napi.get_napi_build_version_from_command_args(argv);
|
|
||||||
const opts = versioning.evaluate(package_json, gyp.opts, napi_build_version);
|
|
||||||
const to_delete = opts.module_path;
|
|
||||||
if (!to_delete) {
|
|
||||||
return callback(new Error('module_path is empty, refusing to delete'));
|
|
||||||
} else if (path.normalize(to_delete) === path.normalize(process.cwd())) {
|
|
||||||
return callback(new Error('module_path is not set, refusing to delete'));
|
|
||||||
} else {
|
|
||||||
exists(to_delete, (found) => {
|
|
||||||
if (found) {
|
|
||||||
if (!gyp.opts.silent_clean) console.log('[' + package_json.name + '] Removing "%s"', to_delete);
|
|
||||||
return rm(to_delete, callback);
|
|
||||||
}
|
|
||||||
return callback();
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,52 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
module.exports = exports = configure;
|
|
||||||
|
|
||||||
exports.usage = 'Attempts to configure node-gyp or nw-gyp build';
|
|
||||||
|
|
||||||
const napi = require('./util/napi.js');
|
|
||||||
const compile = require('./util/compile.js');
|
|
||||||
const handle_gyp_opts = require('./util/handle_gyp_opts.js');
|
|
||||||
|
|
||||||
function configure(gyp, argv, callback) {
|
|
||||||
handle_gyp_opts(gyp, argv, (err, result) => {
|
|
||||||
let final_args = result.gyp.concat(result.pre);
|
|
||||||
// pull select node-gyp configure options out of the npm environ
|
|
||||||
const known_gyp_args = ['dist-url', 'python', 'nodedir', 'msvs_version'];
|
|
||||||
known_gyp_args.forEach((key) => {
|
|
||||||
const val = gyp.opts[key] || gyp.opts[key.replace('-', '_')];
|
|
||||||
if (val) {
|
|
||||||
final_args.push('--' + key + '=' + val);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
// --ensure=false tell node-gyp to re-install node development headers
|
|
||||||
// but it is only respected by node-gyp install, so we have to call install
|
|
||||||
// as a separate step if the user passes it
|
|
||||||
if (gyp.opts.ensure === false) {
|
|
||||||
const install_args = final_args.concat(['install', '--ensure=false']);
|
|
||||||
compile.run_gyp(install_args, result.opts, (err2) => {
|
|
||||||
if (err2) return callback(err2);
|
|
||||||
if (result.unparsed.length > 0) {
|
|
||||||
final_args = final_args.
|
|
||||||
concat(['--']).
|
|
||||||
concat(result.unparsed);
|
|
||||||
}
|
|
||||||
compile.run_gyp(['configure'].concat(final_args), result.opts, (err3) => {
|
|
||||||
return callback(err3);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
} else {
|
|
||||||
if (result.unparsed.length > 0) {
|
|
||||||
final_args = final_args.
|
|
||||||
concat(['--']).
|
|
||||||
concat(result.unparsed);
|
|
||||||
}
|
|
||||||
compile.run_gyp(['configure'].concat(final_args), result.opts, (err4) => {
|
|
||||||
if (!err4 && result.opts.napi_build_version) {
|
|
||||||
napi.swap_build_dir_out(result.opts.napi_build_version);
|
|
||||||
}
|
|
||||||
return callback(err4);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
@ -1,38 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
module.exports = exports = info;
|
|
||||||
|
|
||||||
exports.usage = 'Lists all published binaries (requires aws-sdk)';
|
|
||||||
|
|
||||||
const log = require('npmlog');
|
|
||||||
const versioning = require('./util/versioning.js');
|
|
||||||
const s3_setup = require('./util/s3_setup.js');
|
|
||||||
|
|
||||||
function info(gyp, argv, callback) {
|
|
||||||
const package_json = gyp.package_json;
|
|
||||||
const opts = versioning.evaluate(package_json, gyp.opts);
|
|
||||||
const config = {};
|
|
||||||
s3_setup.detect(opts, config);
|
|
||||||
const s3 = s3_setup.get_s3(config);
|
|
||||||
const s3_opts = {
|
|
||||||
Bucket: config.bucket,
|
|
||||||
Prefix: config.prefix
|
|
||||||
};
|
|
||||||
s3.listObjects(s3_opts, (err, meta) => {
|
|
||||||
if (err && err.code === 'NotFound') {
|
|
||||||
return callback(new Error('[' + package_json.name + '] Not found: https://' + s3_opts.Bucket + '.s3.amazonaws.com/' + config.prefix));
|
|
||||||
} else if (err) {
|
|
||||||
return callback(err);
|
|
||||||
} else {
|
|
||||||
log.verbose(JSON.stringify(meta, null, 1));
|
|
||||||
if (meta && meta.Contents) {
|
|
||||||
meta.Contents.forEach((obj) => {
|
|
||||||
console.log(obj.Key);
|
|
||||||
});
|
|
||||||
} else {
|
|
||||||
console.error('[' + package_json.name + '] No objects found at https://' + s3_opts.Bucket + '.s3.amazonaws.com/' + config.prefix);
|
|
||||||
}
|
|
||||||
return callback();
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
@ -1,235 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
module.exports = exports = install;
|
|
||||||
|
|
||||||
exports.usage = 'Attempts to install pre-built binary for module';
|
|
||||||
|
|
||||||
const fs = require('fs');
|
|
||||||
const path = require('path');
|
|
||||||
const log = require('npmlog');
|
|
||||||
const existsAsync = fs.exists || path.exists;
|
|
||||||
const versioning = require('./util/versioning.js');
|
|
||||||
const napi = require('./util/napi.js');
|
|
||||||
const makeDir = require('make-dir');
|
|
||||||
// for fetching binaries
|
|
||||||
const fetch = require('node-fetch');
|
|
||||||
const tar = require('tar');
|
|
||||||
|
|
||||||
let npgVersion = 'unknown';
|
|
||||||
try {
|
|
||||||
// Read own package.json to get the current node-pre-pyp version.
|
|
||||||
const ownPackageJSON = fs.readFileSync(path.join(__dirname, '..', 'package.json'), 'utf8');
|
|
||||||
npgVersion = JSON.parse(ownPackageJSON).version;
|
|
||||||
} catch (e) {
|
|
||||||
// do nothing
|
|
||||||
}
|
|
||||||
|
|
||||||
function place_binary(uri, targetDir, opts, callback) {
|
|
||||||
log.http('GET', uri);
|
|
||||||
|
|
||||||
// Try getting version info from the currently running npm.
|
|
||||||
const envVersionInfo = process.env.npm_config_user_agent ||
|
|
||||||
'node ' + process.version;
|
|
||||||
|
|
||||||
const sanitized = uri.replace('+', '%2B');
|
|
||||||
const requestOpts = {
|
|
||||||
uri: sanitized,
|
|
||||||
headers: {
|
|
||||||
'User-Agent': 'node-pre-gyp (v' + npgVersion + ', ' + envVersionInfo + ')'
|
|
||||||
},
|
|
||||||
follow_max: 10
|
|
||||||
};
|
|
||||||
|
|
||||||
if (opts.cafile) {
|
|
||||||
try {
|
|
||||||
requestOpts.ca = fs.readFileSync(opts.cafile);
|
|
||||||
} catch (e) {
|
|
||||||
return callback(e);
|
|
||||||
}
|
|
||||||
} else if (opts.ca) {
|
|
||||||
requestOpts.ca = opts.ca;
|
|
||||||
}
|
|
||||||
|
|
||||||
const proxyUrl = opts.proxy ||
|
|
||||||
process.env.http_proxy ||
|
|
||||||
process.env.HTTP_PROXY ||
|
|
||||||
process.env.npm_config_proxy;
|
|
||||||
let agent;
|
|
||||||
if (proxyUrl) {
|
|
||||||
const ProxyAgent = require('https-proxy-agent');
|
|
||||||
agent = new ProxyAgent(proxyUrl);
|
|
||||||
log.http('download', 'proxy agent configured using: "%s"', proxyUrl);
|
|
||||||
}
|
|
||||||
|
|
||||||
fetch(sanitized, { agent })
|
|
||||||
.then((res) => {
|
|
||||||
if (!res.ok) {
|
|
||||||
throw new Error(`response status ${res.status} ${res.statusText} on ${sanitized}`);
|
|
||||||
}
|
|
||||||
const dataStream = res.body;
|
|
||||||
|
|
||||||
return new Promise((resolve, reject) => {
|
|
||||||
let extractions = 0;
|
|
||||||
const countExtractions = (entry) => {
|
|
||||||
extractions += 1;
|
|
||||||
log.info('install', 'unpacking %s', entry.path);
|
|
||||||
};
|
|
||||||
|
|
||||||
dataStream.pipe(extract(targetDir, countExtractions))
|
|
||||||
.on('error', (e) => {
|
|
||||||
reject(e);
|
|
||||||
});
|
|
||||||
dataStream.on('end', () => {
|
|
||||||
resolve(`extracted file count: ${extractions}`);
|
|
||||||
});
|
|
||||||
dataStream.on('error', (e) => {
|
|
||||||
reject(e);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
})
|
|
||||||
.then((text) => {
|
|
||||||
log.info(text);
|
|
||||||
callback();
|
|
||||||
})
|
|
||||||
.catch((e) => {
|
|
||||||
log.error(`install ${e.message}`);
|
|
||||||
callback(e);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
function extract(to, onentry) {
|
|
||||||
return tar.extract({
|
|
||||||
cwd: to,
|
|
||||||
strip: 1,
|
|
||||||
onentry
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
function extract_from_local(from, targetDir, callback) {
|
|
||||||
if (!fs.existsSync(from)) {
|
|
||||||
return callback(new Error('Cannot find file ' + from));
|
|
||||||
}
|
|
||||||
log.info('Found local file to extract from ' + from);
|
|
||||||
|
|
||||||
// extract helpers
|
|
||||||
let extractCount = 0;
|
|
||||||
function countExtractions(entry) {
|
|
||||||
extractCount += 1;
|
|
||||||
log.info('install', 'unpacking ' + entry.path);
|
|
||||||
}
|
|
||||||
function afterExtract(err) {
|
|
||||||
if (err) return callback(err);
|
|
||||||
if (extractCount === 0) {
|
|
||||||
return callback(new Error('There was a fatal problem while extracting the tarball'));
|
|
||||||
}
|
|
||||||
log.info('tarball', 'done parsing tarball');
|
|
||||||
callback();
|
|
||||||
}
|
|
||||||
|
|
||||||
fs.createReadStream(from).pipe(extract(targetDir, countExtractions))
|
|
||||||
.on('close', afterExtract)
|
|
||||||
.on('error', afterExtract);
|
|
||||||
}
|
|
||||||
|
|
||||||
function do_build(gyp, argv, callback) {
|
|
||||||
const args = ['rebuild'].concat(argv);
|
|
||||||
gyp.todo.push({ name: 'build', args: args });
|
|
||||||
process.nextTick(callback);
|
|
||||||
}
|
|
||||||
|
|
||||||
function print_fallback_error(err, opts, package_json) {
|
|
||||||
const fallback_message = ' (falling back to source compile with node-gyp)';
|
|
||||||
let full_message = '';
|
|
||||||
if (err.statusCode !== undefined) {
|
|
||||||
// If we got a network response it but failed to download
|
|
||||||
// it means remote binaries are not available, so let's try to help
|
|
||||||
// the user/developer with the info to debug why
|
|
||||||
full_message = 'Pre-built binaries not found for ' + package_json.name + '@' + package_json.version;
|
|
||||||
full_message += ' and ' + opts.runtime + '@' + (opts.target || process.versions.node) + ' (' + opts.node_abi + ' ABI, ' + opts.libc + ')';
|
|
||||||
full_message += fallback_message;
|
|
||||||
log.warn('Tried to download(' + err.statusCode + '): ' + opts.hosted_tarball);
|
|
||||||
log.warn(full_message);
|
|
||||||
log.http(err.message);
|
|
||||||
} else {
|
|
||||||
// If we do not have a statusCode that means an unexpected error
|
|
||||||
// happened and prevented an http response, so we output the exact error
|
|
||||||
full_message = 'Pre-built binaries not installable for ' + package_json.name + '@' + package_json.version;
|
|
||||||
full_message += ' and ' + opts.runtime + '@' + (opts.target || process.versions.node) + ' (' + opts.node_abi + ' ABI, ' + opts.libc + ')';
|
|
||||||
full_message += fallback_message;
|
|
||||||
log.warn(full_message);
|
|
||||||
log.warn('Hit error ' + err.message);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
//
|
|
||||||
// install
|
|
||||||
//
|
|
||||||
function install(gyp, argv, callback) {
|
|
||||||
const package_json = gyp.package_json;
|
|
||||||
const napi_build_version = napi.get_napi_build_version_from_command_args(argv);
|
|
||||||
const source_build = gyp.opts['build-from-source'] || gyp.opts.build_from_source;
|
|
||||||
const update_binary = gyp.opts['update-binary'] || gyp.opts.update_binary;
|
|
||||||
const should_do_source_build = source_build === package_json.name || (source_build === true || source_build === 'true');
|
|
||||||
if (should_do_source_build) {
|
|
||||||
log.info('build', 'requesting source compile');
|
|
||||||
return do_build(gyp, argv, callback);
|
|
||||||
} else {
|
|
||||||
const fallback_to_build = gyp.opts['fallback-to-build'] || gyp.opts.fallback_to_build;
|
|
||||||
let should_do_fallback_build = fallback_to_build === package_json.name || (fallback_to_build === true || fallback_to_build === 'true');
|
|
||||||
// but allow override from npm
|
|
||||||
if (process.env.npm_config_argv) {
|
|
||||||
const cooked = JSON.parse(process.env.npm_config_argv).cooked;
|
|
||||||
const match = cooked.indexOf('--fallback-to-build');
|
|
||||||
if (match > -1 && cooked.length > match && cooked[match + 1] === 'false') {
|
|
||||||
should_do_fallback_build = false;
|
|
||||||
log.info('install', 'Build fallback disabled via npm flag: --fallback-to-build=false');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
let opts;
|
|
||||||
try {
|
|
||||||
opts = versioning.evaluate(package_json, gyp.opts, napi_build_version);
|
|
||||||
} catch (err) {
|
|
||||||
return callback(err);
|
|
||||||
}
|
|
||||||
|
|
||||||
opts.ca = gyp.opts.ca;
|
|
||||||
opts.cafile = gyp.opts.cafile;
|
|
||||||
|
|
||||||
const from = opts.hosted_tarball;
|
|
||||||
const to = opts.module_path;
|
|
||||||
const binary_module = path.join(to, opts.module_name + '.node');
|
|
||||||
existsAsync(binary_module, (found) => {
|
|
||||||
if (!update_binary) {
|
|
||||||
if (found) {
|
|
||||||
console.log('[' + package_json.name + '] Success: "' + binary_module + '" already installed');
|
|
||||||
console.log('Pass --update-binary to reinstall or --build-from-source to recompile');
|
|
||||||
return callback();
|
|
||||||
}
|
|
||||||
log.info('check', 'checked for "' + binary_module + '" (not found)');
|
|
||||||
}
|
|
||||||
|
|
||||||
makeDir(to).then(() => {
|
|
||||||
const fileName = from.startsWith('file://') && from.slice('file://'.length);
|
|
||||||
if (fileName) {
|
|
||||||
extract_from_local(fileName, to, after_place);
|
|
||||||
} else {
|
|
||||||
place_binary(from, to, opts, after_place);
|
|
||||||
}
|
|
||||||
}).catch((err) => {
|
|
||||||
after_place(err);
|
|
||||||
});
|
|
||||||
|
|
||||||
function after_place(err) {
|
|
||||||
if (err && should_do_fallback_build) {
|
|
||||||
print_fallback_error(err, opts, package_json);
|
|
||||||
return do_build(gyp, argv, callback);
|
|
||||||
} else if (err) {
|
|
||||||
return callback(err);
|
|
||||||
} else {
|
|
||||||
console.log('[' + package_json.name + '] Success: "' + binary_module + '" is installed via remote');
|
|
||||||
return callback();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,125 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set the title.
|
|
||||||
*/
|
|
||||||
|
|
||||||
process.title = 'node-pre-gyp';
|
|
||||||
|
|
||||||
const node_pre_gyp = require('../');
|
|
||||||
const log = require('npmlog');
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Process and execute the selected commands.
|
|
||||||
*/
|
|
||||||
|
|
||||||
const prog = new node_pre_gyp.Run({ argv: process.argv });
|
|
||||||
let completed = false;
|
|
||||||
|
|
||||||
if (prog.todo.length === 0) {
|
|
||||||
if (~process.argv.indexOf('-v') || ~process.argv.indexOf('--version')) {
|
|
||||||
console.log('v%s', prog.version);
|
|
||||||
process.exit(0);
|
|
||||||
} else if (~process.argv.indexOf('-h') || ~process.argv.indexOf('--help')) {
|
|
||||||
console.log('%s', prog.usage());
|
|
||||||
process.exit(0);
|
|
||||||
}
|
|
||||||
console.log('%s', prog.usage());
|
|
||||||
process.exit(1);
|
|
||||||
}
|
|
||||||
|
|
||||||
// if --no-color is passed
|
|
||||||
if (prog.opts && Object.hasOwnProperty.call(prog, 'color') && !prog.opts.color) {
|
|
||||||
log.disableColor();
|
|
||||||
}
|
|
||||||
|
|
||||||
log.info('it worked if it ends with', 'ok');
|
|
||||||
log.verbose('cli', process.argv);
|
|
||||||
log.info('using', process.title + '@%s', prog.version);
|
|
||||||
log.info('using', 'node@%s | %s | %s', process.versions.node, process.platform, process.arch);
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Change dir if -C/--directory was passed.
|
|
||||||
*/
|
|
||||||
|
|
||||||
const dir = prog.opts.directory;
|
|
||||||
if (dir) {
|
|
||||||
const fs = require('fs');
|
|
||||||
try {
|
|
||||||
const stat = fs.statSync(dir);
|
|
||||||
if (stat.isDirectory()) {
|
|
||||||
log.info('chdir', dir);
|
|
||||||
process.chdir(dir);
|
|
||||||
} else {
|
|
||||||
log.warn('chdir', dir + ' is not a directory');
|
|
||||||
}
|
|
||||||
} catch (e) {
|
|
||||||
if (e.code === 'ENOENT') {
|
|
||||||
log.warn('chdir', dir + ' is not a directory');
|
|
||||||
} else {
|
|
||||||
log.warn('chdir', 'error during chdir() "%s"', e.message);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function run() {
|
|
||||||
const command = prog.todo.shift();
|
|
||||||
if (!command) {
|
|
||||||
// done!
|
|
||||||
completed = true;
|
|
||||||
log.info('ok');
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// set binary.host when appropriate. host determines the s3 target bucket.
|
|
||||||
const target = prog.setBinaryHostProperty(command.name);
|
|
||||||
if (target && ['install', 'publish', 'unpublish', 'info'].indexOf(command.name) >= 0) {
|
|
||||||
log.info('using binary.host: ' + prog.package_json.binary.host);
|
|
||||||
}
|
|
||||||
|
|
||||||
prog.commands[command.name](command.args, function(err) {
|
|
||||||
if (err) {
|
|
||||||
log.error(command.name + ' error');
|
|
||||||
log.error('stack', err.stack);
|
|
||||||
errorMessage();
|
|
||||||
log.error('not ok');
|
|
||||||
console.log(err.message);
|
|
||||||
return process.exit(1);
|
|
||||||
}
|
|
||||||
const args_array = [].slice.call(arguments, 1);
|
|
||||||
if (args_array.length) {
|
|
||||||
console.log.apply(console, args_array);
|
|
||||||
}
|
|
||||||
// now run the next command in the queue
|
|
||||||
process.nextTick(run);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
process.on('exit', (code) => {
|
|
||||||
if (!completed && !code) {
|
|
||||||
log.error('Completion callback never invoked!');
|
|
||||||
errorMessage();
|
|
||||||
process.exit(6);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
process.on('uncaughtException', (err) => {
|
|
||||||
log.error('UNCAUGHT EXCEPTION');
|
|
||||||
log.error('stack', err.stack);
|
|
||||||
errorMessage();
|
|
||||||
process.exit(7);
|
|
||||||
});
|
|
||||||
|
|
||||||
function errorMessage() {
|
|
||||||
// copied from npm's lib/util/error-handler.js
|
|
||||||
const os = require('os');
|
|
||||||
log.error('System', os.type() + ' ' + os.release());
|
|
||||||
log.error('command', process.argv.map(JSON.stringify).join(' '));
|
|
||||||
log.error('cwd', process.cwd());
|
|
||||||
log.error('node -v', process.version);
|
|
||||||
log.error(process.title + ' -v', 'v' + prog.package.version);
|
|
||||||
}
|
|
||||||
|
|
||||||
// start running the given commands!
|
|
||||||
run();
|
|
||||||
@ -1,309 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Module exports.
|
|
||||||
*/
|
|
||||||
|
|
||||||
module.exports = exports;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Module dependencies.
|
|
||||||
*/
|
|
||||||
|
|
||||||
// load mocking control function for accessing s3 via https. the function is a noop always returning
|
|
||||||
// false if not mocking.
|
|
||||||
exports.mockS3Http = require('./util/s3_setup').get_mockS3Http();
|
|
||||||
exports.mockS3Http('on');
|
|
||||||
const mocking = exports.mockS3Http('get');
|
|
||||||
|
|
||||||
|
|
||||||
const fs = require('fs');
|
|
||||||
const path = require('path');
|
|
||||||
const nopt = require('nopt');
|
|
||||||
const log = require('npmlog');
|
|
||||||
log.disableProgress();
|
|
||||||
const napi = require('./util/napi.js');
|
|
||||||
|
|
||||||
const EE = require('events').EventEmitter;
|
|
||||||
const inherits = require('util').inherits;
|
|
||||||
const cli_commands = [
|
|
||||||
'clean',
|
|
||||||
'install',
|
|
||||||
'reinstall',
|
|
||||||
'build',
|
|
||||||
'rebuild',
|
|
||||||
'package',
|
|
||||||
'testpackage',
|
|
||||||
'publish',
|
|
||||||
'unpublish',
|
|
||||||
'info',
|
|
||||||
'testbinary',
|
|
||||||
'reveal',
|
|
||||||
'configure'
|
|
||||||
];
|
|
||||||
const aliases = {};
|
|
||||||
|
|
||||||
// differentiate node-pre-gyp's logs from npm's
|
|
||||||
log.heading = 'node-pre-gyp';
|
|
||||||
|
|
||||||
if (mocking) {
|
|
||||||
log.warn(`mocking s3 to ${process.env.node_pre_gyp_mock_s3}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
// this is a getter to avoid circular reference warnings with node v14.
|
|
||||||
Object.defineProperty(exports, 'find', {
|
|
||||||
get: function() {
|
|
||||||
return require('./pre-binding').find;
|
|
||||||
},
|
|
||||||
enumerable: true
|
|
||||||
});
|
|
||||||
|
|
||||||
// in the following, "my_module" is using node-pre-gyp to
|
|
||||||
// prebuild and install pre-built binaries. "main_module"
|
|
||||||
// is using "my_module".
|
|
||||||
//
|
|
||||||
// "bin/node-pre-gyp" invokes Run() without a path. the
|
|
||||||
// expectation is that the working directory is the package
|
|
||||||
// root "my_module". this is true because in all cases npm is
|
|
||||||
// executing a script in the context of "my_module".
|
|
||||||
//
|
|
||||||
// "pre-binding.find()" is executed by "my_module" but in the
|
|
||||||
// context of "main_module". this is because "main_module" is
|
|
||||||
// executing and requires "my_module" which is then executing
|
|
||||||
// "pre-binding.find()" via "node-pre-gyp.find()", so the working
|
|
||||||
// directory is that of "main_module".
|
|
||||||
//
|
|
||||||
// that's why "find()" must pass the path to package.json.
|
|
||||||
//
|
|
||||||
function Run({ package_json_path = './package.json', argv }) {
|
|
||||||
this.package_json_path = package_json_path;
|
|
||||||
this.commands = {};
|
|
||||||
|
|
||||||
const self = this;
|
|
||||||
cli_commands.forEach((command) => {
|
|
||||||
self.commands[command] = function(argvx, callback) {
|
|
||||||
log.verbose('command', command, argvx);
|
|
||||||
return require('./' + command)(self, argvx, callback);
|
|
||||||
};
|
|
||||||
});
|
|
||||||
|
|
||||||
this.parseArgv(argv);
|
|
||||||
|
|
||||||
// this is set to true after the binary.host property was set to
|
|
||||||
// either staging_host or production_host.
|
|
||||||
this.binaryHostSet = false;
|
|
||||||
}
|
|
||||||
inherits(Run, EE);
|
|
||||||
exports.Run = Run;
|
|
||||||
const proto = Run.prototype;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Export the contents of the package.json.
|
|
||||||
*/
|
|
||||||
|
|
||||||
proto.package = require('../package.json');
|
|
||||||
|
|
||||||
/**
|
|
||||||
* nopt configuration definitions
|
|
||||||
*/
|
|
||||||
|
|
||||||
proto.configDefs = {
|
|
||||||
help: Boolean, // everywhere
|
|
||||||
arch: String, // 'configure'
|
|
||||||
debug: Boolean, // 'build'
|
|
||||||
directory: String, // bin
|
|
||||||
proxy: String, // 'install'
|
|
||||||
loglevel: String // everywhere
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* nopt shorthands
|
|
||||||
*/
|
|
||||||
|
|
||||||
proto.shorthands = {
|
|
||||||
release: '--no-debug',
|
|
||||||
C: '--directory',
|
|
||||||
debug: '--debug',
|
|
||||||
j: '--jobs',
|
|
||||||
silent: '--loglevel=silent',
|
|
||||||
silly: '--loglevel=silly',
|
|
||||||
verbose: '--loglevel=verbose'
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* expose the command aliases for the bin file to use.
|
|
||||||
*/
|
|
||||||
|
|
||||||
proto.aliases = aliases;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Parses the given argv array and sets the 'opts', 'argv',
|
|
||||||
* 'command', and 'package_json' properties.
|
|
||||||
*/
|
|
||||||
|
|
||||||
proto.parseArgv = function parseOpts(argv) {
|
|
||||||
this.opts = nopt(this.configDefs, this.shorthands, argv);
|
|
||||||
this.argv = this.opts.argv.remain.slice();
|
|
||||||
const commands = this.todo = [];
|
|
||||||
|
|
||||||
// create a copy of the argv array with aliases mapped
|
|
||||||
argv = this.argv.map((arg) => {
|
|
||||||
// is this an alias?
|
|
||||||
if (arg in this.aliases) {
|
|
||||||
arg = this.aliases[arg];
|
|
||||||
}
|
|
||||||
return arg;
|
|
||||||
});
|
|
||||||
|
|
||||||
// process the mapped args into "command" objects ("name" and "args" props)
|
|
||||||
argv.slice().forEach((arg) => {
|
|
||||||
if (arg in this.commands) {
|
|
||||||
const args = argv.splice(0, argv.indexOf(arg));
|
|
||||||
argv.shift();
|
|
||||||
if (commands.length > 0) {
|
|
||||||
commands[commands.length - 1].args = args;
|
|
||||||
}
|
|
||||||
commands.push({ name: arg, args: [] });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
if (commands.length > 0) {
|
|
||||||
commands[commands.length - 1].args = argv.splice(0);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// if a directory was specified package.json is assumed to be relative
|
|
||||||
// to it.
|
|
||||||
let package_json_path = this.package_json_path;
|
|
||||||
if (this.opts.directory) {
|
|
||||||
package_json_path = path.join(this.opts.directory, package_json_path);
|
|
||||||
}
|
|
||||||
|
|
||||||
this.package_json = JSON.parse(fs.readFileSync(package_json_path));
|
|
||||||
|
|
||||||
// expand commands entries for multiple napi builds
|
|
||||||
this.todo = napi.expand_commands(this.package_json, this.opts, commands);
|
|
||||||
|
|
||||||
// support for inheriting config env variables from npm
|
|
||||||
const npm_config_prefix = 'npm_config_';
|
|
||||||
Object.keys(process.env).forEach((name) => {
|
|
||||||
if (name.indexOf(npm_config_prefix) !== 0) return;
|
|
||||||
const val = process.env[name];
|
|
||||||
if (name === npm_config_prefix + 'loglevel') {
|
|
||||||
log.level = val;
|
|
||||||
} else {
|
|
||||||
// add the user-defined options to the config
|
|
||||||
name = name.substring(npm_config_prefix.length);
|
|
||||||
// avoid npm argv clobber already present args
|
|
||||||
// which avoids problem of 'npm test' calling
|
|
||||||
// script that runs unique npm install commands
|
|
||||||
if (name === 'argv') {
|
|
||||||
if (this.opts.argv &&
|
|
||||||
this.opts.argv.remain &&
|
|
||||||
this.opts.argv.remain.length) {
|
|
||||||
// do nothing
|
|
||||||
} else {
|
|
||||||
this.opts[name] = val;
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
this.opts[name] = val;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
if (this.opts.loglevel) {
|
|
||||||
log.level = this.opts.loglevel;
|
|
||||||
}
|
|
||||||
log.resume();
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* allow the binary.host property to be set at execution time.
|
|
||||||
*
|
|
||||||
* for this to take effect requires all the following to be true.
|
|
||||||
* - binary is a property in package.json
|
|
||||||
* - binary.host is falsey
|
|
||||||
* - binary.staging_host is not empty
|
|
||||||
* - binary.production_host is not empty
|
|
||||||
*
|
|
||||||
* if any of the previous checks fail then the function returns an empty string
|
|
||||||
* and makes no changes to package.json's binary property.
|
|
||||||
*
|
|
||||||
*
|
|
||||||
* if command is "publish" then the default is set to "binary.staging_host"
|
|
||||||
* if command is not "publish" the the default is set to "binary.production_host"
|
|
||||||
*
|
|
||||||
* if the command-line option '--s3_host' is set to "staging" or "production" then
|
|
||||||
* "binary.host" is set to the specified "staging_host" or "production_host". if
|
|
||||||
* '--s3_host' is any other value an exception is thrown.
|
|
||||||
*
|
|
||||||
* if '--s3_host' is not present then "binary.host" is set to the default as above.
|
|
||||||
*
|
|
||||||
* this strategy was chosen so that any command other than "publish" or "unpublish" uses "production"
|
|
||||||
* as the default without requiring any command-line options but that "publish" and "unpublish" require
|
|
||||||
* '--s3_host production_host' to be specified in order to *really* publish (or unpublish). publishing
|
|
||||||
* to staging can be done freely without worrying about disturbing any production releases.
|
|
||||||
*/
|
|
||||||
proto.setBinaryHostProperty = function(command) {
|
|
||||||
if (this.binaryHostSet) {
|
|
||||||
return this.package_json.binary.host;
|
|
||||||
}
|
|
||||||
const p = this.package_json;
|
|
||||||
// don't set anything if host is present. it must be left blank to trigger this.
|
|
||||||
if (!p || !p.binary || p.binary.host) {
|
|
||||||
return '';
|
|
||||||
}
|
|
||||||
// and both staging and production must be present. errors will be reported later.
|
|
||||||
if (!p.binary.staging_host || !p.binary.production_host) {
|
|
||||||
return '';
|
|
||||||
}
|
|
||||||
let target = 'production_host';
|
|
||||||
if (command === 'publish' || command === 'unpublish') {
|
|
||||||
target = 'staging_host';
|
|
||||||
}
|
|
||||||
// the environment variable has priority over the default or the command line. if
|
|
||||||
// either the env var or the command line option are invalid throw an error.
|
|
||||||
const npg_s3_host = process.env.node_pre_gyp_s3_host;
|
|
||||||
if (npg_s3_host === 'staging' || npg_s3_host === 'production') {
|
|
||||||
target = `${npg_s3_host}_host`;
|
|
||||||
} else if (this.opts['s3_host'] === 'staging' || this.opts['s3_host'] === 'production') {
|
|
||||||
target = `${this.opts['s3_host']}_host`;
|
|
||||||
} else if (this.opts['s3_host'] || npg_s3_host) {
|
|
||||||
throw new Error(`invalid s3_host ${this.opts['s3_host'] || npg_s3_host}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
p.binary.host = p.binary[target];
|
|
||||||
this.binaryHostSet = true;
|
|
||||||
|
|
||||||
return p.binary.host;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the usage instructions for node-pre-gyp.
|
|
||||||
*/
|
|
||||||
|
|
||||||
proto.usage = function usage() {
|
|
||||||
const str = [
|
|
||||||
'',
|
|
||||||
' Usage: node-pre-gyp <command> [options]',
|
|
||||||
'',
|
|
||||||
' where <command> is one of:',
|
|
||||||
cli_commands.map((c) => {
|
|
||||||
return ' - ' + c + ' - ' + require('./' + c).usage;
|
|
||||||
}).join('\n'),
|
|
||||||
'',
|
|
||||||
'node-pre-gyp@' + this.version + ' ' + path.resolve(__dirname, '..'),
|
|
||||||
'node@' + process.versions.node
|
|
||||||
].join('\n');
|
|
||||||
return str;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Version number getter.
|
|
||||||
*/
|
|
||||||
|
|
||||||
Object.defineProperty(proto, 'version', {
|
|
||||||
get: function() {
|
|
||||||
return this.package.version;
|
|
||||||
},
|
|
||||||
enumerable: true
|
|
||||||
});
|
|
||||||
@ -1,73 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
module.exports = exports = _package;
|
|
||||||
|
|
||||||
exports.usage = 'Packs binary (and enclosing directory) into locally staged tarball';
|
|
||||||
|
|
||||||
const fs = require('fs');
|
|
||||||
const path = require('path');
|
|
||||||
const log = require('npmlog');
|
|
||||||
const versioning = require('./util/versioning.js');
|
|
||||||
const napi = require('./util/napi.js');
|
|
||||||
const existsAsync = fs.exists || path.exists;
|
|
||||||
const makeDir = require('make-dir');
|
|
||||||
const tar = require('tar');
|
|
||||||
|
|
||||||
function readdirSync(dir) {
|
|
||||||
let list = [];
|
|
||||||
const files = fs.readdirSync(dir);
|
|
||||||
|
|
||||||
files.forEach((file) => {
|
|
||||||
const stats = fs.lstatSync(path.join(dir, file));
|
|
||||||
if (stats.isDirectory()) {
|
|
||||||
list = list.concat(readdirSync(path.join(dir, file)));
|
|
||||||
} else {
|
|
||||||
list.push(path.join(dir, file));
|
|
||||||
}
|
|
||||||
});
|
|
||||||
return list;
|
|
||||||
}
|
|
||||||
|
|
||||||
function _package(gyp, argv, callback) {
|
|
||||||
const package_json = gyp.package_json;
|
|
||||||
const napi_build_version = napi.get_napi_build_version_from_command_args(argv);
|
|
||||||
const opts = versioning.evaluate(package_json, gyp.opts, napi_build_version);
|
|
||||||
const from = opts.module_path;
|
|
||||||
const binary_module = path.join(from, opts.module_name + '.node');
|
|
||||||
existsAsync(binary_module, (found) => {
|
|
||||||
if (!found) {
|
|
||||||
return callback(new Error('Cannot package because ' + binary_module + ' missing: run `node-pre-gyp rebuild` first'));
|
|
||||||
}
|
|
||||||
const tarball = opts.staged_tarball;
|
|
||||||
const filter_func = function(entry) {
|
|
||||||
const basename = path.basename(entry);
|
|
||||||
if (basename.length && basename[0] !== '.') {
|
|
||||||
console.log('packing ' + entry);
|
|
||||||
return true;
|
|
||||||
} else {
|
|
||||||
console.log('skipping ' + entry);
|
|
||||||
}
|
|
||||||
return false;
|
|
||||||
};
|
|
||||||
makeDir(path.dirname(tarball)).then(() => {
|
|
||||||
let files = readdirSync(from);
|
|
||||||
const base = path.basename(from);
|
|
||||||
files = files.map((file) => {
|
|
||||||
return path.join(base, path.relative(from, file));
|
|
||||||
});
|
|
||||||
tar.create({
|
|
||||||
portable: false,
|
|
||||||
gzip: true,
|
|
||||||
filter: filter_func,
|
|
||||||
file: tarball,
|
|
||||||
cwd: path.dirname(from)
|
|
||||||
}, files, (err2) => {
|
|
||||||
if (err2) console.error('[' + package_json.name + '] ' + err2.message);
|
|
||||||
else log.info('package', 'Binary staged at "' + tarball + '"');
|
|
||||||
return callback(err2);
|
|
||||||
});
|
|
||||||
}).catch((err) => {
|
|
||||||
return callback(err);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
}
|
|
||||||
@ -1,34 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
const npg = require('..');
|
|
||||||
const versioning = require('../lib/util/versioning.js');
|
|
||||||
const napi = require('../lib/util/napi.js');
|
|
||||||
const existsSync = require('fs').existsSync || require('path').existsSync;
|
|
||||||
const path = require('path');
|
|
||||||
|
|
||||||
module.exports = exports;
|
|
||||||
|
|
||||||
exports.usage = 'Finds the require path for the node-pre-gyp installed module';
|
|
||||||
|
|
||||||
exports.validate = function(package_json, opts) {
|
|
||||||
versioning.validate_config(package_json, opts);
|
|
||||||
};
|
|
||||||
|
|
||||||
exports.find = function(package_json_path, opts) {
|
|
||||||
if (!existsSync(package_json_path)) {
|
|
||||||
throw new Error(package_json_path + 'does not exist');
|
|
||||||
}
|
|
||||||
const prog = new npg.Run({ package_json_path, argv: process.argv });
|
|
||||||
prog.setBinaryHostProperty();
|
|
||||||
const package_json = prog.package_json;
|
|
||||||
|
|
||||||
versioning.validate_config(package_json, opts);
|
|
||||||
let napi_build_version;
|
|
||||||
if (napi.get_napi_build_versions(package_json, opts)) {
|
|
||||||
napi_build_version = napi.get_best_napi_build_version(package_json, opts);
|
|
||||||
}
|
|
||||||
opts = opts || {};
|
|
||||||
if (!opts.module_root) opts.module_root = path.dirname(package_json_path);
|
|
||||||
const meta = versioning.evaluate(package_json, opts, napi_build_version);
|
|
||||||
return meta.module;
|
|
||||||
};
|
|
||||||
@ -1,81 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
module.exports = exports = publish;
|
|
||||||
|
|
||||||
exports.usage = 'Publishes pre-built binary (requires aws-sdk)';
|
|
||||||
|
|
||||||
const fs = require('fs');
|
|
||||||
const path = require('path');
|
|
||||||
const log = require('npmlog');
|
|
||||||
const versioning = require('./util/versioning.js');
|
|
||||||
const napi = require('./util/napi.js');
|
|
||||||
const s3_setup = require('./util/s3_setup.js');
|
|
||||||
const existsAsync = fs.exists || path.exists;
|
|
||||||
const url = require('url');
|
|
||||||
|
|
||||||
function publish(gyp, argv, callback) {
|
|
||||||
const package_json = gyp.package_json;
|
|
||||||
const napi_build_version = napi.get_napi_build_version_from_command_args(argv);
|
|
||||||
const opts = versioning.evaluate(package_json, gyp.opts, napi_build_version);
|
|
||||||
const tarball = opts.staged_tarball;
|
|
||||||
existsAsync(tarball, (found) => {
|
|
||||||
if (!found) {
|
|
||||||
return callback(new Error('Cannot publish because ' + tarball + ' missing: run `node-pre-gyp package` first'));
|
|
||||||
}
|
|
||||||
|
|
||||||
log.info('publish', 'Detecting s3 credentials');
|
|
||||||
const config = {};
|
|
||||||
s3_setup.detect(opts, config);
|
|
||||||
const s3 = s3_setup.get_s3(config);
|
|
||||||
|
|
||||||
const key_name = url.resolve(config.prefix, opts.package_name);
|
|
||||||
const s3_opts = {
|
|
||||||
Bucket: config.bucket,
|
|
||||||
Key: key_name
|
|
||||||
};
|
|
||||||
log.info('publish', 'Authenticating with s3');
|
|
||||||
log.info('publish', config);
|
|
||||||
|
|
||||||
log.info('publish', 'Checking for existing binary at ' + opts.hosted_path);
|
|
||||||
s3.headObject(s3_opts, (err, meta) => {
|
|
||||||
if (meta) log.info('publish', JSON.stringify(meta));
|
|
||||||
if (err && err.code === 'NotFound') {
|
|
||||||
// we are safe to publish because
|
|
||||||
// the object does not already exist
|
|
||||||
log.info('publish', 'Preparing to put object');
|
|
||||||
const s3_put_opts = {
|
|
||||||
ACL: 'public-read',
|
|
||||||
Body: fs.createReadStream(tarball),
|
|
||||||
Key: key_name,
|
|
||||||
Bucket: config.bucket
|
|
||||||
};
|
|
||||||
log.info('publish', 'Putting object', s3_put_opts.ACL, s3_put_opts.Bucket, s3_put_opts.Key);
|
|
||||||
try {
|
|
||||||
s3.putObject(s3_put_opts, (err2, resp) => {
|
|
||||||
log.info('publish', 'returned from putting object');
|
|
||||||
if (err2) {
|
|
||||||
log.info('publish', 's3 putObject error: "' + err2 + '"');
|
|
||||||
return callback(err2);
|
|
||||||
}
|
|
||||||
if (resp) log.info('publish', 's3 putObject response: "' + JSON.stringify(resp) + '"');
|
|
||||||
log.info('publish', 'successfully put object');
|
|
||||||
console.log('[' + package_json.name + '] published to ' + opts.hosted_path);
|
|
||||||
return callback();
|
|
||||||
});
|
|
||||||
} catch (err3) {
|
|
||||||
log.info('publish', 's3 putObject error: "' + err3 + '"');
|
|
||||||
return callback(err3);
|
|
||||||
}
|
|
||||||
} else if (err) {
|
|
||||||
log.info('publish', 's3 headObject error: "' + err + '"');
|
|
||||||
return callback(err);
|
|
||||||
} else {
|
|
||||||
log.error('publish', 'Cannot publish over existing version');
|
|
||||||
log.error('publish', "Update the 'version' field in package.json and try again");
|
|
||||||
log.error('publish', 'If the previous version was published in error see:');
|
|
||||||
log.error('publish', '\t node-pre-gyp unpublish');
|
|
||||||
return callback(new Error('Failed publishing to ' + opts.hosted_path));
|
|
||||||
}
|
|
||||||
});
|
|
||||||
});
|
|
||||||
}
|
|
||||||
@ -1,20 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
module.exports = exports = rebuild;
|
|
||||||
|
|
||||||
exports.usage = 'Runs "clean" and "build" at once';
|
|
||||||
|
|
||||||
const napi = require('./util/napi.js');
|
|
||||||
|
|
||||||
function rebuild(gyp, argv, callback) {
|
|
||||||
const package_json = gyp.package_json;
|
|
||||||
let commands = [
|
|
||||||
{ name: 'clean', args: [] },
|
|
||||||
{ name: 'build', args: ['rebuild'] }
|
|
||||||
];
|
|
||||||
commands = napi.expand_commands(package_json, gyp.opts, commands);
|
|
||||||
for (let i = commands.length; i !== 0; i--) {
|
|
||||||
gyp.todo.unshift(commands[i - 1]);
|
|
||||||
}
|
|
||||||
process.nextTick(callback);
|
|
||||||
}
|
|
||||||
@ -1,19 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
module.exports = exports = rebuild;
|
|
||||||
|
|
||||||
exports.usage = 'Runs "clean" and "install" at once';
|
|
||||||
|
|
||||||
const napi = require('./util/napi.js');
|
|
||||||
|
|
||||||
function rebuild(gyp, argv, callback) {
|
|
||||||
const package_json = gyp.package_json;
|
|
||||||
let installArgs = [];
|
|
||||||
const napi_build_version = napi.get_best_napi_build_version(package_json, gyp.opts);
|
|
||||||
if (napi_build_version != null) installArgs = [napi.get_command_arg(napi_build_version)];
|
|
||||||
gyp.todo.unshift(
|
|
||||||
{ name: 'clean', args: [] },
|
|
||||||
{ name: 'install', args: installArgs }
|
|
||||||
);
|
|
||||||
process.nextTick(callback);
|
|
||||||
}
|
|
||||||
@ -1,32 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
module.exports = exports = reveal;
|
|
||||||
|
|
||||||
exports.usage = 'Reveals data on the versioned binary';
|
|
||||||
|
|
||||||
const versioning = require('./util/versioning.js');
|
|
||||||
const napi = require('./util/napi.js');
|
|
||||||
|
|
||||||
function unix_paths(key, val) {
|
|
||||||
return val && val.replace ? val.replace(/\\/g, '/') : val;
|
|
||||||
}
|
|
||||||
|
|
||||||
function reveal(gyp, argv, callback) {
|
|
||||||
const package_json = gyp.package_json;
|
|
||||||
const napi_build_version = napi.get_napi_build_version_from_command_args(argv);
|
|
||||||
const opts = versioning.evaluate(package_json, gyp.opts, napi_build_version);
|
|
||||||
let hit = false;
|
|
||||||
// if a second arg is passed look to see
|
|
||||||
// if it is a known option
|
|
||||||
// console.log(JSON.stringify(gyp.opts,null,1))
|
|
||||||
const remain = gyp.opts.argv.remain[gyp.opts.argv.remain.length - 1];
|
|
||||||
if (remain && Object.hasOwnProperty.call(opts, remain)) {
|
|
||||||
console.log(opts[remain].replace(/\\/g, '/'));
|
|
||||||
hit = true;
|
|
||||||
}
|
|
||||||
// otherwise return all options as json
|
|
||||||
if (!hit) {
|
|
||||||
console.log(JSON.stringify(opts, unix_paths, 2));
|
|
||||||
}
|
|
||||||
return callback();
|
|
||||||
}
|
|
||||||
@ -1,79 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
module.exports = exports = testbinary;
|
|
||||||
|
|
||||||
exports.usage = 'Tests that the binary.node can be required';
|
|
||||||
|
|
||||||
const path = require('path');
|
|
||||||
const log = require('npmlog');
|
|
||||||
const cp = require('child_process');
|
|
||||||
const versioning = require('./util/versioning.js');
|
|
||||||
const napi = require('./util/napi.js');
|
|
||||||
|
|
||||||
function testbinary(gyp, argv, callback) {
|
|
||||||
const args = [];
|
|
||||||
const options = {};
|
|
||||||
let shell_cmd = process.execPath;
|
|
||||||
const package_json = gyp.package_json;
|
|
||||||
const napi_build_version = napi.get_napi_build_version_from_command_args(argv);
|
|
||||||
const opts = versioning.evaluate(package_json, gyp.opts, napi_build_version);
|
|
||||||
// skip validation for runtimes we don't explicitly support (like electron)
|
|
||||||
if (opts.runtime &&
|
|
||||||
opts.runtime !== 'node-webkit' &&
|
|
||||||
opts.runtime !== 'node') {
|
|
||||||
return callback();
|
|
||||||
}
|
|
||||||
const nw = (opts.runtime && opts.runtime === 'node-webkit');
|
|
||||||
// ensure on windows that / are used for require path
|
|
||||||
const binary_module = opts.module.replace(/\\/g, '/');
|
|
||||||
if ((process.arch !== opts.target_arch) ||
|
|
||||||
(process.platform !== opts.target_platform)) {
|
|
||||||
let msg = 'skipping validation since host platform/arch (';
|
|
||||||
msg += process.platform + '/' + process.arch + ')';
|
|
||||||
msg += ' does not match target (';
|
|
||||||
msg += opts.target_platform + '/' + opts.target_arch + ')';
|
|
||||||
log.info('validate', msg);
|
|
||||||
return callback();
|
|
||||||
}
|
|
||||||
if (nw) {
|
|
||||||
options.timeout = 5000;
|
|
||||||
if (process.platform === 'darwin') {
|
|
||||||
shell_cmd = 'node-webkit';
|
|
||||||
} else if (process.platform === 'win32') {
|
|
||||||
shell_cmd = 'nw.exe';
|
|
||||||
} else {
|
|
||||||
shell_cmd = 'nw';
|
|
||||||
}
|
|
||||||
const modulePath = path.resolve(binary_module);
|
|
||||||
const appDir = path.join(__dirname, 'util', 'nw-pre-gyp');
|
|
||||||
args.push(appDir);
|
|
||||||
args.push(modulePath);
|
|
||||||
log.info('validate', "Running test command: '" + shell_cmd + ' ' + args.join(' ') + "'");
|
|
||||||
cp.execFile(shell_cmd, args, options, (err, stdout, stderr) => {
|
|
||||||
// check for normal timeout for node-webkit
|
|
||||||
if (err) {
|
|
||||||
if (err.killed === true && err.signal && err.signal.indexOf('SIG') > -1) {
|
|
||||||
return callback();
|
|
||||||
}
|
|
||||||
const stderrLog = stderr.toString();
|
|
||||||
log.info('stderr', stderrLog);
|
|
||||||
if (/^\s*Xlib:\s*extension\s*"RANDR"\s*missing\s*on\s*display\s*":\d+\.\d+"\.\s*$/.test(stderrLog)) {
|
|
||||||
log.info('RANDR', 'stderr contains only RANDR error, ignored');
|
|
||||||
return callback();
|
|
||||||
}
|
|
||||||
return callback(err);
|
|
||||||
}
|
|
||||||
return callback();
|
|
||||||
});
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
args.push('--eval');
|
|
||||||
args.push("require('" + binary_module.replace(/'/g, '\'') + "')");
|
|
||||||
log.info('validate', "Running test command: '" + shell_cmd + ' ' + args.join(' ') + "'");
|
|
||||||
cp.execFile(shell_cmd, args, options, (err, stdout, stderr) => {
|
|
||||||
if (err) {
|
|
||||||
return callback(err, { stdout: stdout, stderr: stderr });
|
|
||||||
}
|
|
||||||
return callback();
|
|
||||||
});
|
|
||||||
}
|
|
||||||
@ -1,53 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
module.exports = exports = testpackage;
|
|
||||||
|
|
||||||
exports.usage = 'Tests that the staged package is valid';
|
|
||||||
|
|
||||||
const fs = require('fs');
|
|
||||||
const path = require('path');
|
|
||||||
const log = require('npmlog');
|
|
||||||
const existsAsync = fs.exists || path.exists;
|
|
||||||
const versioning = require('./util/versioning.js');
|
|
||||||
const napi = require('./util/napi.js');
|
|
||||||
const testbinary = require('./testbinary.js');
|
|
||||||
const tar = require('tar');
|
|
||||||
const makeDir = require('make-dir');
|
|
||||||
|
|
||||||
function testpackage(gyp, argv, callback) {
|
|
||||||
const package_json = gyp.package_json;
|
|
||||||
const napi_build_version = napi.get_napi_build_version_from_command_args(argv);
|
|
||||||
const opts = versioning.evaluate(package_json, gyp.opts, napi_build_version);
|
|
||||||
const tarball = opts.staged_tarball;
|
|
||||||
existsAsync(tarball, (found) => {
|
|
||||||
if (!found) {
|
|
||||||
return callback(new Error('Cannot test package because ' + tarball + ' missing: run `node-pre-gyp package` first'));
|
|
||||||
}
|
|
||||||
const to = opts.module_path;
|
|
||||||
function filter_func(entry) {
|
|
||||||
log.info('install', 'unpacking [' + entry.path + ']');
|
|
||||||
}
|
|
||||||
|
|
||||||
makeDir(to).then(() => {
|
|
||||||
tar.extract({
|
|
||||||
file: tarball,
|
|
||||||
cwd: to,
|
|
||||||
strip: 1,
|
|
||||||
onentry: filter_func
|
|
||||||
}).then(after_extract, callback);
|
|
||||||
}).catch((err) => {
|
|
||||||
return callback(err);
|
|
||||||
});
|
|
||||||
|
|
||||||
function after_extract() {
|
|
||||||
testbinary(gyp, argv, (err) => {
|
|
||||||
if (err) {
|
|
||||||
return callback(err);
|
|
||||||
} else {
|
|
||||||
console.log('[' + package_json.name + '] Package appears valid');
|
|
||||||
return callback();
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
@ -1,41 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
module.exports = exports = unpublish;
|
|
||||||
|
|
||||||
exports.usage = 'Unpublishes pre-built binary (requires aws-sdk)';
|
|
||||||
|
|
||||||
const log = require('npmlog');
|
|
||||||
const versioning = require('./util/versioning.js');
|
|
||||||
const napi = require('./util/napi.js');
|
|
||||||
const s3_setup = require('./util/s3_setup.js');
|
|
||||||
const url = require('url');
|
|
||||||
|
|
||||||
function unpublish(gyp, argv, callback) {
|
|
||||||
const package_json = gyp.package_json;
|
|
||||||
const napi_build_version = napi.get_napi_build_version_from_command_args(argv);
|
|
||||||
const opts = versioning.evaluate(package_json, gyp.opts, napi_build_version);
|
|
||||||
const config = {};
|
|
||||||
s3_setup.detect(opts, config);
|
|
||||||
const s3 = s3_setup.get_s3(config);
|
|
||||||
const key_name = url.resolve(config.prefix, opts.package_name);
|
|
||||||
const s3_opts = {
|
|
||||||
Bucket: config.bucket,
|
|
||||||
Key: key_name
|
|
||||||
};
|
|
||||||
s3.headObject(s3_opts, (err, meta) => {
|
|
||||||
if (err && err.code === 'NotFound') {
|
|
||||||
console.log('[' + package_json.name + '] Not found: https://' + s3_opts.Bucket + '.s3.amazonaws.com/' + s3_opts.Key);
|
|
||||||
return callback();
|
|
||||||
} else if (err) {
|
|
||||||
return callback(err);
|
|
||||||
} else {
|
|
||||||
log.info('unpublish', JSON.stringify(meta));
|
|
||||||
s3.deleteObject(s3_opts, (err2, resp) => {
|
|
||||||
if (err2) return callback(err2);
|
|
||||||
log.info(JSON.stringify(resp));
|
|
||||||
console.log('[' + package_json.name + '] Success: removed https://' + s3_opts.Bucket + '.s3.amazonaws.com/' + s3_opts.Key);
|
|
||||||
return callback();
|
|
||||||
});
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
File diff suppressed because it is too large
Load Diff
@ -1,93 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
module.exports = exports;
|
|
||||||
|
|
||||||
const fs = require('fs');
|
|
||||||
const path = require('path');
|
|
||||||
const win = process.platform === 'win32';
|
|
||||||
const existsSync = fs.existsSync || path.existsSync;
|
|
||||||
const cp = require('child_process');
|
|
||||||
|
|
||||||
// try to build up the complete path to node-gyp
|
|
||||||
/* priority:
|
|
||||||
- node-gyp on ENV:npm_config_node_gyp (https://github.com/npm/npm/pull/4887)
|
|
||||||
- node-gyp on NODE_PATH
|
|
||||||
- node-gyp inside npm on NODE_PATH (ignore on iojs)
|
|
||||||
- node-gyp inside npm beside node exe
|
|
||||||
*/
|
|
||||||
function which_node_gyp() {
|
|
||||||
let node_gyp_bin;
|
|
||||||
if (process.env.npm_config_node_gyp) {
|
|
||||||
try {
|
|
||||||
node_gyp_bin = process.env.npm_config_node_gyp;
|
|
||||||
if (existsSync(node_gyp_bin)) {
|
|
||||||
return node_gyp_bin;
|
|
||||||
}
|
|
||||||
} catch (err) {
|
|
||||||
// do nothing
|
|
||||||
}
|
|
||||||
}
|
|
||||||
try {
|
|
||||||
const node_gyp_main = require.resolve('node-gyp'); // eslint-disable-line node/no-missing-require
|
|
||||||
node_gyp_bin = path.join(path.dirname(
|
|
||||||
path.dirname(node_gyp_main)),
|
|
||||||
'bin/node-gyp.js');
|
|
||||||
if (existsSync(node_gyp_bin)) {
|
|
||||||
return node_gyp_bin;
|
|
||||||
}
|
|
||||||
} catch (err) {
|
|
||||||
// do nothing
|
|
||||||
}
|
|
||||||
if (process.execPath.indexOf('iojs') === -1) {
|
|
||||||
try {
|
|
||||||
const npm_main = require.resolve('npm'); // eslint-disable-line node/no-missing-require
|
|
||||||
node_gyp_bin = path.join(path.dirname(
|
|
||||||
path.dirname(npm_main)),
|
|
||||||
'node_modules/node-gyp/bin/node-gyp.js');
|
|
||||||
if (existsSync(node_gyp_bin)) {
|
|
||||||
return node_gyp_bin;
|
|
||||||
}
|
|
||||||
} catch (err) {
|
|
||||||
// do nothing
|
|
||||||
}
|
|
||||||
}
|
|
||||||
const npm_base = path.join(path.dirname(
|
|
||||||
path.dirname(process.execPath)),
|
|
||||||
'lib/node_modules/npm/');
|
|
||||||
node_gyp_bin = path.join(npm_base, 'node_modules/node-gyp/bin/node-gyp.js');
|
|
||||||
if (existsSync(node_gyp_bin)) {
|
|
||||||
return node_gyp_bin;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports.run_gyp = function(args, opts, callback) {
|
|
||||||
let shell_cmd = '';
|
|
||||||
const cmd_args = [];
|
|
||||||
if (opts.runtime && opts.runtime === 'node-webkit') {
|
|
||||||
shell_cmd = 'nw-gyp';
|
|
||||||
if (win) shell_cmd += '.cmd';
|
|
||||||
} else {
|
|
||||||
const node_gyp_path = which_node_gyp();
|
|
||||||
if (node_gyp_path) {
|
|
||||||
shell_cmd = process.execPath;
|
|
||||||
cmd_args.push(node_gyp_path);
|
|
||||||
} else {
|
|
||||||
shell_cmd = 'node-gyp';
|
|
||||||
if (win) shell_cmd += '.cmd';
|
|
||||||
}
|
|
||||||
}
|
|
||||||
const final_args = cmd_args.concat(args);
|
|
||||||
const cmd = cp.spawn(shell_cmd, final_args, { cwd: undefined, env: process.env, stdio: [0, 1, 2] });
|
|
||||||
cmd.on('error', (err) => {
|
|
||||||
if (err) {
|
|
||||||
return callback(new Error("Failed to execute '" + shell_cmd + ' ' + final_args.join(' ') + "' (" + err + ')'));
|
|
||||||
}
|
|
||||||
callback(null, opts);
|
|
||||||
});
|
|
||||||
cmd.on('close', (code) => {
|
|
||||||
if (code && code !== 0) {
|
|
||||||
return callback(new Error("Failed to execute '" + shell_cmd + ' ' + final_args.join(' ') + "' (" + code + ')'));
|
|
||||||
}
|
|
||||||
callback(null, opts);
|
|
||||||
});
|
|
||||||
};
|
|
||||||
@ -1,102 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
module.exports = exports = handle_gyp_opts;
|
|
||||||
|
|
||||||
const versioning = require('./versioning.js');
|
|
||||||
const napi = require('./napi.js');
|
|
||||||
|
|
||||||
/*
|
|
||||||
|
|
||||||
Here we gather node-pre-gyp generated options (from versioning) and pass them along to node-gyp.
|
|
||||||
|
|
||||||
We massage the args and options slightly to account for differences in what commands mean between
|
|
||||||
node-pre-gyp and node-gyp (e.g. see the difference between "build" and "rebuild" below)
|
|
||||||
|
|
||||||
Keep in mind: the values inside `argv` and `gyp.opts` below are different depending on whether
|
|
||||||
node-pre-gyp is called directory, or if it is called in a `run-script` phase of npm.
|
|
||||||
|
|
||||||
We also try to preserve any command line options that might have been passed to npm or node-pre-gyp.
|
|
||||||
But this is fairly difficult without passing way to much through. For example `gyp.opts` contains all
|
|
||||||
the process.env and npm pushes a lot of variables into process.env which node-pre-gyp inherits. So we have
|
|
||||||
to be very selective about what we pass through.
|
|
||||||
|
|
||||||
For example:
|
|
||||||
|
|
||||||
`npm install --build-from-source` will give:
|
|
||||||
|
|
||||||
argv == [ 'rebuild' ]
|
|
||||||
gyp.opts.argv == { remain: [ 'install' ],
|
|
||||||
cooked: [ 'install', '--fallback-to-build' ],
|
|
||||||
original: [ 'install', '--fallback-to-build' ] }
|
|
||||||
|
|
||||||
`./bin/node-pre-gyp build` will give:
|
|
||||||
|
|
||||||
argv == []
|
|
||||||
gyp.opts.argv == { remain: [ 'build' ],
|
|
||||||
cooked: [ 'build' ],
|
|
||||||
original: [ '-C', 'test/app1', 'build' ] }
|
|
||||||
|
|
||||||
*/
|
|
||||||
|
|
||||||
// select set of node-pre-gyp versioning info
|
|
||||||
// to share with node-gyp
|
|
||||||
const share_with_node_gyp = [
|
|
||||||
'module',
|
|
||||||
'module_name',
|
|
||||||
'module_path',
|
|
||||||
'napi_version',
|
|
||||||
'node_abi_napi',
|
|
||||||
'napi_build_version',
|
|
||||||
'node_napi_label'
|
|
||||||
];
|
|
||||||
|
|
||||||
function handle_gyp_opts(gyp, argv, callback) {
|
|
||||||
|
|
||||||
// Collect node-pre-gyp specific variables to pass to node-gyp
|
|
||||||
const node_pre_gyp_options = [];
|
|
||||||
// generate custom node-pre-gyp versioning info
|
|
||||||
const napi_build_version = napi.get_napi_build_version_from_command_args(argv);
|
|
||||||
const opts = versioning.evaluate(gyp.package_json, gyp.opts, napi_build_version);
|
|
||||||
share_with_node_gyp.forEach((key) => {
|
|
||||||
const val = opts[key];
|
|
||||||
if (val) {
|
|
||||||
node_pre_gyp_options.push('--' + key + '=' + val);
|
|
||||||
} else if (key === 'napi_build_version') {
|
|
||||||
node_pre_gyp_options.push('--' + key + '=0');
|
|
||||||
} else {
|
|
||||||
if (key !== 'napi_version' && key !== 'node_abi_napi')
|
|
||||||
return callback(new Error('Option ' + key + ' required but not found by node-pre-gyp'));
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// Collect options that follow the special -- which disables nopt parsing
|
|
||||||
const unparsed_options = [];
|
|
||||||
let double_hyphen_found = false;
|
|
||||||
gyp.opts.argv.original.forEach((opt) => {
|
|
||||||
if (double_hyphen_found) {
|
|
||||||
unparsed_options.push(opt);
|
|
||||||
}
|
|
||||||
if (opt === '--') {
|
|
||||||
double_hyphen_found = true;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// We try respect and pass through remaining command
|
|
||||||
// line options (like --foo=bar) to node-gyp
|
|
||||||
const cooked = gyp.opts.argv.cooked;
|
|
||||||
const node_gyp_options = [];
|
|
||||||
cooked.forEach((value) => {
|
|
||||||
if (value.length > 2 && value.slice(0, 2) === '--') {
|
|
||||||
const key = value.slice(2);
|
|
||||||
const val = cooked[cooked.indexOf(value) + 1];
|
|
||||||
if (val && val.indexOf('--') === -1) { // handle '--foo=bar' or ['--foo','bar']
|
|
||||||
node_gyp_options.push('--' + key + '=' + val);
|
|
||||||
} else { // pass through --foo
|
|
||||||
node_gyp_options.push(value);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
const result = { 'opts': opts, 'gyp': node_gyp_options, 'pre': node_pre_gyp_options, 'unparsed': unparsed_options };
|
|
||||||
return callback(null, result);
|
|
||||||
}
|
|
||||||
@ -1,205 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
const fs = require('fs');
|
|
||||||
|
|
||||||
module.exports = exports;
|
|
||||||
|
|
||||||
const versionArray = process.version
|
|
||||||
.substr(1)
|
|
||||||
.replace(/-.*$/, '')
|
|
||||||
.split('.')
|
|
||||||
.map((item) => {
|
|
||||||
return +item;
|
|
||||||
});
|
|
||||||
|
|
||||||
const napi_multiple_commands = [
|
|
||||||
'build',
|
|
||||||
'clean',
|
|
||||||
'configure',
|
|
||||||
'package',
|
|
||||||
'publish',
|
|
||||||
'reveal',
|
|
||||||
'testbinary',
|
|
||||||
'testpackage',
|
|
||||||
'unpublish'
|
|
||||||
];
|
|
||||||
|
|
||||||
const napi_build_version_tag = 'napi_build_version=';
|
|
||||||
|
|
||||||
module.exports.get_napi_version = function() {
|
|
||||||
// returns the non-zero numeric napi version or undefined if napi is not supported.
|
|
||||||
// correctly supporting target requires an updated cross-walk
|
|
||||||
let version = process.versions.napi; // can be undefined
|
|
||||||
if (!version) { // this code should never need to be updated
|
|
||||||
if (versionArray[0] === 9 && versionArray[1] >= 3) version = 2; // 9.3.0+
|
|
||||||
else if (versionArray[0] === 8) version = 1; // 8.0.0+
|
|
||||||
}
|
|
||||||
return version;
|
|
||||||
};
|
|
||||||
|
|
||||||
module.exports.get_napi_version_as_string = function(target) {
|
|
||||||
// returns the napi version as a string or an empty string if napi is not supported.
|
|
||||||
const version = module.exports.get_napi_version(target);
|
|
||||||
return version ? '' + version : '';
|
|
||||||
};
|
|
||||||
|
|
||||||
module.exports.validate_package_json = function(package_json, opts) { // throws Error
|
|
||||||
|
|
||||||
const binary = package_json.binary;
|
|
||||||
const module_path_ok = pathOK(binary.module_path);
|
|
||||||
const remote_path_ok = pathOK(binary.remote_path);
|
|
||||||
const package_name_ok = pathOK(binary.package_name);
|
|
||||||
const napi_build_versions = module.exports.get_napi_build_versions(package_json, opts, true);
|
|
||||||
const napi_build_versions_raw = module.exports.get_napi_build_versions_raw(package_json);
|
|
||||||
|
|
||||||
if (napi_build_versions) {
|
|
||||||
napi_build_versions.forEach((napi_build_version)=> {
|
|
||||||
if (!(parseInt(napi_build_version, 10) === napi_build_version && napi_build_version > 0)) {
|
|
||||||
throw new Error('All values specified in napi_versions must be positive integers.');
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
if (napi_build_versions && (!module_path_ok || (!remote_path_ok && !package_name_ok))) {
|
|
||||||
throw new Error('When napi_versions is specified; module_path and either remote_path or ' +
|
|
||||||
"package_name must contain the substitution string '{napi_build_version}`.");
|
|
||||||
}
|
|
||||||
|
|
||||||
if ((module_path_ok || remote_path_ok || package_name_ok) && !napi_build_versions_raw) {
|
|
||||||
throw new Error("When the substitution string '{napi_build_version}` is specified in " +
|
|
||||||
'module_path, remote_path, or package_name; napi_versions must also be specified.');
|
|
||||||
}
|
|
||||||
|
|
||||||
if (napi_build_versions && !module.exports.get_best_napi_build_version(package_json, opts) &&
|
|
||||||
module.exports.build_napi_only(package_json)) {
|
|
||||||
throw new Error(
|
|
||||||
'The Node-API version of this Node instance is ' + module.exports.get_napi_version(opts ? opts.target : undefined) + '. ' +
|
|
||||||
'This module supports Node-API version(s) ' + module.exports.get_napi_build_versions_raw(package_json) + '. ' +
|
|
||||||
'This Node instance cannot run this module.');
|
|
||||||
}
|
|
||||||
|
|
||||||
if (napi_build_versions_raw && !napi_build_versions && module.exports.build_napi_only(package_json)) {
|
|
||||||
throw new Error(
|
|
||||||
'The Node-API version of this Node instance is ' + module.exports.get_napi_version(opts ? opts.target : undefined) + '. ' +
|
|
||||||
'This module supports Node-API version(s) ' + module.exports.get_napi_build_versions_raw(package_json) + '. ' +
|
|
||||||
'This Node instance cannot run this module.');
|
|
||||||
}
|
|
||||||
|
|
||||||
};
|
|
||||||
|
|
||||||
function pathOK(path) {
|
|
||||||
return path && (path.indexOf('{napi_build_version}') !== -1 || path.indexOf('{node_napi_label}') !== -1);
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports.expand_commands = function(package_json, opts, commands) {
|
|
||||||
const expanded_commands = [];
|
|
||||||
const napi_build_versions = module.exports.get_napi_build_versions(package_json, opts);
|
|
||||||
commands.forEach((command)=> {
|
|
||||||
if (napi_build_versions && command.name === 'install') {
|
|
||||||
const napi_build_version = module.exports.get_best_napi_build_version(package_json, opts);
|
|
||||||
const args = napi_build_version ? [napi_build_version_tag + napi_build_version] : [];
|
|
||||||
expanded_commands.push({ name: command.name, args: args });
|
|
||||||
} else if (napi_build_versions && napi_multiple_commands.indexOf(command.name) !== -1) {
|
|
||||||
napi_build_versions.forEach((napi_build_version)=> {
|
|
||||||
const args = command.args.slice();
|
|
||||||
args.push(napi_build_version_tag + napi_build_version);
|
|
||||||
expanded_commands.push({ name: command.name, args: args });
|
|
||||||
});
|
|
||||||
} else {
|
|
||||||
expanded_commands.push(command);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
return expanded_commands;
|
|
||||||
};
|
|
||||||
|
|
||||||
module.exports.get_napi_build_versions = function(package_json, opts, warnings) { // opts may be undefined
|
|
||||||
const log = require('npmlog');
|
|
||||||
let napi_build_versions = [];
|
|
||||||
const supported_napi_version = module.exports.get_napi_version(opts ? opts.target : undefined);
|
|
||||||
// remove duplicates, verify each napi version can actaully be built
|
|
||||||
if (package_json.binary && package_json.binary.napi_versions) {
|
|
||||||
package_json.binary.napi_versions.forEach((napi_version) => {
|
|
||||||
const duplicated = napi_build_versions.indexOf(napi_version) !== -1;
|
|
||||||
if (!duplicated && supported_napi_version && napi_version <= supported_napi_version) {
|
|
||||||
napi_build_versions.push(napi_version);
|
|
||||||
} else if (warnings && !duplicated && supported_napi_version) {
|
|
||||||
log.info('This Node instance does not support builds for Node-API version', napi_version);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
if (opts && opts['build-latest-napi-version-only']) {
|
|
||||||
let latest_version = 0;
|
|
||||||
napi_build_versions.forEach((napi_version) => {
|
|
||||||
if (napi_version > latest_version) latest_version = napi_version;
|
|
||||||
});
|
|
||||||
napi_build_versions = latest_version ? [latest_version] : [];
|
|
||||||
}
|
|
||||||
return napi_build_versions.length ? napi_build_versions : undefined;
|
|
||||||
};
|
|
||||||
|
|
||||||
module.exports.get_napi_build_versions_raw = function(package_json) {
|
|
||||||
const napi_build_versions = [];
|
|
||||||
// remove duplicates
|
|
||||||
if (package_json.binary && package_json.binary.napi_versions) {
|
|
||||||
package_json.binary.napi_versions.forEach((napi_version) => {
|
|
||||||
if (napi_build_versions.indexOf(napi_version) === -1) {
|
|
||||||
napi_build_versions.push(napi_version);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
return napi_build_versions.length ? napi_build_versions : undefined;
|
|
||||||
};
|
|
||||||
|
|
||||||
module.exports.get_command_arg = function(napi_build_version) {
|
|
||||||
return napi_build_version_tag + napi_build_version;
|
|
||||||
};
|
|
||||||
|
|
||||||
module.exports.get_napi_build_version_from_command_args = function(command_args) {
|
|
||||||
for (let i = 0; i < command_args.length; i++) {
|
|
||||||
const arg = command_args[i];
|
|
||||||
if (arg.indexOf(napi_build_version_tag) === 0) {
|
|
||||||
return parseInt(arg.substr(napi_build_version_tag.length), 10);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return undefined;
|
|
||||||
};
|
|
||||||
|
|
||||||
module.exports.swap_build_dir_out = function(napi_build_version) {
|
|
||||||
if (napi_build_version) {
|
|
||||||
const rm = require('rimraf');
|
|
||||||
rm.sync(module.exports.get_build_dir(napi_build_version));
|
|
||||||
fs.renameSync('build', module.exports.get_build_dir(napi_build_version));
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
module.exports.swap_build_dir_in = function(napi_build_version) {
|
|
||||||
if (napi_build_version) {
|
|
||||||
const rm = require('rimraf');
|
|
||||||
rm.sync('build');
|
|
||||||
fs.renameSync(module.exports.get_build_dir(napi_build_version), 'build');
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
module.exports.get_build_dir = function(napi_build_version) {
|
|
||||||
return 'build-tmp-napi-v' + napi_build_version;
|
|
||||||
};
|
|
||||||
|
|
||||||
module.exports.get_best_napi_build_version = function(package_json, opts) {
|
|
||||||
let best_napi_build_version = 0;
|
|
||||||
const napi_build_versions = module.exports.get_napi_build_versions(package_json, opts);
|
|
||||||
if (napi_build_versions) {
|
|
||||||
const our_napi_version = module.exports.get_napi_version(opts ? opts.target : undefined);
|
|
||||||
napi_build_versions.forEach((napi_build_version)=> {
|
|
||||||
if (napi_build_version > best_napi_build_version &&
|
|
||||||
napi_build_version <= our_napi_version) {
|
|
||||||
best_napi_build_version = napi_build_version;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
return best_napi_build_version === 0 ? undefined : best_napi_build_version;
|
|
||||||
};
|
|
||||||
|
|
||||||
module.exports.build_napi_only = function(package_json) {
|
|
||||||
return package_json.binary && package_json.binary.package_name &&
|
|
||||||
package_json.binary.package_name.indexOf('{node_napi_label}') === -1;
|
|
||||||
};
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
<!doctype html>
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta charset="utf-8">
|
|
||||||
<title>Node-webkit-based module test</title>
|
|
||||||
<script>
|
|
||||||
function nwModuleTest(){
|
|
||||||
var util = require('util');
|
|
||||||
var moduleFolder = require('nw.gui').App.argv[0];
|
|
||||||
try {
|
|
||||||
require(moduleFolder);
|
|
||||||
} catch(e) {
|
|
||||||
if( process.platform !== 'win32' ){
|
|
||||||
util.log('nw-pre-gyp error:');
|
|
||||||
util.log(e.stack);
|
|
||||||
}
|
|
||||||
process.exit(1);
|
|
||||||
}
|
|
||||||
process.exit(0);
|
|
||||||
}
|
|
||||||
</script>
|
|
||||||
</head>
|
|
||||||
<body onload="nwModuleTest()">
|
|
||||||
<h1>Node-webkit-based module test</h1>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@ -1,9 +0,0 @@
|
|||||||
{
|
|
||||||
"main": "index.html",
|
|
||||||
"name": "nw-pre-gyp-module-test",
|
|
||||||
"description": "Node-webkit-based module test.",
|
|
||||||
"version": "0.0.1",
|
|
||||||
"window": {
|
|
||||||
"show": false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,163 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
module.exports = exports;
|
|
||||||
|
|
||||||
const url = require('url');
|
|
||||||
const fs = require('fs');
|
|
||||||
const path = require('path');
|
|
||||||
|
|
||||||
module.exports.detect = function(opts, config) {
|
|
||||||
const to = opts.hosted_path;
|
|
||||||
const uri = url.parse(to);
|
|
||||||
config.prefix = (!uri.pathname || uri.pathname === '/') ? '' : uri.pathname.replace('/', '');
|
|
||||||
if (opts.bucket && opts.region) {
|
|
||||||
config.bucket = opts.bucket;
|
|
||||||
config.region = opts.region;
|
|
||||||
config.endpoint = opts.host;
|
|
||||||
config.s3ForcePathStyle = opts.s3ForcePathStyle;
|
|
||||||
} else {
|
|
||||||
const parts = uri.hostname.split('.s3');
|
|
||||||
const bucket = parts[0];
|
|
||||||
if (!bucket) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (!config.bucket) {
|
|
||||||
config.bucket = bucket;
|
|
||||||
}
|
|
||||||
if (!config.region) {
|
|
||||||
const region = parts[1].slice(1).split('.')[0];
|
|
||||||
if (region === 'amazonaws') {
|
|
||||||
config.region = 'us-east-1';
|
|
||||||
} else {
|
|
||||||
config.region = region;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
module.exports.get_s3 = function(config) {
|
|
||||||
|
|
||||||
if (process.env.node_pre_gyp_mock_s3) {
|
|
||||||
// here we're mocking. node_pre_gyp_mock_s3 is the scratch directory
|
|
||||||
// for the mock code.
|
|
||||||
const AWSMock = require('mock-aws-s3');
|
|
||||||
const os = require('os');
|
|
||||||
|
|
||||||
AWSMock.config.basePath = `${os.tmpdir()}/mock`;
|
|
||||||
|
|
||||||
const s3 = AWSMock.S3();
|
|
||||||
|
|
||||||
// wrapped callback maker. fs calls return code of ENOENT but AWS.S3 returns
|
|
||||||
// NotFound.
|
|
||||||
const wcb = (fn) => (err, ...args) => {
|
|
||||||
if (err && err.code === 'ENOENT') {
|
|
||||||
err.code = 'NotFound';
|
|
||||||
}
|
|
||||||
return fn(err, ...args);
|
|
||||||
};
|
|
||||||
|
|
||||||
return {
|
|
||||||
listObjects(params, callback) {
|
|
||||||
return s3.listObjects(params, wcb(callback));
|
|
||||||
},
|
|
||||||
headObject(params, callback) {
|
|
||||||
return s3.headObject(params, wcb(callback));
|
|
||||||
},
|
|
||||||
deleteObject(params, callback) {
|
|
||||||
return s3.deleteObject(params, wcb(callback));
|
|
||||||
},
|
|
||||||
putObject(params, callback) {
|
|
||||||
return s3.putObject(params, wcb(callback));
|
|
||||||
}
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
// if not mocking then setup real s3.
|
|
||||||
const AWS = require('aws-sdk');
|
|
||||||
|
|
||||||
AWS.config.update(config);
|
|
||||||
const s3 = new AWS.S3();
|
|
||||||
|
|
||||||
// need to change if additional options need to be specified.
|
|
||||||
return {
|
|
||||||
listObjects(params, callback) {
|
|
||||||
return s3.listObjects(params, callback);
|
|
||||||
},
|
|
||||||
headObject(params, callback) {
|
|
||||||
return s3.headObject(params, callback);
|
|
||||||
},
|
|
||||||
deleteObject(params, callback) {
|
|
||||||
return s3.deleteObject(params, callback);
|
|
||||||
},
|
|
||||||
putObject(params, callback) {
|
|
||||||
return s3.putObject(params, callback);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
};
|
|
||||||
|
|
||||||
//
|
|
||||||
// function to get the mocking control function. if not mocking it returns a no-op.
|
|
||||||
//
|
|
||||||
// if mocking it sets up the mock http interceptors that use the mocked s3 file system
|
|
||||||
// to fulfill reponses.
|
|
||||||
module.exports.get_mockS3Http = function() {
|
|
||||||
let mock_s3 = false;
|
|
||||||
if (!process.env.node_pre_gyp_mock_s3) {
|
|
||||||
return () => mock_s3;
|
|
||||||
}
|
|
||||||
|
|
||||||
const nock = require('nock');
|
|
||||||
// the bucket used for testing, as addressed by https.
|
|
||||||
const host = 'https://mapbox-node-pre-gyp-public-testing-bucket.s3.us-east-1.amazonaws.com';
|
|
||||||
const mockDir = process.env.node_pre_gyp_mock_s3 + '/mapbox-node-pre-gyp-public-testing-bucket';
|
|
||||||
|
|
||||||
// function to setup interceptors. they are "turned off" by setting mock_s3 to false.
|
|
||||||
const mock_http = () => {
|
|
||||||
// eslint-disable-next-line no-unused-vars
|
|
||||||
function get(uri, requestBody) {
|
|
||||||
const filepath = path.join(mockDir, uri.replace('%2B', '+'));
|
|
||||||
|
|
||||||
try {
|
|
||||||
fs.accessSync(filepath, fs.constants.R_OK);
|
|
||||||
} catch (e) {
|
|
||||||
return [404, 'not found\n'];
|
|
||||||
}
|
|
||||||
|
|
||||||
// the mock s3 functions just write to disk, so just read from it.
|
|
||||||
return [200, fs.createReadStream(filepath)];
|
|
||||||
}
|
|
||||||
|
|
||||||
// eslint-disable-next-line no-unused-vars
|
|
||||||
return nock(host)
|
|
||||||
.persist()
|
|
||||||
.get(() => mock_s3) // mock any uri for s3 when true
|
|
||||||
.reply(get);
|
|
||||||
};
|
|
||||||
|
|
||||||
// setup interceptors. they check the mock_s3 flag to determine whether to intercept.
|
|
||||||
mock_http(nock, host, mockDir);
|
|
||||||
// function to turn matching all requests to s3 on/off.
|
|
||||||
const mockS3Http = (action) => {
|
|
||||||
const previous = mock_s3;
|
|
||||||
if (action === 'off') {
|
|
||||||
mock_s3 = false;
|
|
||||||
} else if (action === 'on') {
|
|
||||||
mock_s3 = true;
|
|
||||||
} else if (action !== 'get') {
|
|
||||||
throw new Error(`illegal action for setMockHttp ${action}`);
|
|
||||||
}
|
|
||||||
return previous;
|
|
||||||
};
|
|
||||||
|
|
||||||
// call mockS3Http with the argument
|
|
||||||
// - 'on' - turn it on
|
|
||||||
// - 'off' - turn it off (used by fetch.test.js so it doesn't interfere with redirects)
|
|
||||||
// - 'get' - return true or false for 'on' or 'off'
|
|
||||||
return mockS3Http;
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -1,335 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
module.exports = exports;
|
|
||||||
|
|
||||||
const path = require('path');
|
|
||||||
const semver = require('semver');
|
|
||||||
const url = require('url');
|
|
||||||
const detect_libc = require('detect-libc');
|
|
||||||
const napi = require('./napi.js');
|
|
||||||
|
|
||||||
let abi_crosswalk;
|
|
||||||
|
|
||||||
// This is used for unit testing to provide a fake
|
|
||||||
// ABI crosswalk that emulates one that is not updated
|
|
||||||
// for the current version
|
|
||||||
if (process.env.NODE_PRE_GYP_ABI_CROSSWALK) {
|
|
||||||
abi_crosswalk = require(process.env.NODE_PRE_GYP_ABI_CROSSWALK);
|
|
||||||
} else {
|
|
||||||
abi_crosswalk = require('./abi_crosswalk.json');
|
|
||||||
}
|
|
||||||
|
|
||||||
const major_versions = {};
|
|
||||||
Object.keys(abi_crosswalk).forEach((v) => {
|
|
||||||
const major = v.split('.')[0];
|
|
||||||
if (!major_versions[major]) {
|
|
||||||
major_versions[major] = v;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
function get_electron_abi(runtime, target_version) {
|
|
||||||
if (!runtime) {
|
|
||||||
throw new Error('get_electron_abi requires valid runtime arg');
|
|
||||||
}
|
|
||||||
if (typeof target_version === 'undefined') {
|
|
||||||
// erroneous CLI call
|
|
||||||
throw new Error('Empty target version is not supported if electron is the target.');
|
|
||||||
}
|
|
||||||
// Electron guarantees that patch version update won't break native modules.
|
|
||||||
const sem_ver = semver.parse(target_version);
|
|
||||||
return runtime + '-v' + sem_ver.major + '.' + sem_ver.minor;
|
|
||||||
}
|
|
||||||
module.exports.get_electron_abi = get_electron_abi;
|
|
||||||
|
|
||||||
function get_node_webkit_abi(runtime, target_version) {
|
|
||||||
if (!runtime) {
|
|
||||||
throw new Error('get_node_webkit_abi requires valid runtime arg');
|
|
||||||
}
|
|
||||||
if (typeof target_version === 'undefined') {
|
|
||||||
// erroneous CLI call
|
|
||||||
throw new Error('Empty target version is not supported if node-webkit is the target.');
|
|
||||||
}
|
|
||||||
return runtime + '-v' + target_version;
|
|
||||||
}
|
|
||||||
module.exports.get_node_webkit_abi = get_node_webkit_abi;
|
|
||||||
|
|
||||||
function get_node_abi(runtime, versions) {
|
|
||||||
if (!runtime) {
|
|
||||||
throw new Error('get_node_abi requires valid runtime arg');
|
|
||||||
}
|
|
||||||
if (!versions) {
|
|
||||||
throw new Error('get_node_abi requires valid process.versions object');
|
|
||||||
}
|
|
||||||
const sem_ver = semver.parse(versions.node);
|
|
||||||
if (sem_ver.major === 0 && sem_ver.minor % 2) { // odd series
|
|
||||||
// https://github.com/mapbox/node-pre-gyp/issues/124
|
|
||||||
return runtime + '-v' + versions.node;
|
|
||||||
} else {
|
|
||||||
// process.versions.modules added in >= v0.10.4 and v0.11.7
|
|
||||||
// https://github.com/joyent/node/commit/ccabd4a6fa8a6eb79d29bc3bbe9fe2b6531c2d8e
|
|
||||||
return versions.modules ? runtime + '-v' + (+versions.modules) :
|
|
||||||
'v8-' + versions.v8.split('.').slice(0, 2).join('.');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
module.exports.get_node_abi = get_node_abi;
|
|
||||||
|
|
||||||
function get_runtime_abi(runtime, target_version) {
|
|
||||||
if (!runtime) {
|
|
||||||
throw new Error('get_runtime_abi requires valid runtime arg');
|
|
||||||
}
|
|
||||||
if (runtime === 'node-webkit') {
|
|
||||||
return get_node_webkit_abi(runtime, target_version || process.versions['node-webkit']);
|
|
||||||
} else if (runtime === 'electron') {
|
|
||||||
return get_electron_abi(runtime, target_version || process.versions.electron);
|
|
||||||
} else {
|
|
||||||
if (runtime !== 'node') {
|
|
||||||
throw new Error("Unknown Runtime: '" + runtime + "'");
|
|
||||||
}
|
|
||||||
if (!target_version) {
|
|
||||||
return get_node_abi(runtime, process.versions);
|
|
||||||
} else {
|
|
||||||
let cross_obj;
|
|
||||||
// abi_crosswalk generated with ./scripts/abi_crosswalk.js
|
|
||||||
if (abi_crosswalk[target_version]) {
|
|
||||||
cross_obj = abi_crosswalk[target_version];
|
|
||||||
} else {
|
|
||||||
const target_parts = target_version.split('.').map((i) => { return +i; });
|
|
||||||
if (target_parts.length !== 3) { // parse failed
|
|
||||||
throw new Error('Unknown target version: ' + target_version);
|
|
||||||
}
|
|
||||||
/*
|
|
||||||
The below code tries to infer the last known ABI compatible version
|
|
||||||
that we have recorded in the abi_crosswalk.json when an exact match
|
|
||||||
is not possible. The reasons for this to exist are complicated:
|
|
||||||
|
|
||||||
- We support passing --target to be able to allow developers to package binaries for versions of node
|
|
||||||
that are not the same one as they are running. This might also be used in combination with the
|
|
||||||
--target_arch or --target_platform flags to also package binaries for alternative platforms
|
|
||||||
- When --target is passed we can't therefore determine the ABI (process.versions.modules) from the node
|
|
||||||
version that is running in memory
|
|
||||||
- So, therefore node-pre-gyp keeps an "ABI crosswalk" (lib/util/abi_crosswalk.json) to be able to look
|
|
||||||
this info up for all versions
|
|
||||||
- But we cannot easily predict what the future ABI will be for released versions
|
|
||||||
- And node-pre-gyp needs to be a `bundledDependency` in apps that depend on it in order to work correctly
|
|
||||||
by being fully available at install time.
|
|
||||||
- So, the speed of node releases and the bundled nature of node-pre-gyp mean that a new node-pre-gyp release
|
|
||||||
need to happen for every node.js/io.js/node-webkit/nw.js/atom-shell/etc release that might come online if
|
|
||||||
you want the `--target` flag to keep working for the latest version
|
|
||||||
- Which is impractical ^^
|
|
||||||
- Hence the below code guesses about future ABI to make the need to update node-pre-gyp less demanding.
|
|
||||||
|
|
||||||
In practice then you can have a dependency of your app like `node-sqlite3` that bundles a `node-pre-gyp` that
|
|
||||||
only knows about node v0.10.33 in the `abi_crosswalk.json` but target node v0.10.34 (which is assumed to be
|
|
||||||
ABI compatible with v0.10.33).
|
|
||||||
|
|
||||||
TODO: use semver module instead of custom version parsing
|
|
||||||
*/
|
|
||||||
const major = target_parts[0];
|
|
||||||
let minor = target_parts[1];
|
|
||||||
let patch = target_parts[2];
|
|
||||||
// io.js: yeah if node.js ever releases 1.x this will break
|
|
||||||
// but that is unlikely to happen: https://github.com/iojs/io.js/pull/253#issuecomment-69432616
|
|
||||||
if (major === 1) {
|
|
||||||
// look for last release that is the same major version
|
|
||||||
// e.g. we assume io.js 1.x is ABI compatible with >= 1.0.0
|
|
||||||
while (true) {
|
|
||||||
if (minor > 0) --minor;
|
|
||||||
if (patch > 0) --patch;
|
|
||||||
const new_iojs_target = '' + major + '.' + minor + '.' + patch;
|
|
||||||
if (abi_crosswalk[new_iojs_target]) {
|
|
||||||
cross_obj = abi_crosswalk[new_iojs_target];
|
|
||||||
console.log('Warning: node-pre-gyp could not find exact match for ' + target_version);
|
|
||||||
console.log('Warning: but node-pre-gyp successfully choose ' + new_iojs_target + ' as ABI compatible target');
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
if (minor === 0 && patch === 0) {
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} else if (major >= 2) {
|
|
||||||
// look for last release that is the same major version
|
|
||||||
if (major_versions[major]) {
|
|
||||||
cross_obj = abi_crosswalk[major_versions[major]];
|
|
||||||
console.log('Warning: node-pre-gyp could not find exact match for ' + target_version);
|
|
||||||
console.log('Warning: but node-pre-gyp successfully choose ' + major_versions[major] + ' as ABI compatible target');
|
|
||||||
}
|
|
||||||
} else if (major === 0) { // node.js
|
|
||||||
if (target_parts[1] % 2 === 0) { // for stable/even node.js series
|
|
||||||
// look for the last release that is the same minor release
|
|
||||||
// e.g. we assume node 0.10.x is ABI compatible with >= 0.10.0
|
|
||||||
while (--patch > 0) {
|
|
||||||
const new_node_target = '' + major + '.' + minor + '.' + patch;
|
|
||||||
if (abi_crosswalk[new_node_target]) {
|
|
||||||
cross_obj = abi_crosswalk[new_node_target];
|
|
||||||
console.log('Warning: node-pre-gyp could not find exact match for ' + target_version);
|
|
||||||
console.log('Warning: but node-pre-gyp successfully choose ' + new_node_target + ' as ABI compatible target');
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (!cross_obj) {
|
|
||||||
throw new Error('Unsupported target version: ' + target_version);
|
|
||||||
}
|
|
||||||
// emulate process.versions
|
|
||||||
const versions_obj = {
|
|
||||||
node: target_version,
|
|
||||||
v8: cross_obj.v8 + '.0',
|
|
||||||
// abi_crosswalk uses 1 for node versions lacking process.versions.modules
|
|
||||||
// process.versions.modules added in >= v0.10.4 and v0.11.7
|
|
||||||
modules: cross_obj.node_abi > 1 ? cross_obj.node_abi : undefined
|
|
||||||
};
|
|
||||||
return get_node_abi(runtime, versions_obj);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
module.exports.get_runtime_abi = get_runtime_abi;
|
|
||||||
|
|
||||||
const required_parameters = [
|
|
||||||
'module_name',
|
|
||||||
'module_path',
|
|
||||||
'host'
|
|
||||||
];
|
|
||||||
|
|
||||||
function validate_config(package_json, opts) {
|
|
||||||
const msg = package_json.name + ' package.json is not node-pre-gyp ready:\n';
|
|
||||||
const missing = [];
|
|
||||||
if (!package_json.main) {
|
|
||||||
missing.push('main');
|
|
||||||
}
|
|
||||||
if (!package_json.version) {
|
|
||||||
missing.push('version');
|
|
||||||
}
|
|
||||||
if (!package_json.name) {
|
|
||||||
missing.push('name');
|
|
||||||
}
|
|
||||||
if (!package_json.binary) {
|
|
||||||
missing.push('binary');
|
|
||||||
}
|
|
||||||
const o = package_json.binary;
|
|
||||||
if (o) {
|
|
||||||
required_parameters.forEach((p) => {
|
|
||||||
if (!o[p] || typeof o[p] !== 'string') {
|
|
||||||
missing.push('binary.' + p);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
if (missing.length >= 1) {
|
|
||||||
throw new Error(msg + 'package.json must declare these properties: \n' + missing.join('\n'));
|
|
||||||
}
|
|
||||||
if (o) {
|
|
||||||
// enforce https over http
|
|
||||||
const protocol = url.parse(o.host).protocol;
|
|
||||||
if (protocol === 'http:') {
|
|
||||||
throw new Error("'host' protocol (" + protocol + ") is invalid - only 'https:' is accepted");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
napi.validate_package_json(package_json, opts);
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports.validate_config = validate_config;
|
|
||||||
|
|
||||||
function eval_template(template, opts) {
|
|
||||||
Object.keys(opts).forEach((key) => {
|
|
||||||
const pattern = '{' + key + '}';
|
|
||||||
while (template.indexOf(pattern) > -1) {
|
|
||||||
template = template.replace(pattern, opts[key]);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
return template;
|
|
||||||
}
|
|
||||||
|
|
||||||
// url.resolve needs single trailing slash
|
|
||||||
// to behave correctly, otherwise a double slash
|
|
||||||
// may end up in the url which breaks requests
|
|
||||||
// and a lacking slash may not lead to proper joining
|
|
||||||
function fix_slashes(pathname) {
|
|
||||||
if (pathname.slice(-1) !== '/') {
|
|
||||||
return pathname + '/';
|
|
||||||
}
|
|
||||||
return pathname;
|
|
||||||
}
|
|
||||||
|
|
||||||
// remove double slashes
|
|
||||||
// note: path.normalize will not work because
|
|
||||||
// it will convert forward to back slashes
|
|
||||||
function drop_double_slashes(pathname) {
|
|
||||||
return pathname.replace(/\/\//g, '/');
|
|
||||||
}
|
|
||||||
|
|
||||||
function get_process_runtime(versions) {
|
|
||||||
let runtime = 'node';
|
|
||||||
if (versions['node-webkit']) {
|
|
||||||
runtime = 'node-webkit';
|
|
||||||
} else if (versions.electron) {
|
|
||||||
runtime = 'electron';
|
|
||||||
}
|
|
||||||
return runtime;
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports.get_process_runtime = get_process_runtime;
|
|
||||||
|
|
||||||
const default_package_name = '{module_name}-v{version}-{node_abi}-{platform}-{arch}.tar.gz';
|
|
||||||
const default_remote_path = '';
|
|
||||||
|
|
||||||
module.exports.evaluate = function(package_json, options, napi_build_version) {
|
|
||||||
options = options || {};
|
|
||||||
validate_config(package_json, options); // options is a suitable substitute for opts in this case
|
|
||||||
const v = package_json.version;
|
|
||||||
const module_version = semver.parse(v);
|
|
||||||
const runtime = options.runtime || get_process_runtime(process.versions);
|
|
||||||
const opts = {
|
|
||||||
name: package_json.name,
|
|
||||||
configuration: options.debug ? 'Debug' : 'Release',
|
|
||||||
debug: options.debug,
|
|
||||||
module_name: package_json.binary.module_name,
|
|
||||||
version: module_version.version,
|
|
||||||
prerelease: module_version.prerelease.length ? module_version.prerelease.join('.') : '',
|
|
||||||
build: module_version.build.length ? module_version.build.join('.') : '',
|
|
||||||
major: module_version.major,
|
|
||||||
minor: module_version.minor,
|
|
||||||
patch: module_version.patch,
|
|
||||||
runtime: runtime,
|
|
||||||
node_abi: get_runtime_abi(runtime, options.target),
|
|
||||||
node_abi_napi: napi.get_napi_version(options.target) ? 'napi' : get_runtime_abi(runtime, options.target),
|
|
||||||
napi_version: napi.get_napi_version(options.target), // non-zero numeric, undefined if unsupported
|
|
||||||
napi_build_version: napi_build_version || '',
|
|
||||||
node_napi_label: napi_build_version ? 'napi-v' + napi_build_version : get_runtime_abi(runtime, options.target),
|
|
||||||
target: options.target || '',
|
|
||||||
platform: options.target_platform || process.platform,
|
|
||||||
target_platform: options.target_platform || process.platform,
|
|
||||||
arch: options.target_arch || process.arch,
|
|
||||||
target_arch: options.target_arch || process.arch,
|
|
||||||
libc: options.target_libc || detect_libc.familySync() || 'unknown',
|
|
||||||
module_main: package_json.main,
|
|
||||||
toolset: options.toolset || '', // address https://github.com/mapbox/node-pre-gyp/issues/119
|
|
||||||
bucket: package_json.binary.bucket,
|
|
||||||
region: package_json.binary.region,
|
|
||||||
s3ForcePathStyle: package_json.binary.s3ForcePathStyle || false
|
|
||||||
};
|
|
||||||
// support host mirror with npm config `--{module_name}_binary_host_mirror`
|
|
||||||
// e.g.: https://github.com/node-inspector/v8-profiler/blob/master/package.json#L25
|
|
||||||
// > npm install v8-profiler --profiler_binary_host_mirror=https://npm.taobao.org/mirrors/node-inspector/
|
|
||||||
const validModuleName = opts.module_name.replace('-', '_');
|
|
||||||
const host = process.env['npm_config_' + validModuleName + '_binary_host_mirror'] || package_json.binary.host;
|
|
||||||
opts.host = fix_slashes(eval_template(host, opts));
|
|
||||||
opts.module_path = eval_template(package_json.binary.module_path, opts);
|
|
||||||
// now we resolve the module_path to ensure it is absolute so that binding.gyp variables work predictably
|
|
||||||
if (options.module_root) {
|
|
||||||
// resolve relative to known module root: works for pre-binding require
|
|
||||||
opts.module_path = path.join(options.module_root, opts.module_path);
|
|
||||||
} else {
|
|
||||||
// resolve relative to current working directory: works for node-pre-gyp commands
|
|
||||||
opts.module_path = path.resolve(opts.module_path);
|
|
||||||
}
|
|
||||||
opts.module = path.join(opts.module_path, opts.module_name + '.node');
|
|
||||||
opts.remote_path = package_json.binary.remote_path ? drop_double_slashes(fix_slashes(eval_template(package_json.binary.remote_path, opts))) : default_remote_path;
|
|
||||||
const package_name = package_json.binary.package_name ? package_json.binary.package_name : default_package_name;
|
|
||||||
opts.package_name = eval_template(package_name, opts);
|
|
||||||
opts.staged_tarball = path.join('build/stage', opts.remote_path, opts.package_name);
|
|
||||||
opts.hosted_path = url.resolve(opts.host, opts.remote_path);
|
|
||||||
opts.hosted_tarball = url.resolve(opts.hosted_path, opts.package_name);
|
|
||||||
return opts;
|
|
||||||
};
|
|
||||||
@ -1,62 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "@mapbox/node-pre-gyp",
|
|
||||||
"description": "Node.js native addon binary install tool",
|
|
||||||
"version": "1.0.11",
|
|
||||||
"keywords": [
|
|
||||||
"native",
|
|
||||||
"addon",
|
|
||||||
"module",
|
|
||||||
"c",
|
|
||||||
"c++",
|
|
||||||
"bindings",
|
|
||||||
"binary"
|
|
||||||
],
|
|
||||||
"license": "BSD-3-Clause",
|
|
||||||
"author": "Dane Springmeyer <dane@mapbox.com>",
|
|
||||||
"repository": {
|
|
||||||
"type": "git",
|
|
||||||
"url": "git://github.com/mapbox/node-pre-gyp.git"
|
|
||||||
},
|
|
||||||
"bin": "./bin/node-pre-gyp",
|
|
||||||
"main": "./lib/node-pre-gyp.js",
|
|
||||||
"dependencies": {
|
|
||||||
"detect-libc": "^2.0.0",
|
|
||||||
"https-proxy-agent": "^5.0.0",
|
|
||||||
"make-dir": "^3.1.0",
|
|
||||||
"node-fetch": "^2.6.7",
|
|
||||||
"nopt": "^5.0.0",
|
|
||||||
"npmlog": "^5.0.1",
|
|
||||||
"rimraf": "^3.0.2",
|
|
||||||
"semver": "^7.3.5",
|
|
||||||
"tar": "^6.1.11"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"@mapbox/cloudfriend": "^5.1.0",
|
|
||||||
"@mapbox/eslint-config-mapbox": "^3.0.0",
|
|
||||||
"aws-sdk": "^2.1087.0",
|
|
||||||
"codecov": "^3.8.3",
|
|
||||||
"eslint": "^7.32.0",
|
|
||||||
"eslint-plugin-node": "^11.1.0",
|
|
||||||
"mock-aws-s3": "^4.0.2",
|
|
||||||
"nock": "^12.0.3",
|
|
||||||
"node-addon-api": "^4.3.0",
|
|
||||||
"nyc": "^15.1.0",
|
|
||||||
"tape": "^5.5.2",
|
|
||||||
"tar-fs": "^2.1.1"
|
|
||||||
},
|
|
||||||
"nyc": {
|
|
||||||
"all": true,
|
|
||||||
"skip-full": false,
|
|
||||||
"exclude": [
|
|
||||||
"test/**"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"coverage": "nyc --all --include index.js --include lib/ npm test",
|
|
||||||
"upload-coverage": "nyc report --reporter json && codecov --clear --flags=unit --file=./coverage/coverage-final.json",
|
|
||||||
"lint": "eslint bin/node-pre-gyp lib/*js lib/util/*js test/*js scripts/*js",
|
|
||||||
"fix": "npm run lint -- --fix",
|
|
||||||
"update-crosswalk": "node scripts/abi_crosswalk.js",
|
|
||||||
"test": "tape test/*test.js"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,46 +0,0 @@
|
|||||||
This software is dual-licensed under the ISC and MIT licenses.
|
|
||||||
You may use this software under EITHER of the following licenses.
|
|
||||||
|
|
||||||
----------
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
----------
|
|
||||||
|
|
||||||
Copyright Isaac Z. Schlueter and Contributors
|
|
||||||
All rights reserved.
|
|
||||||
|
|
||||||
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,23 +0,0 @@
|
|||||||
# abbrev-js
|
|
||||||
|
|
||||||
Just like [ruby's Abbrev](http://apidock.com/ruby/Abbrev).
|
|
||||||
|
|
||||||
Usage:
|
|
||||||
|
|
||||||
var abbrev = require("abbrev");
|
|
||||||
abbrev("foo", "fool", "folding", "flop");
|
|
||||||
|
|
||||||
// returns:
|
|
||||||
{ fl: 'flop'
|
|
||||||
, flo: 'flop'
|
|
||||||
, flop: 'flop'
|
|
||||||
, fol: 'folding'
|
|
||||||
, fold: 'folding'
|
|
||||||
, foldi: 'folding'
|
|
||||||
, foldin: 'folding'
|
|
||||||
, folding: 'folding'
|
|
||||||
, foo: 'foo'
|
|
||||||
, fool: 'fool'
|
|
||||||
}
|
|
||||||
|
|
||||||
This is handy for command-line scripts, or other cases where you want to be able to accept shorthands.
|
|
||||||
@ -1,61 +0,0 @@
|
|||||||
module.exports = exports = abbrev.abbrev = abbrev
|
|
||||||
|
|
||||||
abbrev.monkeyPatch = monkeyPatch
|
|
||||||
|
|
||||||
function monkeyPatch () {
|
|
||||||
Object.defineProperty(Array.prototype, 'abbrev', {
|
|
||||||
value: function () { return abbrev(this) },
|
|
||||||
enumerable: false, configurable: true, writable: true
|
|
||||||
})
|
|
||||||
|
|
||||||
Object.defineProperty(Object.prototype, 'abbrev', {
|
|
||||||
value: function () { return abbrev(Object.keys(this)) },
|
|
||||||
enumerable: false, configurable: true, writable: true
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
function abbrev (list) {
|
|
||||||
if (arguments.length !== 1 || !Array.isArray(list)) {
|
|
||||||
list = Array.prototype.slice.call(arguments, 0)
|
|
||||||
}
|
|
||||||
for (var i = 0, l = list.length, args = [] ; i < l ; i ++) {
|
|
||||||
args[i] = typeof list[i] === "string" ? list[i] : String(list[i])
|
|
||||||
}
|
|
||||||
|
|
||||||
// sort them lexicographically, so that they're next to their nearest kin
|
|
||||||
args = args.sort(lexSort)
|
|
||||||
|
|
||||||
// walk through each, seeing how much it has in common with the next and previous
|
|
||||||
var abbrevs = {}
|
|
||||||
, prev = ""
|
|
||||||
for (var i = 0, l = args.length ; i < l ; i ++) {
|
|
||||||
var current = args[i]
|
|
||||||
, next = args[i + 1] || ""
|
|
||||||
, nextMatches = true
|
|
||||||
, prevMatches = true
|
|
||||||
if (current === next) continue
|
|
||||||
for (var j = 0, cl = current.length ; j < cl ; j ++) {
|
|
||||||
var curChar = current.charAt(j)
|
|
||||||
nextMatches = nextMatches && curChar === next.charAt(j)
|
|
||||||
prevMatches = prevMatches && curChar === prev.charAt(j)
|
|
||||||
if (!nextMatches && !prevMatches) {
|
|
||||||
j ++
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
prev = current
|
|
||||||
if (j === cl) {
|
|
||||||
abbrevs[current] = current
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
for (var a = current.substr(0, j) ; j <= cl ; j ++) {
|
|
||||||
abbrevs[a] = current
|
|
||||||
a += current.charAt(j)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return abbrevs
|
|
||||||
}
|
|
||||||
|
|
||||||
function lexSort (a, b) {
|
|
||||||
return a === b ? 0 : a > b ? 1 : -1
|
|
||||||
}
|
|
||||||
@ -1,21 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "abbrev",
|
|
||||||
"version": "1.1.1",
|
|
||||||
"description": "Like ruby's abbrev module, but in js",
|
|
||||||
"author": "Isaac Z. Schlueter <i@izs.me>",
|
|
||||||
"main": "abbrev.js",
|
|
||||||
"scripts": {
|
|
||||||
"test": "tap test.js --100",
|
|
||||||
"preversion": "npm test",
|
|
||||||
"postversion": "npm publish",
|
|
||||||
"postpublish": "git push origin --all; git push origin --tags"
|
|
||||||
},
|
|
||||||
"repository": "http://github.com/isaacs/abbrev-js",
|
|
||||||
"license": "ISC",
|
|
||||||
"devDependencies": {
|
|
||||||
"tap": "^10.1"
|
|
||||||
},
|
|
||||||
"files": [
|
|
||||||
"abbrev.js"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@ -1,145 +0,0 @@
|
|||||||
agent-base
|
|
||||||
==========
|
|
||||||
### Turn a function into an [`http.Agent`][http.Agent] instance
|
|
||||||
[](https://github.com/TooTallNate/node-agent-base/actions?workflow=Node+CI)
|
|
||||||
|
|
||||||
This module provides an `http.Agent` generator. That is, you pass it an async
|
|
||||||
callback function, and it returns a new `http.Agent` instance that will invoke the
|
|
||||||
given callback function when sending outbound HTTP requests.
|
|
||||||
|
|
||||||
#### Some subclasses:
|
|
||||||
|
|
||||||
Here's some more interesting uses of `agent-base`.
|
|
||||||
Send a pull request to list yours!
|
|
||||||
|
|
||||||
* [`http-proxy-agent`][http-proxy-agent]: An HTTP(s) proxy `http.Agent` implementation for HTTP endpoints
|
|
||||||
* [`https-proxy-agent`][https-proxy-agent]: An HTTP(s) proxy `http.Agent` implementation for HTTPS endpoints
|
|
||||||
* [`pac-proxy-agent`][pac-proxy-agent]: A PAC file proxy `http.Agent` implementation for HTTP and HTTPS
|
|
||||||
* [`socks-proxy-agent`][socks-proxy-agent]: A SOCKS proxy `http.Agent` implementation for HTTP and HTTPS
|
|
||||||
|
|
||||||
|
|
||||||
Installation
|
|
||||||
------------
|
|
||||||
|
|
||||||
Install with `npm`:
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ npm install agent-base
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
Example
|
|
||||||
-------
|
|
||||||
|
|
||||||
Here's a minimal example that creates a new `net.Socket` connection to the server
|
|
||||||
for every HTTP request (i.e. the equivalent of `agent: false` option):
|
|
||||||
|
|
||||||
```js
|
|
||||||
var net = require('net');
|
|
||||||
var tls = require('tls');
|
|
||||||
var url = require('url');
|
|
||||||
var http = require('http');
|
|
||||||
var agent = require('agent-base');
|
|
||||||
|
|
||||||
var endpoint = 'http://nodejs.org/api/';
|
|
||||||
var parsed = url.parse(endpoint);
|
|
||||||
|
|
||||||
// This is the important part!
|
|
||||||
parsed.agent = agent(function (req, opts) {
|
|
||||||
var socket;
|
|
||||||
// `secureEndpoint` is true when using the https module
|
|
||||||
if (opts.secureEndpoint) {
|
|
||||||
socket = tls.connect(opts);
|
|
||||||
} else {
|
|
||||||
socket = net.connect(opts);
|
|
||||||
}
|
|
||||||
return socket;
|
|
||||||
});
|
|
||||||
|
|
||||||
// Everything else works just like normal...
|
|
||||||
http.get(parsed, function (res) {
|
|
||||||
console.log('"response" event!', res.headers);
|
|
||||||
res.pipe(process.stdout);
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
Returning a Promise or using an `async` function is also supported:
|
|
||||||
|
|
||||||
```js
|
|
||||||
agent(async function (req, opts) {
|
|
||||||
await sleep(1000);
|
|
||||||
// etc…
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
Return another `http.Agent` instance to "pass through" the responsibility
|
|
||||||
for that HTTP request to that agent:
|
|
||||||
|
|
||||||
```js
|
|
||||||
agent(function (req, opts) {
|
|
||||||
return opts.secureEndpoint ? https.globalAgent : http.globalAgent;
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
API
|
|
||||||
---
|
|
||||||
|
|
||||||
## Agent(Function callback[, Object options]) → [http.Agent][]
|
|
||||||
|
|
||||||
Creates a base `http.Agent` that will execute the callback function `callback`
|
|
||||||
for every HTTP request that it is used as the `agent` for. The callback function
|
|
||||||
is responsible for creating a `stream.Duplex` instance of some kind that will be
|
|
||||||
used as the underlying socket in the HTTP request.
|
|
||||||
|
|
||||||
The `options` object accepts the following properties:
|
|
||||||
|
|
||||||
* `timeout` - Number - Timeout for the `callback()` function in milliseconds. Defaults to Infinity (optional).
|
|
||||||
|
|
||||||
The callback function should have the following signature:
|
|
||||||
|
|
||||||
### callback(http.ClientRequest req, Object options, Function cb) → undefined
|
|
||||||
|
|
||||||
The ClientRequest `req` can be accessed to read request headers and
|
|
||||||
and the path, etc. The `options` object contains the options passed
|
|
||||||
to the `http.request()`/`https.request()` function call, and is formatted
|
|
||||||
to be directly passed to `net.connect()`/`tls.connect()`, or however
|
|
||||||
else you want a Socket to be created. Pass the created socket to
|
|
||||||
the callback function `cb` once created, and the HTTP request will
|
|
||||||
continue to proceed.
|
|
||||||
|
|
||||||
If the `https` module is used to invoke the HTTP request, then the
|
|
||||||
`secureEndpoint` property on `options` _will be set to `true`_.
|
|
||||||
|
|
||||||
|
|
||||||
License
|
|
||||||
-------
|
|
||||||
|
|
||||||
(The MIT License)
|
|
||||||
|
|
||||||
Copyright (c) 2013 Nathan Rajlich <nathan@tootallnate.net>
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
[http-proxy-agent]: https://github.com/TooTallNate/node-http-proxy-agent
|
|
||||||
[https-proxy-agent]: https://github.com/TooTallNate/node-https-proxy-agent
|
|
||||||
[pac-proxy-agent]: https://github.com/TooTallNate/node-pac-proxy-agent
|
|
||||||
[socks-proxy-agent]: https://github.com/TooTallNate/node-socks-proxy-agent
|
|
||||||
[http.Agent]: https://nodejs.org/api/http.html#http_class_http_agent
|
|
||||||
@ -1,78 +0,0 @@
|
|||||||
/// <reference types="node" />
|
|
||||||
import net from 'net';
|
|
||||||
import http from 'http';
|
|
||||||
import https from 'https';
|
|
||||||
import { Duplex } from 'stream';
|
|
||||||
import { EventEmitter } from 'events';
|
|
||||||
declare function createAgent(opts?: createAgent.AgentOptions): createAgent.Agent;
|
|
||||||
declare function createAgent(callback: createAgent.AgentCallback, opts?: createAgent.AgentOptions): createAgent.Agent;
|
|
||||||
declare namespace createAgent {
|
|
||||||
interface ClientRequest extends http.ClientRequest {
|
|
||||||
_last?: boolean;
|
|
||||||
_hadError?: boolean;
|
|
||||||
method: string;
|
|
||||||
}
|
|
||||||
interface AgentRequestOptions {
|
|
||||||
host?: string;
|
|
||||||
path?: string;
|
|
||||||
port: number;
|
|
||||||
}
|
|
||||||
interface HttpRequestOptions extends AgentRequestOptions, Omit<http.RequestOptions, keyof AgentRequestOptions> {
|
|
||||||
secureEndpoint: false;
|
|
||||||
}
|
|
||||||
interface HttpsRequestOptions extends AgentRequestOptions, Omit<https.RequestOptions, keyof AgentRequestOptions> {
|
|
||||||
secureEndpoint: true;
|
|
||||||
}
|
|
||||||
type RequestOptions = HttpRequestOptions | HttpsRequestOptions;
|
|
||||||
type AgentLike = Pick<createAgent.Agent, 'addRequest'> | http.Agent;
|
|
||||||
type AgentCallbackReturn = Duplex | AgentLike;
|
|
||||||
type AgentCallbackCallback = (err?: Error | null, socket?: createAgent.AgentCallbackReturn) => void;
|
|
||||||
type AgentCallbackPromise = (req: createAgent.ClientRequest, opts: createAgent.RequestOptions) => createAgent.AgentCallbackReturn | Promise<createAgent.AgentCallbackReturn>;
|
|
||||||
type AgentCallback = typeof Agent.prototype.callback;
|
|
||||||
type AgentOptions = {
|
|
||||||
timeout?: number;
|
|
||||||
};
|
|
||||||
/**
|
|
||||||
* Base `http.Agent` implementation.
|
|
||||||
* No pooling/keep-alive is implemented by default.
|
|
||||||
*
|
|
||||||
* @param {Function} callback
|
|
||||||
* @api public
|
|
||||||
*/
|
|
||||||
class Agent extends EventEmitter {
|
|
||||||
timeout: number | null;
|
|
||||||
maxFreeSockets: number;
|
|
||||||
maxTotalSockets: number;
|
|
||||||
maxSockets: number;
|
|
||||||
sockets: {
|
|
||||||
[key: string]: net.Socket[];
|
|
||||||
};
|
|
||||||
freeSockets: {
|
|
||||||
[key: string]: net.Socket[];
|
|
||||||
};
|
|
||||||
requests: {
|
|
||||||
[key: string]: http.IncomingMessage[];
|
|
||||||
};
|
|
||||||
options: https.AgentOptions;
|
|
||||||
private promisifiedCallback?;
|
|
||||||
private explicitDefaultPort?;
|
|
||||||
private explicitProtocol?;
|
|
||||||
constructor(callback?: createAgent.AgentCallback | createAgent.AgentOptions, _opts?: createAgent.AgentOptions);
|
|
||||||
get defaultPort(): number;
|
|
||||||
set defaultPort(v: number);
|
|
||||||
get protocol(): string;
|
|
||||||
set protocol(v: string);
|
|
||||||
callback(req: createAgent.ClientRequest, opts: createAgent.RequestOptions, fn: createAgent.AgentCallbackCallback): void;
|
|
||||||
callback(req: createAgent.ClientRequest, opts: createAgent.RequestOptions): createAgent.AgentCallbackReturn | Promise<createAgent.AgentCallbackReturn>;
|
|
||||||
/**
|
|
||||||
* Called by node-core's "_http_client.js" module when creating
|
|
||||||
* a new HTTP request with this Agent instance.
|
|
||||||
*
|
|
||||||
* @api public
|
|
||||||
*/
|
|
||||||
addRequest(req: ClientRequest, _opts: RequestOptions): void;
|
|
||||||
freeSocket(socket: net.Socket, opts: AgentOptions): void;
|
|
||||||
destroy(): void;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
export = createAgent;
|
|
||||||
@ -1,203 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
||||||
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
||||||
};
|
|
||||||
const events_1 = require("events");
|
|
||||||
const debug_1 = __importDefault(require("debug"));
|
|
||||||
const promisify_1 = __importDefault(require("./promisify"));
|
|
||||||
const debug = debug_1.default('agent-base');
|
|
||||||
function isAgent(v) {
|
|
||||||
return Boolean(v) && typeof v.addRequest === 'function';
|
|
||||||
}
|
|
||||||
function isSecureEndpoint() {
|
|
||||||
const { stack } = new Error();
|
|
||||||
if (typeof stack !== 'string')
|
|
||||||
return false;
|
|
||||||
return stack.split('\n').some(l => l.indexOf('(https.js:') !== -1 || l.indexOf('node:https:') !== -1);
|
|
||||||
}
|
|
||||||
function createAgent(callback, opts) {
|
|
||||||
return new createAgent.Agent(callback, opts);
|
|
||||||
}
|
|
||||||
(function (createAgent) {
|
|
||||||
/**
|
|
||||||
* Base `http.Agent` implementation.
|
|
||||||
* No pooling/keep-alive is implemented by default.
|
|
||||||
*
|
|
||||||
* @param {Function} callback
|
|
||||||
* @api public
|
|
||||||
*/
|
|
||||||
class Agent extends events_1.EventEmitter {
|
|
||||||
constructor(callback, _opts) {
|
|
||||||
super();
|
|
||||||
let opts = _opts;
|
|
||||||
if (typeof callback === 'function') {
|
|
||||||
this.callback = callback;
|
|
||||||
}
|
|
||||||
else if (callback) {
|
|
||||||
opts = callback;
|
|
||||||
}
|
|
||||||
// Timeout for the socket to be returned from the callback
|
|
||||||
this.timeout = null;
|
|
||||||
if (opts && typeof opts.timeout === 'number') {
|
|
||||||
this.timeout = opts.timeout;
|
|
||||||
}
|
|
||||||
// These aren't actually used by `agent-base`, but are required
|
|
||||||
// for the TypeScript definition files in `@types/node` :/
|
|
||||||
this.maxFreeSockets = 1;
|
|
||||||
this.maxSockets = 1;
|
|
||||||
this.maxTotalSockets = Infinity;
|
|
||||||
this.sockets = {};
|
|
||||||
this.freeSockets = {};
|
|
||||||
this.requests = {};
|
|
||||||
this.options = {};
|
|
||||||
}
|
|
||||||
get defaultPort() {
|
|
||||||
if (typeof this.explicitDefaultPort === 'number') {
|
|
||||||
return this.explicitDefaultPort;
|
|
||||||
}
|
|
||||||
return isSecureEndpoint() ? 443 : 80;
|
|
||||||
}
|
|
||||||
set defaultPort(v) {
|
|
||||||
this.explicitDefaultPort = v;
|
|
||||||
}
|
|
||||||
get protocol() {
|
|
||||||
if (typeof this.explicitProtocol === 'string') {
|
|
||||||
return this.explicitProtocol;
|
|
||||||
}
|
|
||||||
return isSecureEndpoint() ? 'https:' : 'http:';
|
|
||||||
}
|
|
||||||
set protocol(v) {
|
|
||||||
this.explicitProtocol = v;
|
|
||||||
}
|
|
||||||
callback(req, opts, fn) {
|
|
||||||
throw new Error('"agent-base" has no default implementation, you must subclass and override `callback()`');
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* Called by node-core's "_http_client.js" module when creating
|
|
||||||
* a new HTTP request with this Agent instance.
|
|
||||||
*
|
|
||||||
* @api public
|
|
||||||
*/
|
|
||||||
addRequest(req, _opts) {
|
|
||||||
const opts = Object.assign({}, _opts);
|
|
||||||
if (typeof opts.secureEndpoint !== 'boolean') {
|
|
||||||
opts.secureEndpoint = isSecureEndpoint();
|
|
||||||
}
|
|
||||||
if (opts.host == null) {
|
|
||||||
opts.host = 'localhost';
|
|
||||||
}
|
|
||||||
if (opts.port == null) {
|
|
||||||
opts.port = opts.secureEndpoint ? 443 : 80;
|
|
||||||
}
|
|
||||||
if (opts.protocol == null) {
|
|
||||||
opts.protocol = opts.secureEndpoint ? 'https:' : 'http:';
|
|
||||||
}
|
|
||||||
if (opts.host && opts.path) {
|
|
||||||
// If both a `host` and `path` are specified then it's most
|
|
||||||
// likely the result of a `url.parse()` call... we need to
|
|
||||||
// remove the `path` portion so that `net.connect()` doesn't
|
|
||||||
// attempt to open that as a unix socket file.
|
|
||||||
delete opts.path;
|
|
||||||
}
|
|
||||||
delete opts.agent;
|
|
||||||
delete opts.hostname;
|
|
||||||
delete opts._defaultAgent;
|
|
||||||
delete opts.defaultPort;
|
|
||||||
delete opts.createConnection;
|
|
||||||
// Hint to use "Connection: close"
|
|
||||||
// XXX: non-documented `http` module API :(
|
|
||||||
req._last = true;
|
|
||||||
req.shouldKeepAlive = false;
|
|
||||||
let timedOut = false;
|
|
||||||
let timeoutId = null;
|
|
||||||
const timeoutMs = opts.timeout || this.timeout;
|
|
||||||
const onerror = (err) => {
|
|
||||||
if (req._hadError)
|
|
||||||
return;
|
|
||||||
req.emit('error', err);
|
|
||||||
// For Safety. Some additional errors might fire later on
|
|
||||||
// and we need to make sure we don't double-fire the error event.
|
|
||||||
req._hadError = true;
|
|
||||||
};
|
|
||||||
const ontimeout = () => {
|
|
||||||
timeoutId = null;
|
|
||||||
timedOut = true;
|
|
||||||
const err = new Error(`A "socket" was not created for HTTP request before ${timeoutMs}ms`);
|
|
||||||
err.code = 'ETIMEOUT';
|
|
||||||
onerror(err);
|
|
||||||
};
|
|
||||||
const callbackError = (err) => {
|
|
||||||
if (timedOut)
|
|
||||||
return;
|
|
||||||
if (timeoutId !== null) {
|
|
||||||
clearTimeout(timeoutId);
|
|
||||||
timeoutId = null;
|
|
||||||
}
|
|
||||||
onerror(err);
|
|
||||||
};
|
|
||||||
const onsocket = (socket) => {
|
|
||||||
if (timedOut)
|
|
||||||
return;
|
|
||||||
if (timeoutId != null) {
|
|
||||||
clearTimeout(timeoutId);
|
|
||||||
timeoutId = null;
|
|
||||||
}
|
|
||||||
if (isAgent(socket)) {
|
|
||||||
// `socket` is actually an `http.Agent` instance, so
|
|
||||||
// relinquish responsibility for this `req` to the Agent
|
|
||||||
// from here on
|
|
||||||
debug('Callback returned another Agent instance %o', socket.constructor.name);
|
|
||||||
socket.addRequest(req, opts);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (socket) {
|
|
||||||
socket.once('free', () => {
|
|
||||||
this.freeSocket(socket, opts);
|
|
||||||
});
|
|
||||||
req.onSocket(socket);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const err = new Error(`no Duplex stream was returned to agent-base for \`${req.method} ${req.path}\``);
|
|
||||||
onerror(err);
|
|
||||||
};
|
|
||||||
if (typeof this.callback !== 'function') {
|
|
||||||
onerror(new Error('`callback` is not defined'));
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (!this.promisifiedCallback) {
|
|
||||||
if (this.callback.length >= 3) {
|
|
||||||
debug('Converting legacy callback function to promise');
|
|
||||||
this.promisifiedCallback = promisify_1.default(this.callback);
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
this.promisifiedCallback = this.callback;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (typeof timeoutMs === 'number' && timeoutMs > 0) {
|
|
||||||
timeoutId = setTimeout(ontimeout, timeoutMs);
|
|
||||||
}
|
|
||||||
if ('port' in opts && typeof opts.port !== 'number') {
|
|
||||||
opts.port = Number(opts.port);
|
|
||||||
}
|
|
||||||
try {
|
|
||||||
debug('Resolving socket for %o request: %o', opts.protocol, `${req.method} ${req.path}`);
|
|
||||||
Promise.resolve(this.promisifiedCallback(req, opts)).then(onsocket, callbackError);
|
|
||||||
}
|
|
||||||
catch (err) {
|
|
||||||
Promise.reject(err).catch(callbackError);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
freeSocket(socket, opts) {
|
|
||||||
debug('Freeing socket %o %o', socket.constructor.name, opts);
|
|
||||||
socket.destroy();
|
|
||||||
}
|
|
||||||
destroy() {
|
|
||||||
debug('Destroying agent %o', this.constructor.name);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
createAgent.Agent = Agent;
|
|
||||||
// So that `instanceof` works correctly
|
|
||||||
createAgent.prototype = createAgent.Agent.prototype;
|
|
||||||
})(createAgent || (createAgent = {}));
|
|
||||||
module.exports = createAgent;
|
|
||||||
//# sourceMappingURL=index.js.map
|
|
||||||
File diff suppressed because one or more lines are too long
@ -1,4 +0,0 @@
|
|||||||
import { ClientRequest, RequestOptions, AgentCallbackCallback, AgentCallbackPromise } from './index';
|
|
||||||
declare type LegacyCallback = (req: ClientRequest, opts: RequestOptions, fn: AgentCallbackCallback) => void;
|
|
||||||
export default function promisify(fn: LegacyCallback): AgentCallbackPromise;
|
|
||||||
export {};
|
|
||||||
@ -1,18 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
function promisify(fn) {
|
|
||||||
return function (req, opts) {
|
|
||||||
return new Promise((resolve, reject) => {
|
|
||||||
fn.call(this, req, opts, (err, rtn) => {
|
|
||||||
if (err) {
|
|
||||||
reject(err);
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
resolve(rtn);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
});
|
|
||||||
};
|
|
||||||
}
|
|
||||||
exports.default = promisify;
|
|
||||||
//# sourceMappingURL=promisify.js.map
|
|
||||||
@ -1 +0,0 @@
|
|||||||
{"version":3,"file":"promisify.js","sourceRoot":"","sources":["../../src/promisify.ts"],"names":[],"mappings":";;AAeA,SAAwB,SAAS,CAAC,EAAkB;IACnD,OAAO,UAAsB,GAAkB,EAAE,IAAoB;QACpE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACtC,EAAE,CAAC,IAAI,CACN,IAAI,EACJ,GAAG,EACH,IAAI,EACJ,CAAC,GAA6B,EAAE,GAAyB,EAAE,EAAE;gBAC5D,IAAI,GAAG,EAAE;oBACR,MAAM,CAAC,GAAG,CAAC,CAAC;iBACZ;qBAAM;oBACN,OAAO,CAAC,GAAG,CAAC,CAAC;iBACb;YACF,CAAC,CACD,CAAC;QACH,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC;AACH,CAAC;AAjBD,4BAiBC"}
|
|
||||||
@ -1,20 +0,0 @@
|
|||||||
(The MIT License)
|
|
||||||
|
|
||||||
Copyright (c) 2014-2017 TJ Holowaychuk <tj@vision-media.ca>
|
|
||||||
Copyright (c) 2018-2021 Josh Junon
|
|
||||||
|
|
||||||
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,481 +0,0 @@
|
|||||||
# debug
|
|
||||||
[](https://travis-ci.org/debug-js/debug) [](https://coveralls.io/github/debug-js/debug?branch=master) [](https://visionmedia-community-slackin.now.sh/) [](#backers)
|
|
||||||
[](#sponsors)
|
|
||||||
|
|
||||||
<img width="647" src="https://user-images.githubusercontent.com/71256/29091486-fa38524c-7c37-11e7-895f-e7ec8e1039b6.png">
|
|
||||||
|
|
||||||
A tiny JavaScript debugging utility modelled after Node.js core's debugging
|
|
||||||
technique. Works in Node.js and web browsers.
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ npm install debug
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
`debug` exposes a function; simply pass this function the name of your module, and it will return a decorated version of `console.error` for you to pass debug statements to. This will allow you to toggle the debug output for different parts of your module as well as the module as a whole.
|
|
||||||
|
|
||||||
Example [_app.js_](./examples/node/app.js):
|
|
||||||
|
|
||||||
```js
|
|
||||||
var debug = require('debug')('http')
|
|
||||||
, http = require('http')
|
|
||||||
, name = 'My App';
|
|
||||||
|
|
||||||
// fake app
|
|
||||||
|
|
||||||
debug('booting %o', name);
|
|
||||||
|
|
||||||
http.createServer(function(req, res){
|
|
||||||
debug(req.method + ' ' + req.url);
|
|
||||||
res.end('hello\n');
|
|
||||||
}).listen(3000, function(){
|
|
||||||
debug('listening');
|
|
||||||
});
|
|
||||||
|
|
||||||
// fake worker of some kind
|
|
||||||
|
|
||||||
require('./worker');
|
|
||||||
```
|
|
||||||
|
|
||||||
Example [_worker.js_](./examples/node/worker.js):
|
|
||||||
|
|
||||||
```js
|
|
||||||
var a = require('debug')('worker:a')
|
|
||||||
, b = require('debug')('worker:b');
|
|
||||||
|
|
||||||
function work() {
|
|
||||||
a('doing lots of uninteresting work');
|
|
||||||
setTimeout(work, Math.random() * 1000);
|
|
||||||
}
|
|
||||||
|
|
||||||
work();
|
|
||||||
|
|
||||||
function workb() {
|
|
||||||
b('doing some work');
|
|
||||||
setTimeout(workb, Math.random() * 2000);
|
|
||||||
}
|
|
||||||
|
|
||||||
workb();
|
|
||||||
```
|
|
||||||
|
|
||||||
The `DEBUG` environment variable is then used to enable these based on space or
|
|
||||||
comma-delimited names.
|
|
||||||
|
|
||||||
Here are some examples:
|
|
||||||
|
|
||||||
<img width="647" alt="screen shot 2017-08-08 at 12 53 04 pm" src="https://user-images.githubusercontent.com/71256/29091703-a6302cdc-7c38-11e7-8304-7c0b3bc600cd.png">
|
|
||||||
<img width="647" alt="screen shot 2017-08-08 at 12 53 38 pm" src="https://user-images.githubusercontent.com/71256/29091700-a62a6888-7c38-11e7-800b-db911291ca2b.png">
|
|
||||||
<img width="647" alt="screen shot 2017-08-08 at 12 53 25 pm" src="https://user-images.githubusercontent.com/71256/29091701-a62ea114-7c38-11e7-826a-2692bedca740.png">
|
|
||||||
|
|
||||||
#### Windows command prompt notes
|
|
||||||
|
|
||||||
##### CMD
|
|
||||||
|
|
||||||
On Windows the environment variable is set using the `set` command.
|
|
||||||
|
|
||||||
```cmd
|
|
||||||
set DEBUG=*,-not_this
|
|
||||||
```
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
```cmd
|
|
||||||
set DEBUG=* & node app.js
|
|
||||||
```
|
|
||||||
|
|
||||||
##### PowerShell (VS Code default)
|
|
||||||
|
|
||||||
PowerShell uses different syntax to set environment variables.
|
|
||||||
|
|
||||||
```cmd
|
|
||||||
$env:DEBUG = "*,-not_this"
|
|
||||||
```
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
```cmd
|
|
||||||
$env:DEBUG='app';node app.js
|
|
||||||
```
|
|
||||||
|
|
||||||
Then, run the program to be debugged as usual.
|
|
||||||
|
|
||||||
npm script example:
|
|
||||||
```js
|
|
||||||
"windowsDebug": "@powershell -Command $env:DEBUG='*';node app.js",
|
|
||||||
```
|
|
||||||
|
|
||||||
## Namespace Colors
|
|
||||||
|
|
||||||
Every debug instance has a color generated for it based on its namespace name.
|
|
||||||
This helps when visually parsing the debug output to identify which debug instance
|
|
||||||
a debug line belongs to.
|
|
||||||
|
|
||||||
#### Node.js
|
|
||||||
|
|
||||||
In Node.js, colors are enabled when stderr is a TTY. You also _should_ install
|
|
||||||
the [`supports-color`](https://npmjs.org/supports-color) module alongside debug,
|
|
||||||
otherwise debug will only use a small handful of basic colors.
|
|
||||||
|
|
||||||
<img width="521" src="https://user-images.githubusercontent.com/71256/29092181-47f6a9e6-7c3a-11e7-9a14-1928d8a711cd.png">
|
|
||||||
|
|
||||||
#### Web Browser
|
|
||||||
|
|
||||||
Colors are also enabled on "Web Inspectors" that understand the `%c` formatting
|
|
||||||
option. These are WebKit web inspectors, Firefox ([since version
|
|
||||||
31](https://hacks.mozilla.org/2014/05/editable-box-model-multiple-selection-sublime-text-keys-much-more-firefox-developer-tools-episode-31/))
|
|
||||||
and the Firebug plugin for Firefox (any version).
|
|
||||||
|
|
||||||
<img width="524" src="https://user-images.githubusercontent.com/71256/29092033-b65f9f2e-7c39-11e7-8e32-f6f0d8e865c1.png">
|
|
||||||
|
|
||||||
|
|
||||||
## Millisecond diff
|
|
||||||
|
|
||||||
When actively developing an application it can be useful to see when the time spent between one `debug()` call and the next. Suppose for example you invoke `debug()` before requesting a resource, and after as well, the "+NNNms" will show you how much time was spent between calls.
|
|
||||||
|
|
||||||
<img width="647" src="https://user-images.githubusercontent.com/71256/29091486-fa38524c-7c37-11e7-895f-e7ec8e1039b6.png">
|
|
||||||
|
|
||||||
When stdout is not a TTY, `Date#toISOString()` is used, making it more useful for logging the debug information as shown below:
|
|
||||||
|
|
||||||
<img width="647" src="https://user-images.githubusercontent.com/71256/29091956-6bd78372-7c39-11e7-8c55-c948396d6edd.png">
|
|
||||||
|
|
||||||
|
|
||||||
## Conventions
|
|
||||||
|
|
||||||
If you're using this in one or more of your libraries, you _should_ use the name of your library so that developers may toggle debugging as desired without guessing names. If you have more than one debuggers you _should_ prefix them with your library name and use ":" to separate features. For example "bodyParser" from Connect would then be "connect:bodyParser". If you append a "*" to the end of your name, it will always be enabled regardless of the setting of the DEBUG environment variable. You can then use it for normal output as well as debug output.
|
|
||||||
|
|
||||||
## Wildcards
|
|
||||||
|
|
||||||
The `*` character may be used as a wildcard. Suppose for example your library has
|
|
||||||
debuggers named "connect:bodyParser", "connect:compress", "connect:session",
|
|
||||||
instead of listing all three with
|
|
||||||
`DEBUG=connect:bodyParser,connect:compress,connect:session`, you may simply do
|
|
||||||
`DEBUG=connect:*`, or to run everything using this module simply use `DEBUG=*`.
|
|
||||||
|
|
||||||
You can also exclude specific debuggers by prefixing them with a "-" character.
|
|
||||||
For example, `DEBUG=*,-connect:*` would include all debuggers except those
|
|
||||||
starting with "connect:".
|
|
||||||
|
|
||||||
## Environment Variables
|
|
||||||
|
|
||||||
When running through Node.js, you can set a few environment variables that will
|
|
||||||
change the behavior of the debug logging:
|
|
||||||
|
|
||||||
| Name | Purpose |
|
|
||||||
|-----------|-------------------------------------------------|
|
|
||||||
| `DEBUG` | Enables/disables specific debugging namespaces. |
|
|
||||||
| `DEBUG_HIDE_DATE` | Hide date from debug output (non-TTY). |
|
|
||||||
| `DEBUG_COLORS`| Whether or not to use colors in the debug output. |
|
|
||||||
| `DEBUG_DEPTH` | Object inspection depth. |
|
|
||||||
| `DEBUG_SHOW_HIDDEN` | Shows hidden properties on inspected objects. |
|
|
||||||
|
|
||||||
|
|
||||||
__Note:__ The environment variables beginning with `DEBUG_` end up being
|
|
||||||
converted into an Options object that gets used with `%o`/`%O` formatters.
|
|
||||||
See the Node.js documentation for
|
|
||||||
[`util.inspect()`](https://nodejs.org/api/util.html#util_util_inspect_object_options)
|
|
||||||
for the complete list.
|
|
||||||
|
|
||||||
## Formatters
|
|
||||||
|
|
||||||
Debug uses [printf-style](https://wikipedia.org/wiki/Printf_format_string) formatting.
|
|
||||||
Below are the officially supported formatters:
|
|
||||||
|
|
||||||
| Formatter | Representation |
|
|
||||||
|-----------|----------------|
|
|
||||||
| `%O` | Pretty-print an Object on multiple lines. |
|
|
||||||
| `%o` | Pretty-print an Object all on a single line. |
|
|
||||||
| `%s` | String. |
|
|
||||||
| `%d` | Number (both integer and float). |
|
|
||||||
| `%j` | JSON. Replaced with the string '[Circular]' if the argument contains circular references. |
|
|
||||||
| `%%` | Single percent sign ('%'). This does not consume an argument. |
|
|
||||||
|
|
||||||
|
|
||||||
### Custom formatters
|
|
||||||
|
|
||||||
You can add custom formatters by extending the `debug.formatters` object.
|
|
||||||
For example, if you wanted to add support for rendering a Buffer as hex with
|
|
||||||
`%h`, you could do something like:
|
|
||||||
|
|
||||||
```js
|
|
||||||
const createDebug = require('debug')
|
|
||||||
createDebug.formatters.h = (v) => {
|
|
||||||
return v.toString('hex')
|
|
||||||
}
|
|
||||||
|
|
||||||
// …elsewhere
|
|
||||||
const debug = createDebug('foo')
|
|
||||||
debug('this is hex: %h', new Buffer('hello world'))
|
|
||||||
// foo this is hex: 68656c6c6f20776f726c6421 +0ms
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Browser Support
|
|
||||||
|
|
||||||
You can build a browser-ready script using [browserify](https://github.com/substack/node-browserify),
|
|
||||||
or just use the [browserify-as-a-service](https://wzrd.in/) [build](https://wzrd.in/standalone/debug@latest),
|
|
||||||
if you don't want to build it yourself.
|
|
||||||
|
|
||||||
Debug's enable state is currently persisted by `localStorage`.
|
|
||||||
Consider the situation shown below where you have `worker:a` and `worker:b`,
|
|
||||||
and wish to debug both. You can enable this using `localStorage.debug`:
|
|
||||||
|
|
||||||
```js
|
|
||||||
localStorage.debug = 'worker:*'
|
|
||||||
```
|
|
||||||
|
|
||||||
And then refresh the page.
|
|
||||||
|
|
||||||
```js
|
|
||||||
a = debug('worker:a');
|
|
||||||
b = debug('worker:b');
|
|
||||||
|
|
||||||
setInterval(function(){
|
|
||||||
a('doing some work');
|
|
||||||
}, 1000);
|
|
||||||
|
|
||||||
setInterval(function(){
|
|
||||||
b('doing some work');
|
|
||||||
}, 1200);
|
|
||||||
```
|
|
||||||
|
|
||||||
In Chromium-based web browsers (e.g. Brave, Chrome, and Electron), the JavaScript console will—by default—only show messages logged by `debug` if the "Verbose" log level is _enabled_.
|
|
||||||
|
|
||||||
<img width="647" src="https://user-images.githubusercontent.com/7143133/152083257-29034707-c42c-4959-8add-3cee850e6fcf.png">
|
|
||||||
|
|
||||||
## Output streams
|
|
||||||
|
|
||||||
By default `debug` will log to stderr, however this can be configured per-namespace by overriding the `log` method:
|
|
||||||
|
|
||||||
Example [_stdout.js_](./examples/node/stdout.js):
|
|
||||||
|
|
||||||
```js
|
|
||||||
var debug = require('debug');
|
|
||||||
var error = debug('app:error');
|
|
||||||
|
|
||||||
// by default stderr is used
|
|
||||||
error('goes to stderr!');
|
|
||||||
|
|
||||||
var log = debug('app:log');
|
|
||||||
// set this namespace to log via console.log
|
|
||||||
log.log = console.log.bind(console); // don't forget to bind to console!
|
|
||||||
log('goes to stdout');
|
|
||||||
error('still goes to stderr!');
|
|
||||||
|
|
||||||
// set all output to go via console.info
|
|
||||||
// overrides all per-namespace log settings
|
|
||||||
debug.log = console.info.bind(console);
|
|
||||||
error('now goes to stdout via console.info');
|
|
||||||
log('still goes to stdout, but via console.info now');
|
|
||||||
```
|
|
||||||
|
|
||||||
## Extend
|
|
||||||
You can simply extend debugger
|
|
||||||
```js
|
|
||||||
const log = require('debug')('auth');
|
|
||||||
|
|
||||||
//creates new debug instance with extended namespace
|
|
||||||
const logSign = log.extend('sign');
|
|
||||||
const logLogin = log.extend('login');
|
|
||||||
|
|
||||||
log('hello'); // auth hello
|
|
||||||
logSign('hello'); //auth:sign hello
|
|
||||||
logLogin('hello'); //auth:login hello
|
|
||||||
```
|
|
||||||
|
|
||||||
## Set dynamically
|
|
||||||
|
|
||||||
You can also enable debug dynamically by calling the `enable()` method :
|
|
||||||
|
|
||||||
```js
|
|
||||||
let debug = require('debug');
|
|
||||||
|
|
||||||
console.log(1, debug.enabled('test'));
|
|
||||||
|
|
||||||
debug.enable('test');
|
|
||||||
console.log(2, debug.enabled('test'));
|
|
||||||
|
|
||||||
debug.disable();
|
|
||||||
console.log(3, debug.enabled('test'));
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
print :
|
|
||||||
```
|
|
||||||
1 false
|
|
||||||
2 true
|
|
||||||
3 false
|
|
||||||
```
|
|
||||||
|
|
||||||
Usage :
|
|
||||||
`enable(namespaces)`
|
|
||||||
`namespaces` can include modes separated by a colon and wildcards.
|
|
||||||
|
|
||||||
Note that calling `enable()` completely overrides previously set DEBUG variable :
|
|
||||||
|
|
||||||
```
|
|
||||||
$ DEBUG=foo node -e 'var dbg = require("debug"); dbg.enable("bar"); console.log(dbg.enabled("foo"))'
|
|
||||||
=> false
|
|
||||||
```
|
|
||||||
|
|
||||||
`disable()`
|
|
||||||
|
|
||||||
Will disable all namespaces. The functions returns the namespaces currently
|
|
||||||
enabled (and skipped). This can be useful if you want to disable debugging
|
|
||||||
temporarily without knowing what was enabled to begin with.
|
|
||||||
|
|
||||||
For example:
|
|
||||||
|
|
||||||
```js
|
|
||||||
let debug = require('debug');
|
|
||||||
debug.enable('foo:*,-foo:bar');
|
|
||||||
let namespaces = debug.disable();
|
|
||||||
debug.enable(namespaces);
|
|
||||||
```
|
|
||||||
|
|
||||||
Note: There is no guarantee that the string will be identical to the initial
|
|
||||||
enable string, but semantically they will be identical.
|
|
||||||
|
|
||||||
## Checking whether a debug target is enabled
|
|
||||||
|
|
||||||
After you've created a debug instance, you can determine whether or not it is
|
|
||||||
enabled by checking the `enabled` property:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
const debug = require('debug')('http');
|
|
||||||
|
|
||||||
if (debug.enabled) {
|
|
||||||
// do stuff...
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
You can also manually toggle this property to force the debug instance to be
|
|
||||||
enabled or disabled.
|
|
||||||
|
|
||||||
## Usage in child processes
|
|
||||||
|
|
||||||
Due to the way `debug` detects if the output is a TTY or not, colors are not shown in child processes when `stderr` is piped. A solution is to pass the `DEBUG_COLORS=1` environment variable to the child process.
|
|
||||||
For example:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
worker = fork(WORKER_WRAP_PATH, [workerPath], {
|
|
||||||
stdio: [
|
|
||||||
/* stdin: */ 0,
|
|
||||||
/* stdout: */ 'pipe',
|
|
||||||
/* stderr: */ 'pipe',
|
|
||||||
'ipc',
|
|
||||||
],
|
|
||||||
env: Object.assign({}, process.env, {
|
|
||||||
DEBUG_COLORS: 1 // without this settings, colors won't be shown
|
|
||||||
}),
|
|
||||||
});
|
|
||||||
|
|
||||||
worker.stderr.pipe(process.stderr, { end: false });
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Authors
|
|
||||||
|
|
||||||
- TJ Holowaychuk
|
|
||||||
- Nathan Rajlich
|
|
||||||
- Andrew Rhyne
|
|
||||||
- Josh Junon
|
|
||||||
|
|
||||||
## Backers
|
|
||||||
|
|
||||||
Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/debug#backer)]
|
|
||||||
|
|
||||||
<a href="https://opencollective.com/debug/backer/0/website" target="_blank"><img src="https://opencollective.com/debug/backer/0/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/1/website" target="_blank"><img src="https://opencollective.com/debug/backer/1/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/2/website" target="_blank"><img src="https://opencollective.com/debug/backer/2/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/3/website" target="_blank"><img src="https://opencollective.com/debug/backer/3/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/4/website" target="_blank"><img src="https://opencollective.com/debug/backer/4/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/5/website" target="_blank"><img src="https://opencollective.com/debug/backer/5/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/6/website" target="_blank"><img src="https://opencollective.com/debug/backer/6/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/7/website" target="_blank"><img src="https://opencollective.com/debug/backer/7/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/8/website" target="_blank"><img src="https://opencollective.com/debug/backer/8/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/9/website" target="_blank"><img src="https://opencollective.com/debug/backer/9/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/10/website" target="_blank"><img src="https://opencollective.com/debug/backer/10/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/11/website" target="_blank"><img src="https://opencollective.com/debug/backer/11/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/12/website" target="_blank"><img src="https://opencollective.com/debug/backer/12/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/13/website" target="_blank"><img src="https://opencollective.com/debug/backer/13/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/14/website" target="_blank"><img src="https://opencollective.com/debug/backer/14/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/15/website" target="_blank"><img src="https://opencollective.com/debug/backer/15/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/16/website" target="_blank"><img src="https://opencollective.com/debug/backer/16/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/17/website" target="_blank"><img src="https://opencollective.com/debug/backer/17/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/18/website" target="_blank"><img src="https://opencollective.com/debug/backer/18/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/19/website" target="_blank"><img src="https://opencollective.com/debug/backer/19/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/20/website" target="_blank"><img src="https://opencollective.com/debug/backer/20/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/21/website" target="_blank"><img src="https://opencollective.com/debug/backer/21/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/22/website" target="_blank"><img src="https://opencollective.com/debug/backer/22/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/23/website" target="_blank"><img src="https://opencollective.com/debug/backer/23/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/24/website" target="_blank"><img src="https://opencollective.com/debug/backer/24/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/25/website" target="_blank"><img src="https://opencollective.com/debug/backer/25/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/26/website" target="_blank"><img src="https://opencollective.com/debug/backer/26/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/27/website" target="_blank"><img src="https://opencollective.com/debug/backer/27/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/28/website" target="_blank"><img src="https://opencollective.com/debug/backer/28/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/backer/29/website" target="_blank"><img src="https://opencollective.com/debug/backer/29/avatar.svg"></a>
|
|
||||||
|
|
||||||
|
|
||||||
## Sponsors
|
|
||||||
|
|
||||||
Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/debug#sponsor)]
|
|
||||||
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/0/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/0/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/1/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/1/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/2/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/2/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/3/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/3/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/4/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/4/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/5/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/5/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/6/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/6/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/7/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/7/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/8/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/8/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/9/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/9/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/10/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/10/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/11/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/11/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/12/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/12/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/13/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/13/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/14/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/14/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/15/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/15/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/16/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/16/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/17/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/17/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/18/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/18/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/19/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/19/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/20/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/20/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/21/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/21/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/22/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/22/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/23/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/23/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/24/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/24/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/25/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/25/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/26/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/26/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/27/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/27/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/28/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/28/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/debug/sponsor/29/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/29/avatar.svg"></a>
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
(The MIT License)
|
|
||||||
|
|
||||||
Copyright (c) 2014-2017 TJ Holowaychuk <tj@vision-media.ca>
|
|
||||||
Copyright (c) 2018-2021 Josh Junon
|
|
||||||
|
|
||||||
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,59 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "debug",
|
|
||||||
"version": "4.3.4",
|
|
||||||
"repository": {
|
|
||||||
"type": "git",
|
|
||||||
"url": "git://github.com/debug-js/debug.git"
|
|
||||||
},
|
|
||||||
"description": "Lightweight debugging utility for Node.js and the browser",
|
|
||||||
"keywords": [
|
|
||||||
"debug",
|
|
||||||
"log",
|
|
||||||
"debugger"
|
|
||||||
],
|
|
||||||
"files": [
|
|
||||||
"src",
|
|
||||||
"LICENSE",
|
|
||||||
"README.md"
|
|
||||||
],
|
|
||||||
"author": "Josh Junon <josh.junon@protonmail.com>",
|
|
||||||
"contributors": [
|
|
||||||
"TJ Holowaychuk <tj@vision-media.ca>",
|
|
||||||
"Nathan Rajlich <nathan@tootallnate.net> (http://n8.io)",
|
|
||||||
"Andrew Rhyne <rhyneandrew@gmail.com>"
|
|
||||||
],
|
|
||||||
"license": "MIT",
|
|
||||||
"scripts": {
|
|
||||||
"lint": "xo",
|
|
||||||
"test": "npm run test:node && npm run test:browser && npm run lint",
|
|
||||||
"test:node": "istanbul cover _mocha -- test.js",
|
|
||||||
"test:browser": "karma start --single-run",
|
|
||||||
"test:coverage": "cat ./coverage/lcov.info | coveralls"
|
|
||||||
},
|
|
||||||
"dependencies": {
|
|
||||||
"ms": "2.1.2"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"brfs": "^2.0.1",
|
|
||||||
"browserify": "^16.2.3",
|
|
||||||
"coveralls": "^3.0.2",
|
|
||||||
"istanbul": "^0.4.5",
|
|
||||||
"karma": "^3.1.4",
|
|
||||||
"karma-browserify": "^6.0.0",
|
|
||||||
"karma-chrome-launcher": "^2.2.0",
|
|
||||||
"karma-mocha": "^1.3.0",
|
|
||||||
"mocha": "^5.2.0",
|
|
||||||
"mocha-lcov-reporter": "^1.2.0",
|
|
||||||
"xo": "^0.23.0"
|
|
||||||
},
|
|
||||||
"peerDependenciesMeta": {
|
|
||||||
"supports-color": {
|
|
||||||
"optional": true
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"main": "./src/index.js",
|
|
||||||
"browser": "./src/browser.js",
|
|
||||||
"engines": {
|
|
||||||
"node": ">=6.0"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,269 +0,0 @@
|
|||||||
/* eslint-env browser */
|
|
||||||
|
|
||||||
/**
|
|
||||||
* This is the web browser implementation of `debug()`.
|
|
||||||
*/
|
|
||||||
|
|
||||||
exports.formatArgs = formatArgs;
|
|
||||||
exports.save = save;
|
|
||||||
exports.load = load;
|
|
||||||
exports.useColors = useColors;
|
|
||||||
exports.storage = localstorage();
|
|
||||||
exports.destroy = (() => {
|
|
||||||
let warned = false;
|
|
||||||
|
|
||||||
return () => {
|
|
||||||
if (!warned) {
|
|
||||||
warned = true;
|
|
||||||
console.warn('Instance method `debug.destroy()` is deprecated and no longer does anything. It will be removed in the next major version of `debug`.');
|
|
||||||
}
|
|
||||||
};
|
|
||||||
})();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Colors.
|
|
||||||
*/
|
|
||||||
|
|
||||||
exports.colors = [
|
|
||||||
'#0000CC',
|
|
||||||
'#0000FF',
|
|
||||||
'#0033CC',
|
|
||||||
'#0033FF',
|
|
||||||
'#0066CC',
|
|
||||||
'#0066FF',
|
|
||||||
'#0099CC',
|
|
||||||
'#0099FF',
|
|
||||||
'#00CC00',
|
|
||||||
'#00CC33',
|
|
||||||
'#00CC66',
|
|
||||||
'#00CC99',
|
|
||||||
'#00CCCC',
|
|
||||||
'#00CCFF',
|
|
||||||
'#3300CC',
|
|
||||||
'#3300FF',
|
|
||||||
'#3333CC',
|
|
||||||
'#3333FF',
|
|
||||||
'#3366CC',
|
|
||||||
'#3366FF',
|
|
||||||
'#3399CC',
|
|
||||||
'#3399FF',
|
|
||||||
'#33CC00',
|
|
||||||
'#33CC33',
|
|
||||||
'#33CC66',
|
|
||||||
'#33CC99',
|
|
||||||
'#33CCCC',
|
|
||||||
'#33CCFF',
|
|
||||||
'#6600CC',
|
|
||||||
'#6600FF',
|
|
||||||
'#6633CC',
|
|
||||||
'#6633FF',
|
|
||||||
'#66CC00',
|
|
||||||
'#66CC33',
|
|
||||||
'#9900CC',
|
|
||||||
'#9900FF',
|
|
||||||
'#9933CC',
|
|
||||||
'#9933FF',
|
|
||||||
'#99CC00',
|
|
||||||
'#99CC33',
|
|
||||||
'#CC0000',
|
|
||||||
'#CC0033',
|
|
||||||
'#CC0066',
|
|
||||||
'#CC0099',
|
|
||||||
'#CC00CC',
|
|
||||||
'#CC00FF',
|
|
||||||
'#CC3300',
|
|
||||||
'#CC3333',
|
|
||||||
'#CC3366',
|
|
||||||
'#CC3399',
|
|
||||||
'#CC33CC',
|
|
||||||
'#CC33FF',
|
|
||||||
'#CC6600',
|
|
||||||
'#CC6633',
|
|
||||||
'#CC9900',
|
|
||||||
'#CC9933',
|
|
||||||
'#CCCC00',
|
|
||||||
'#CCCC33',
|
|
||||||
'#FF0000',
|
|
||||||
'#FF0033',
|
|
||||||
'#FF0066',
|
|
||||||
'#FF0099',
|
|
||||||
'#FF00CC',
|
|
||||||
'#FF00FF',
|
|
||||||
'#FF3300',
|
|
||||||
'#FF3333',
|
|
||||||
'#FF3366',
|
|
||||||
'#FF3399',
|
|
||||||
'#FF33CC',
|
|
||||||
'#FF33FF',
|
|
||||||
'#FF6600',
|
|
||||||
'#FF6633',
|
|
||||||
'#FF9900',
|
|
||||||
'#FF9933',
|
|
||||||
'#FFCC00',
|
|
||||||
'#FFCC33'
|
|
||||||
];
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Currently only WebKit-based Web Inspectors, Firefox >= v31,
|
|
||||||
* and the Firebug extension (any Firefox version) are known
|
|
||||||
* to support "%c" CSS customizations.
|
|
||||||
*
|
|
||||||
* TODO: add a `localStorage` variable to explicitly enable/disable colors
|
|
||||||
*/
|
|
||||||
|
|
||||||
// eslint-disable-next-line complexity
|
|
||||||
function useColors() {
|
|
||||||
// NB: In an Electron preload script, document will be defined but not fully
|
|
||||||
// initialized. Since we know we're in Chrome, we'll just detect this case
|
|
||||||
// explicitly
|
|
||||||
if (typeof window !== 'undefined' && window.process && (window.process.type === 'renderer' || window.process.__nwjs)) {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Internet Explorer and Edge do not support colors.
|
|
||||||
if (typeof navigator !== 'undefined' && navigator.userAgent && navigator.userAgent.toLowerCase().match(/(edge|trident)\/(\d+)/)) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Is webkit? http://stackoverflow.com/a/16459606/376773
|
|
||||||
// document is undefined in react-native: https://github.com/facebook/react-native/pull/1632
|
|
||||||
return (typeof document !== 'undefined' && document.documentElement && document.documentElement.style && document.documentElement.style.WebkitAppearance) ||
|
|
||||||
// Is firebug? http://stackoverflow.com/a/398120/376773
|
|
||||||
(typeof window !== 'undefined' && window.console && (window.console.firebug || (window.console.exception && window.console.table))) ||
|
|
||||||
// Is firefox >= v31?
|
|
||||||
// https://developer.mozilla.org/en-US/docs/Tools/Web_Console#Styling_messages
|
|
||||||
(typeof navigator !== 'undefined' && navigator.userAgent && navigator.userAgent.toLowerCase().match(/firefox\/(\d+)/) && parseInt(RegExp.$1, 10) >= 31) ||
|
|
||||||
// Double check webkit in userAgent just in case we are in a worker
|
|
||||||
(typeof navigator !== 'undefined' && navigator.userAgent && navigator.userAgent.toLowerCase().match(/applewebkit\/(\d+)/));
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Colorize log arguments if enabled.
|
|
||||||
*
|
|
||||||
* @api public
|
|
||||||
*/
|
|
||||||
|
|
||||||
function formatArgs(args) {
|
|
||||||
args[0] = (this.useColors ? '%c' : '') +
|
|
||||||
this.namespace +
|
|
||||||
(this.useColors ? ' %c' : ' ') +
|
|
||||||
args[0] +
|
|
||||||
(this.useColors ? '%c ' : ' ') +
|
|
||||||
'+' + module.exports.humanize(this.diff);
|
|
||||||
|
|
||||||
if (!this.useColors) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const c = 'color: ' + this.color;
|
|
||||||
args.splice(1, 0, c, 'color: inherit');
|
|
||||||
|
|
||||||
// The final "%c" is somewhat tricky, because there could be other
|
|
||||||
// arguments passed either before or after the %c, so we need to
|
|
||||||
// figure out the correct index to insert the CSS into
|
|
||||||
let index = 0;
|
|
||||||
let lastC = 0;
|
|
||||||
args[0].replace(/%[a-zA-Z%]/g, match => {
|
|
||||||
if (match === '%%') {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
index++;
|
|
||||||
if (match === '%c') {
|
|
||||||
// We only are interested in the *last* %c
|
|
||||||
// (the user may have provided their own)
|
|
||||||
lastC = index;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
args.splice(lastC, 0, c);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Invokes `console.debug()` when available.
|
|
||||||
* No-op when `console.debug` is not a "function".
|
|
||||||
* If `console.debug` is not available, falls back
|
|
||||||
* to `console.log`.
|
|
||||||
*
|
|
||||||
* @api public
|
|
||||||
*/
|
|
||||||
exports.log = console.debug || console.log || (() => {});
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Save `namespaces`.
|
|
||||||
*
|
|
||||||
* @param {String} namespaces
|
|
||||||
* @api private
|
|
||||||
*/
|
|
||||||
function save(namespaces) {
|
|
||||||
try {
|
|
||||||
if (namespaces) {
|
|
||||||
exports.storage.setItem('debug', namespaces);
|
|
||||||
} else {
|
|
||||||
exports.storage.removeItem('debug');
|
|
||||||
}
|
|
||||||
} catch (error) {
|
|
||||||
// Swallow
|
|
||||||
// XXX (@Qix-) should we be logging these?
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Load `namespaces`.
|
|
||||||
*
|
|
||||||
* @return {String} returns the previously persisted debug modes
|
|
||||||
* @api private
|
|
||||||
*/
|
|
||||||
function load() {
|
|
||||||
let r;
|
|
||||||
try {
|
|
||||||
r = exports.storage.getItem('debug');
|
|
||||||
} catch (error) {
|
|
||||||
// Swallow
|
|
||||||
// XXX (@Qix-) should we be logging these?
|
|
||||||
}
|
|
||||||
|
|
||||||
// If debug isn't set in LS, and we're in Electron, try to load $DEBUG
|
|
||||||
if (!r && typeof process !== 'undefined' && 'env' in process) {
|
|
||||||
r = process.env.DEBUG;
|
|
||||||
}
|
|
||||||
|
|
||||||
return r;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Localstorage attempts to return the localstorage.
|
|
||||||
*
|
|
||||||
* This is necessary because safari throws
|
|
||||||
* when a user disables cookies/localstorage
|
|
||||||
* and you attempt to access it.
|
|
||||||
*
|
|
||||||
* @return {LocalStorage}
|
|
||||||
* @api private
|
|
||||||
*/
|
|
||||||
|
|
||||||
function localstorage() {
|
|
||||||
try {
|
|
||||||
// TVMLKit (Apple TV JS Runtime) does not have a window object, just localStorage in the global context
|
|
||||||
// The Browser also has localStorage in the global context.
|
|
||||||
return localStorage;
|
|
||||||
} catch (error) {
|
|
||||||
// Swallow
|
|
||||||
// XXX (@Qix-) should we be logging these?
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = require('./common')(exports);
|
|
||||||
|
|
||||||
const {formatters} = module.exports;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Map %j to `JSON.stringify()`, since no Web Inspectors do that by default.
|
|
||||||
*/
|
|
||||||
|
|
||||||
formatters.j = function (v) {
|
|
||||||
try {
|
|
||||||
return JSON.stringify(v);
|
|
||||||
} catch (error) {
|
|
||||||
return '[UnexpectedJSONParseError]: ' + error.message;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
@ -1,274 +0,0 @@
|
|||||||
|
|
||||||
/**
|
|
||||||
* This is the common logic for both the Node.js and web browser
|
|
||||||
* implementations of `debug()`.
|
|
||||||
*/
|
|
||||||
|
|
||||||
function setup(env) {
|
|
||||||
createDebug.debug = createDebug;
|
|
||||||
createDebug.default = createDebug;
|
|
||||||
createDebug.coerce = coerce;
|
|
||||||
createDebug.disable = disable;
|
|
||||||
createDebug.enable = enable;
|
|
||||||
createDebug.enabled = enabled;
|
|
||||||
createDebug.humanize = require('ms');
|
|
||||||
createDebug.destroy = destroy;
|
|
||||||
|
|
||||||
Object.keys(env).forEach(key => {
|
|
||||||
createDebug[key] = env[key];
|
|
||||||
});
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The currently active debug mode names, and names to skip.
|
|
||||||
*/
|
|
||||||
|
|
||||||
createDebug.names = [];
|
|
||||||
createDebug.skips = [];
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Map of special "%n" handling functions, for the debug "format" argument.
|
|
||||||
*
|
|
||||||
* Valid key names are a single, lower or upper-case letter, i.e. "n" and "N".
|
|
||||||
*/
|
|
||||||
createDebug.formatters = {};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Selects a color for a debug namespace
|
|
||||||
* @param {String} namespace The namespace string for the debug instance to be colored
|
|
||||||
* @return {Number|String} An ANSI color code for the given namespace
|
|
||||||
* @api private
|
|
||||||
*/
|
|
||||||
function selectColor(namespace) {
|
|
||||||
let hash = 0;
|
|
||||||
|
|
||||||
for (let i = 0; i < namespace.length; i++) {
|
|
||||||
hash = ((hash << 5) - hash) + namespace.charCodeAt(i);
|
|
||||||
hash |= 0; // Convert to 32bit integer
|
|
||||||
}
|
|
||||||
|
|
||||||
return createDebug.colors[Math.abs(hash) % createDebug.colors.length];
|
|
||||||
}
|
|
||||||
createDebug.selectColor = selectColor;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a debugger with the given `namespace`.
|
|
||||||
*
|
|
||||||
* @param {String} namespace
|
|
||||||
* @return {Function}
|
|
||||||
* @api public
|
|
||||||
*/
|
|
||||||
function createDebug(namespace) {
|
|
||||||
let prevTime;
|
|
||||||
let enableOverride = null;
|
|
||||||
let namespacesCache;
|
|
||||||
let enabledCache;
|
|
||||||
|
|
||||||
function debug(...args) {
|
|
||||||
// Disabled?
|
|
||||||
if (!debug.enabled) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const self = debug;
|
|
||||||
|
|
||||||
// Set `diff` timestamp
|
|
||||||
const curr = Number(new Date());
|
|
||||||
const ms = curr - (prevTime || curr);
|
|
||||||
self.diff = ms;
|
|
||||||
self.prev = prevTime;
|
|
||||||
self.curr = curr;
|
|
||||||
prevTime = curr;
|
|
||||||
|
|
||||||
args[0] = createDebug.coerce(args[0]);
|
|
||||||
|
|
||||||
if (typeof args[0] !== 'string') {
|
|
||||||
// Anything else let's inspect with %O
|
|
||||||
args.unshift('%O');
|
|
||||||
}
|
|
||||||
|
|
||||||
// Apply any `formatters` transformations
|
|
||||||
let index = 0;
|
|
||||||
args[0] = args[0].replace(/%([a-zA-Z%])/g, (match, format) => {
|
|
||||||
// If we encounter an escaped % then don't increase the array index
|
|
||||||
if (match === '%%') {
|
|
||||||
return '%';
|
|
||||||
}
|
|
||||||
index++;
|
|
||||||
const formatter = createDebug.formatters[format];
|
|
||||||
if (typeof formatter === 'function') {
|
|
||||||
const val = args[index];
|
|
||||||
match = formatter.call(self, val);
|
|
||||||
|
|
||||||
// Now we need to remove `args[index]` since it's inlined in the `format`
|
|
||||||
args.splice(index, 1);
|
|
||||||
index--;
|
|
||||||
}
|
|
||||||
return match;
|
|
||||||
});
|
|
||||||
|
|
||||||
// Apply env-specific formatting (colors, etc.)
|
|
||||||
createDebug.formatArgs.call(self, args);
|
|
||||||
|
|
||||||
const logFn = self.log || createDebug.log;
|
|
||||||
logFn.apply(self, args);
|
|
||||||
}
|
|
||||||
|
|
||||||
debug.namespace = namespace;
|
|
||||||
debug.useColors = createDebug.useColors();
|
|
||||||
debug.color = createDebug.selectColor(namespace);
|
|
||||||
debug.extend = extend;
|
|
||||||
debug.destroy = createDebug.destroy; // XXX Temporary. Will be removed in the next major release.
|
|
||||||
|
|
||||||
Object.defineProperty(debug, 'enabled', {
|
|
||||||
enumerable: true,
|
|
||||||
configurable: false,
|
|
||||||
get: () => {
|
|
||||||
if (enableOverride !== null) {
|
|
||||||
return enableOverride;
|
|
||||||
}
|
|
||||||
if (namespacesCache !== createDebug.namespaces) {
|
|
||||||
namespacesCache = createDebug.namespaces;
|
|
||||||
enabledCache = createDebug.enabled(namespace);
|
|
||||||
}
|
|
||||||
|
|
||||||
return enabledCache;
|
|
||||||
},
|
|
||||||
set: v => {
|
|
||||||
enableOverride = v;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// Env-specific initialization logic for debug instances
|
|
||||||
if (typeof createDebug.init === 'function') {
|
|
||||||
createDebug.init(debug);
|
|
||||||
}
|
|
||||||
|
|
||||||
return debug;
|
|
||||||
}
|
|
||||||
|
|
||||||
function extend(namespace, delimiter) {
|
|
||||||
const newDebug = createDebug(this.namespace + (typeof delimiter === 'undefined' ? ':' : delimiter) + namespace);
|
|
||||||
newDebug.log = this.log;
|
|
||||||
return newDebug;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Enables a debug mode by namespaces. This can include modes
|
|
||||||
* separated by a colon and wildcards.
|
|
||||||
*
|
|
||||||
* @param {String} namespaces
|
|
||||||
* @api public
|
|
||||||
*/
|
|
||||||
function enable(namespaces) {
|
|
||||||
createDebug.save(namespaces);
|
|
||||||
createDebug.namespaces = namespaces;
|
|
||||||
|
|
||||||
createDebug.names = [];
|
|
||||||
createDebug.skips = [];
|
|
||||||
|
|
||||||
let i;
|
|
||||||
const split = (typeof namespaces === 'string' ? namespaces : '').split(/[\s,]+/);
|
|
||||||
const len = split.length;
|
|
||||||
|
|
||||||
for (i = 0; i < len; i++) {
|
|
||||||
if (!split[i]) {
|
|
||||||
// ignore empty strings
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
namespaces = split[i].replace(/\*/g, '.*?');
|
|
||||||
|
|
||||||
if (namespaces[0] === '-') {
|
|
||||||
createDebug.skips.push(new RegExp('^' + namespaces.slice(1) + '$'));
|
|
||||||
} else {
|
|
||||||
createDebug.names.push(new RegExp('^' + namespaces + '$'));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Disable debug output.
|
|
||||||
*
|
|
||||||
* @return {String} namespaces
|
|
||||||
* @api public
|
|
||||||
*/
|
|
||||||
function disable() {
|
|
||||||
const namespaces = [
|
|
||||||
...createDebug.names.map(toNamespace),
|
|
||||||
...createDebug.skips.map(toNamespace).map(namespace => '-' + namespace)
|
|
||||||
].join(',');
|
|
||||||
createDebug.enable('');
|
|
||||||
return namespaces;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns true if the given mode name is enabled, false otherwise.
|
|
||||||
*
|
|
||||||
* @param {String} name
|
|
||||||
* @return {Boolean}
|
|
||||||
* @api public
|
|
||||||
*/
|
|
||||||
function enabled(name) {
|
|
||||||
if (name[name.length - 1] === '*') {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
let i;
|
|
||||||
let len;
|
|
||||||
|
|
||||||
for (i = 0, len = createDebug.skips.length; i < len; i++) {
|
|
||||||
if (createDebug.skips[i].test(name)) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
for (i = 0, len = createDebug.names.length; i < len; i++) {
|
|
||||||
if (createDebug.names[i].test(name)) {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Convert regexp to namespace
|
|
||||||
*
|
|
||||||
* @param {RegExp} regxep
|
|
||||||
* @return {String} namespace
|
|
||||||
* @api private
|
|
||||||
*/
|
|
||||||
function toNamespace(regexp) {
|
|
||||||
return regexp.toString()
|
|
||||||
.substring(2, regexp.toString().length - 2)
|
|
||||||
.replace(/\.\*\?$/, '*');
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Coerce `val`.
|
|
||||||
*
|
|
||||||
* @param {Mixed} val
|
|
||||||
* @return {Mixed}
|
|
||||||
* @api private
|
|
||||||
*/
|
|
||||||
function coerce(val) {
|
|
||||||
if (val instanceof Error) {
|
|
||||||
return val.stack || val.message;
|
|
||||||
}
|
|
||||||
return val;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* XXX DO NOT USE. This is a temporary stub function.
|
|
||||||
* XXX It WILL be removed in the next major release.
|
|
||||||
*/
|
|
||||||
function destroy() {
|
|
||||||
console.warn('Instance method `debug.destroy()` is deprecated and no longer does anything. It will be removed in the next major version of `debug`.');
|
|
||||||
}
|
|
||||||
|
|
||||||
createDebug.enable(createDebug.load());
|
|
||||||
|
|
||||||
return createDebug;
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = setup;
|
|
||||||
@ -1,10 +0,0 @@
|
|||||||
/**
|
|
||||||
* Detect Electron renderer / nwjs process, which is node, but we should
|
|
||||||
* treat as a browser.
|
|
||||||
*/
|
|
||||||
|
|
||||||
if (typeof process === 'undefined' || process.type === 'renderer' || process.browser === true || process.__nwjs) {
|
|
||||||
module.exports = require('./browser.js');
|
|
||||||
} else {
|
|
||||||
module.exports = require('./node.js');
|
|
||||||
}
|
|
||||||
@ -1,263 +0,0 @@
|
|||||||
/**
|
|
||||||
* Module dependencies.
|
|
||||||
*/
|
|
||||||
|
|
||||||
const tty = require('tty');
|
|
||||||
const util = require('util');
|
|
||||||
|
|
||||||
/**
|
|
||||||
* This is the Node.js implementation of `debug()`.
|
|
||||||
*/
|
|
||||||
|
|
||||||
exports.init = init;
|
|
||||||
exports.log = log;
|
|
||||||
exports.formatArgs = formatArgs;
|
|
||||||
exports.save = save;
|
|
||||||
exports.load = load;
|
|
||||||
exports.useColors = useColors;
|
|
||||||
exports.destroy = util.deprecate(
|
|
||||||
() => {},
|
|
||||||
'Instance method `debug.destroy()` is deprecated and no longer does anything. It will be removed in the next major version of `debug`.'
|
|
||||||
);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Colors.
|
|
||||||
*/
|
|
||||||
|
|
||||||
exports.colors = [6, 2, 3, 4, 5, 1];
|
|
||||||
|
|
||||||
try {
|
|
||||||
// Optional dependency (as in, doesn't need to be installed, NOT like optionalDependencies in package.json)
|
|
||||||
// eslint-disable-next-line import/no-extraneous-dependencies
|
|
||||||
const supportsColor = require('supports-color');
|
|
||||||
|
|
||||||
if (supportsColor && (supportsColor.stderr || supportsColor).level >= 2) {
|
|
||||||
exports.colors = [
|
|
||||||
20,
|
|
||||||
21,
|
|
||||||
26,
|
|
||||||
27,
|
|
||||||
32,
|
|
||||||
33,
|
|
||||||
38,
|
|
||||||
39,
|
|
||||||
40,
|
|
||||||
41,
|
|
||||||
42,
|
|
||||||
43,
|
|
||||||
44,
|
|
||||||
45,
|
|
||||||
56,
|
|
||||||
57,
|
|
||||||
62,
|
|
||||||
63,
|
|
||||||
68,
|
|
||||||
69,
|
|
||||||
74,
|
|
||||||
75,
|
|
||||||
76,
|
|
||||||
77,
|
|
||||||
78,
|
|
||||||
79,
|
|
||||||
80,
|
|
||||||
81,
|
|
||||||
92,
|
|
||||||
93,
|
|
||||||
98,
|
|
||||||
99,
|
|
||||||
112,
|
|
||||||
113,
|
|
||||||
128,
|
|
||||||
129,
|
|
||||||
134,
|
|
||||||
135,
|
|
||||||
148,
|
|
||||||
149,
|
|
||||||
160,
|
|
||||||
161,
|
|
||||||
162,
|
|
||||||
163,
|
|
||||||
164,
|
|
||||||
165,
|
|
||||||
166,
|
|
||||||
167,
|
|
||||||
168,
|
|
||||||
169,
|
|
||||||
170,
|
|
||||||
171,
|
|
||||||
172,
|
|
||||||
173,
|
|
||||||
178,
|
|
||||||
179,
|
|
||||||
184,
|
|
||||||
185,
|
|
||||||
196,
|
|
||||||
197,
|
|
||||||
198,
|
|
||||||
199,
|
|
||||||
200,
|
|
||||||
201,
|
|
||||||
202,
|
|
||||||
203,
|
|
||||||
204,
|
|
||||||
205,
|
|
||||||
206,
|
|
||||||
207,
|
|
||||||
208,
|
|
||||||
209,
|
|
||||||
214,
|
|
||||||
215,
|
|
||||||
220,
|
|
||||||
221
|
|
||||||
];
|
|
||||||
}
|
|
||||||
} catch (error) {
|
|
||||||
// Swallow - we only care if `supports-color` is available; it doesn't have to be.
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Build up the default `inspectOpts` object from the environment variables.
|
|
||||||
*
|
|
||||||
* $ DEBUG_COLORS=no DEBUG_DEPTH=10 DEBUG_SHOW_HIDDEN=enabled node script.js
|
|
||||||
*/
|
|
||||||
|
|
||||||
exports.inspectOpts = Object.keys(process.env).filter(key => {
|
|
||||||
return /^debug_/i.test(key);
|
|
||||||
}).reduce((obj, key) => {
|
|
||||||
// Camel-case
|
|
||||||
const prop = key
|
|
||||||
.substring(6)
|
|
||||||
.toLowerCase()
|
|
||||||
.replace(/_([a-z])/g, (_, k) => {
|
|
||||||
return k.toUpperCase();
|
|
||||||
});
|
|
||||||
|
|
||||||
// Coerce string value into JS value
|
|
||||||
let val = process.env[key];
|
|
||||||
if (/^(yes|on|true|enabled)$/i.test(val)) {
|
|
||||||
val = true;
|
|
||||||
} else if (/^(no|off|false|disabled)$/i.test(val)) {
|
|
||||||
val = false;
|
|
||||||
} else if (val === 'null') {
|
|
||||||
val = null;
|
|
||||||
} else {
|
|
||||||
val = Number(val);
|
|
||||||
}
|
|
||||||
|
|
||||||
obj[prop] = val;
|
|
||||||
return obj;
|
|
||||||
}, {});
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Is stdout a TTY? Colored output is enabled when `true`.
|
|
||||||
*/
|
|
||||||
|
|
||||||
function useColors() {
|
|
||||||
return 'colors' in exports.inspectOpts ?
|
|
||||||
Boolean(exports.inspectOpts.colors) :
|
|
||||||
tty.isatty(process.stderr.fd);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Adds ANSI color escape codes if enabled.
|
|
||||||
*
|
|
||||||
* @api public
|
|
||||||
*/
|
|
||||||
|
|
||||||
function formatArgs(args) {
|
|
||||||
const {namespace: name, useColors} = this;
|
|
||||||
|
|
||||||
if (useColors) {
|
|
||||||
const c = this.color;
|
|
||||||
const colorCode = '\u001B[3' + (c < 8 ? c : '8;5;' + c);
|
|
||||||
const prefix = ` ${colorCode};1m${name} \u001B[0m`;
|
|
||||||
|
|
||||||
args[0] = prefix + args[0].split('\n').join('\n' + prefix);
|
|
||||||
args.push(colorCode + 'm+' + module.exports.humanize(this.diff) + '\u001B[0m');
|
|
||||||
} else {
|
|
||||||
args[0] = getDate() + name + ' ' + args[0];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function getDate() {
|
|
||||||
if (exports.inspectOpts.hideDate) {
|
|
||||||
return '';
|
|
||||||
}
|
|
||||||
return new Date().toISOString() + ' ';
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Invokes `util.format()` with the specified arguments and writes to stderr.
|
|
||||||
*/
|
|
||||||
|
|
||||||
function log(...args) {
|
|
||||||
return process.stderr.write(util.format(...args) + '\n');
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Save `namespaces`.
|
|
||||||
*
|
|
||||||
* @param {String} namespaces
|
|
||||||
* @api private
|
|
||||||
*/
|
|
||||||
function save(namespaces) {
|
|
||||||
if (namespaces) {
|
|
||||||
process.env.DEBUG = namespaces;
|
|
||||||
} else {
|
|
||||||
// If you set a process.env field to null or undefined, it gets cast to the
|
|
||||||
// string 'null' or 'undefined'. Just delete instead.
|
|
||||||
delete process.env.DEBUG;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Load `namespaces`.
|
|
||||||
*
|
|
||||||
* @return {String} returns the previously persisted debug modes
|
|
||||||
* @api private
|
|
||||||
*/
|
|
||||||
|
|
||||||
function load() {
|
|
||||||
return process.env.DEBUG;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Init logic for `debug` instances.
|
|
||||||
*
|
|
||||||
* Create a new `inspectOpts` object in case `useColors` is set
|
|
||||||
* differently for a particular `debug` instance.
|
|
||||||
*/
|
|
||||||
|
|
||||||
function init(debug) {
|
|
||||||
debug.inspectOpts = {};
|
|
||||||
|
|
||||||
const keys = Object.keys(exports.inspectOpts);
|
|
||||||
for (let i = 0; i < keys.length; i++) {
|
|
||||||
debug.inspectOpts[keys[i]] = exports.inspectOpts[keys[i]];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = require('./common')(exports);
|
|
||||||
|
|
||||||
const {formatters} = module.exports;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Map %o to `util.inspect()`, all on a single line.
|
|
||||||
*/
|
|
||||||
|
|
||||||
formatters.o = function (v) {
|
|
||||||
this.inspectOpts.colors = this.useColors;
|
|
||||||
return util.inspect(v, this.inspectOpts)
|
|
||||||
.split('\n')
|
|
||||||
.map(str => str.trim())
|
|
||||||
.join(' ');
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Map %O to `util.inspect()`, allowing multiple lines if needed.
|
|
||||||
*/
|
|
||||||
|
|
||||||
formatters.O = function (v) {
|
|
||||||
this.inspectOpts.colors = this.useColors;
|
|
||||||
return util.inspect(v, this.inspectOpts);
|
|
||||||
};
|
|
||||||
@ -1,162 +0,0 @@
|
|||||||
/**
|
|
||||||
* Helpers.
|
|
||||||
*/
|
|
||||||
|
|
||||||
var s = 1000;
|
|
||||||
var m = s * 60;
|
|
||||||
var h = m * 60;
|
|
||||||
var d = h * 24;
|
|
||||||
var w = d * 7;
|
|
||||||
var y = d * 365.25;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Parse or format the given `val`.
|
|
||||||
*
|
|
||||||
* Options:
|
|
||||||
*
|
|
||||||
* - `long` verbose formatting [false]
|
|
||||||
*
|
|
||||||
* @param {String|Number} val
|
|
||||||
* @param {Object} [options]
|
|
||||||
* @throws {Error} throw an error if val is not a non-empty string or a number
|
|
||||||
* @return {String|Number}
|
|
||||||
* @api public
|
|
||||||
*/
|
|
||||||
|
|
||||||
module.exports = function(val, options) {
|
|
||||||
options = options || {};
|
|
||||||
var type = typeof val;
|
|
||||||
if (type === 'string' && val.length > 0) {
|
|
||||||
return parse(val);
|
|
||||||
} else if (type === 'number' && isFinite(val)) {
|
|
||||||
return options.long ? fmtLong(val) : fmtShort(val);
|
|
||||||
}
|
|
||||||
throw new Error(
|
|
||||||
'val is not a non-empty string or a valid number. val=' +
|
|
||||||
JSON.stringify(val)
|
|
||||||
);
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Parse the given `str` and return milliseconds.
|
|
||||||
*
|
|
||||||
* @param {String} str
|
|
||||||
* @return {Number}
|
|
||||||
* @api private
|
|
||||||
*/
|
|
||||||
|
|
||||||
function parse(str) {
|
|
||||||
str = String(str);
|
|
||||||
if (str.length > 100) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
var match = /^(-?(?:\d+)?\.?\d+) *(milliseconds?|msecs?|ms|seconds?|secs?|s|minutes?|mins?|m|hours?|hrs?|h|days?|d|weeks?|w|years?|yrs?|y)?$/i.exec(
|
|
||||||
str
|
|
||||||
);
|
|
||||||
if (!match) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
var n = parseFloat(match[1]);
|
|
||||||
var type = (match[2] || 'ms').toLowerCase();
|
|
||||||
switch (type) {
|
|
||||||
case 'years':
|
|
||||||
case 'year':
|
|
||||||
case 'yrs':
|
|
||||||
case 'yr':
|
|
||||||
case 'y':
|
|
||||||
return n * y;
|
|
||||||
case 'weeks':
|
|
||||||
case 'week':
|
|
||||||
case 'w':
|
|
||||||
return n * w;
|
|
||||||
case 'days':
|
|
||||||
case 'day':
|
|
||||||
case 'd':
|
|
||||||
return n * d;
|
|
||||||
case 'hours':
|
|
||||||
case 'hour':
|
|
||||||
case 'hrs':
|
|
||||||
case 'hr':
|
|
||||||
case 'h':
|
|
||||||
return n * h;
|
|
||||||
case 'minutes':
|
|
||||||
case 'minute':
|
|
||||||
case 'mins':
|
|
||||||
case 'min':
|
|
||||||
case 'm':
|
|
||||||
return n * m;
|
|
||||||
case 'seconds':
|
|
||||||
case 'second':
|
|
||||||
case 'secs':
|
|
||||||
case 'sec':
|
|
||||||
case 's':
|
|
||||||
return n * s;
|
|
||||||
case 'milliseconds':
|
|
||||||
case 'millisecond':
|
|
||||||
case 'msecs':
|
|
||||||
case 'msec':
|
|
||||||
case 'ms':
|
|
||||||
return n;
|
|
||||||
default:
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Short format for `ms`.
|
|
||||||
*
|
|
||||||
* @param {Number} ms
|
|
||||||
* @return {String}
|
|
||||||
* @api private
|
|
||||||
*/
|
|
||||||
|
|
||||||
function fmtShort(ms) {
|
|
||||||
var msAbs = Math.abs(ms);
|
|
||||||
if (msAbs >= d) {
|
|
||||||
return Math.round(ms / d) + 'd';
|
|
||||||
}
|
|
||||||
if (msAbs >= h) {
|
|
||||||
return Math.round(ms / h) + 'h';
|
|
||||||
}
|
|
||||||
if (msAbs >= m) {
|
|
||||||
return Math.round(ms / m) + 'm';
|
|
||||||
}
|
|
||||||
if (msAbs >= s) {
|
|
||||||
return Math.round(ms / s) + 's';
|
|
||||||
}
|
|
||||||
return ms + 'ms';
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Long format for `ms`.
|
|
||||||
*
|
|
||||||
* @param {Number} ms
|
|
||||||
* @return {String}
|
|
||||||
* @api private
|
|
||||||
*/
|
|
||||||
|
|
||||||
function fmtLong(ms) {
|
|
||||||
var msAbs = Math.abs(ms);
|
|
||||||
if (msAbs >= d) {
|
|
||||||
return plural(ms, msAbs, d, 'day');
|
|
||||||
}
|
|
||||||
if (msAbs >= h) {
|
|
||||||
return plural(ms, msAbs, h, 'hour');
|
|
||||||
}
|
|
||||||
if (msAbs >= m) {
|
|
||||||
return plural(ms, msAbs, m, 'minute');
|
|
||||||
}
|
|
||||||
if (msAbs >= s) {
|
|
||||||
return plural(ms, msAbs, s, 'second');
|
|
||||||
}
|
|
||||||
return ms + ' ms';
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Pluralization helper.
|
|
||||||
*/
|
|
||||||
|
|
||||||
function plural(ms, msAbs, n, name) {
|
|
||||||
var isPlural = msAbs >= n * 1.5;
|
|
||||||
return Math.round(ms / n) + ' ' + name + (isPlural ? 's' : '');
|
|
||||||
}
|
|
||||||
@ -1,21 +0,0 @@
|
|||||||
The MIT License (MIT)
|
|
||||||
|
|
||||||
Copyright (c) 2016 Zeit, Inc.
|
|
||||||
|
|
||||||
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,37 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "ms",
|
|
||||||
"version": "2.1.2",
|
|
||||||
"description": "Tiny millisecond conversion utility",
|
|
||||||
"repository": "zeit/ms",
|
|
||||||
"main": "./index",
|
|
||||||
"files": [
|
|
||||||
"index.js"
|
|
||||||
],
|
|
||||||
"scripts": {
|
|
||||||
"precommit": "lint-staged",
|
|
||||||
"lint": "eslint lib/* bin/*",
|
|
||||||
"test": "mocha tests.js"
|
|
||||||
},
|
|
||||||
"eslintConfig": {
|
|
||||||
"extends": "eslint:recommended",
|
|
||||||
"env": {
|
|
||||||
"node": true,
|
|
||||||
"es6": true
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"lint-staged": {
|
|
||||||
"*.js": [
|
|
||||||
"npm run lint",
|
|
||||||
"prettier --single-quote --write",
|
|
||||||
"git add"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"license": "MIT",
|
|
||||||
"devDependencies": {
|
|
||||||
"eslint": "4.12.1",
|
|
||||||
"expect.js": "0.3.1",
|
|
||||||
"husky": "0.14.3",
|
|
||||||
"lint-staged": "5.0.0",
|
|
||||||
"mocha": "4.0.1"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,60 +0,0 @@
|
|||||||
# ms
|
|
||||||
|
|
||||||
[](https://travis-ci.org/zeit/ms)
|
|
||||||
[](https://spectrum.chat/zeit)
|
|
||||||
|
|
||||||
Use this package to easily convert various time formats to milliseconds.
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
```js
|
|
||||||
ms('2 days') // 172800000
|
|
||||||
ms('1d') // 86400000
|
|
||||||
ms('10h') // 36000000
|
|
||||||
ms('2.5 hrs') // 9000000
|
|
||||||
ms('2h') // 7200000
|
|
||||||
ms('1m') // 60000
|
|
||||||
ms('5s') // 5000
|
|
||||||
ms('1y') // 31557600000
|
|
||||||
ms('100') // 100
|
|
||||||
ms('-3 days') // -259200000
|
|
||||||
ms('-1h') // -3600000
|
|
||||||
ms('-200') // -200
|
|
||||||
```
|
|
||||||
|
|
||||||
### Convert from Milliseconds
|
|
||||||
|
|
||||||
```js
|
|
||||||
ms(60000) // "1m"
|
|
||||||
ms(2 * 60000) // "2m"
|
|
||||||
ms(-3 * 60000) // "-3m"
|
|
||||||
ms(ms('10 hours')) // "10h"
|
|
||||||
```
|
|
||||||
|
|
||||||
### Time Format Written-Out
|
|
||||||
|
|
||||||
```js
|
|
||||||
ms(60000, { long: true }) // "1 minute"
|
|
||||||
ms(2 * 60000, { long: true }) // "2 minutes"
|
|
||||||
ms(-3 * 60000, { long: true }) // "-3 minutes"
|
|
||||||
ms(ms('10 hours'), { long: true }) // "10 hours"
|
|
||||||
```
|
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
- Works both in [Node.js](https://nodejs.org) and in the browser
|
|
||||||
- If a number is supplied to `ms`, a string with a unit is returned
|
|
||||||
- If a string that contains the number is supplied, it returns it as a number (e.g.: it returns `100` for `'100'`)
|
|
||||||
- If you pass a string with a number and a valid unit, the number of equivalent milliseconds is returned
|
|
||||||
|
|
||||||
## Related Packages
|
|
||||||
|
|
||||||
- [ms.macro](https://github.com/knpwrs/ms.macro) - Run `ms` as a macro at build-time.
|
|
||||||
|
|
||||||
## Caught a Bug?
|
|
||||||
|
|
||||||
1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device
|
|
||||||
2. Link the package to the global module directory: `npm link`
|
|
||||||
3. Within the module you want to test your local development instance of ms, just link it to the dependencies: `npm link ms`. Instead of the default one from npm, Node.js will now use your clone of ms!
|
|
||||||
|
|
||||||
As always, you can run the tests using: `npm test`
|
|
||||||
@ -1,64 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "agent-base",
|
|
||||||
"version": "6.0.2",
|
|
||||||
"description": "Turn a function into an `http.Agent` instance",
|
|
||||||
"main": "dist/src/index",
|
|
||||||
"typings": "dist/src/index",
|
|
||||||
"files": [
|
|
||||||
"dist/src",
|
|
||||||
"src"
|
|
||||||
],
|
|
||||||
"scripts": {
|
|
||||||
"prebuild": "rimraf dist",
|
|
||||||
"build": "tsc",
|
|
||||||
"postbuild": "cpy --parents src test '!**/*.ts' dist",
|
|
||||||
"test": "mocha --reporter spec dist/test/*.js",
|
|
||||||
"test-lint": "eslint src --ext .js,.ts",
|
|
||||||
"prepublishOnly": "npm run build"
|
|
||||||
},
|
|
||||||
"repository": {
|
|
||||||
"type": "git",
|
|
||||||
"url": "git://github.com/TooTallNate/node-agent-base.git"
|
|
||||||
},
|
|
||||||
"keywords": [
|
|
||||||
"http",
|
|
||||||
"agent",
|
|
||||||
"base",
|
|
||||||
"barebones",
|
|
||||||
"https"
|
|
||||||
],
|
|
||||||
"author": "Nathan Rajlich <nathan@tootallnate.net> (http://n8.io/)",
|
|
||||||
"license": "MIT",
|
|
||||||
"bugs": {
|
|
||||||
"url": "https://github.com/TooTallNate/node-agent-base/issues"
|
|
||||||
},
|
|
||||||
"dependencies": {
|
|
||||||
"debug": "4"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"@types/debug": "4",
|
|
||||||
"@types/mocha": "^5.2.7",
|
|
||||||
"@types/node": "^14.0.20",
|
|
||||||
"@types/semver": "^7.1.0",
|
|
||||||
"@types/ws": "^6.0.3",
|
|
||||||
"@typescript-eslint/eslint-plugin": "1.6.0",
|
|
||||||
"@typescript-eslint/parser": "1.1.0",
|
|
||||||
"async-listen": "^1.2.0",
|
|
||||||
"cpy-cli": "^2.0.0",
|
|
||||||
"eslint": "5.16.0",
|
|
||||||
"eslint-config-airbnb": "17.1.0",
|
|
||||||
"eslint-config-prettier": "4.1.0",
|
|
||||||
"eslint-import-resolver-typescript": "1.1.1",
|
|
||||||
"eslint-plugin-import": "2.16.0",
|
|
||||||
"eslint-plugin-jsx-a11y": "6.2.1",
|
|
||||||
"eslint-plugin-react": "7.12.4",
|
|
||||||
"mocha": "^6.2.0",
|
|
||||||
"rimraf": "^3.0.0",
|
|
||||||
"semver": "^7.1.2",
|
|
||||||
"typescript": "^3.5.3",
|
|
||||||
"ws": "^3.0.0"
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": ">= 6.0.0"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,345 +0,0 @@
|
|||||||
import net from 'net';
|
|
||||||
import http from 'http';
|
|
||||||
import https from 'https';
|
|
||||||
import { Duplex } from 'stream';
|
|
||||||
import { EventEmitter } from 'events';
|
|
||||||
import createDebug from 'debug';
|
|
||||||
import promisify from './promisify';
|
|
||||||
|
|
||||||
const debug = createDebug('agent-base');
|
|
||||||
|
|
||||||
function isAgent(v: any): v is createAgent.AgentLike {
|
|
||||||
return Boolean(v) && typeof v.addRequest === 'function';
|
|
||||||
}
|
|
||||||
|
|
||||||
function isSecureEndpoint(): boolean {
|
|
||||||
const { stack } = new Error();
|
|
||||||
if (typeof stack !== 'string') return false;
|
|
||||||
return stack.split('\n').some(l => l.indexOf('(https.js:') !== -1 || l.indexOf('node:https:') !== -1);
|
|
||||||
}
|
|
||||||
|
|
||||||
function createAgent(opts?: createAgent.AgentOptions): createAgent.Agent;
|
|
||||||
function createAgent(
|
|
||||||
callback: createAgent.AgentCallback,
|
|
||||||
opts?: createAgent.AgentOptions
|
|
||||||
): createAgent.Agent;
|
|
||||||
function createAgent(
|
|
||||||
callback?: createAgent.AgentCallback | createAgent.AgentOptions,
|
|
||||||
opts?: createAgent.AgentOptions
|
|
||||||
) {
|
|
||||||
return new createAgent.Agent(callback, opts);
|
|
||||||
}
|
|
||||||
|
|
||||||
namespace createAgent {
|
|
||||||
export interface ClientRequest extends http.ClientRequest {
|
|
||||||
_last?: boolean;
|
|
||||||
_hadError?: boolean;
|
|
||||||
method: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface AgentRequestOptions {
|
|
||||||
host?: string;
|
|
||||||
path?: string;
|
|
||||||
// `port` on `http.RequestOptions` can be a string or undefined,
|
|
||||||
// but `net.TcpNetConnectOpts` expects only a number
|
|
||||||
port: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface HttpRequestOptions
|
|
||||||
extends AgentRequestOptions,
|
|
||||||
Omit<http.RequestOptions, keyof AgentRequestOptions> {
|
|
||||||
secureEndpoint: false;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface HttpsRequestOptions
|
|
||||||
extends AgentRequestOptions,
|
|
||||||
Omit<https.RequestOptions, keyof AgentRequestOptions> {
|
|
||||||
secureEndpoint: true;
|
|
||||||
}
|
|
||||||
|
|
||||||
export type RequestOptions = HttpRequestOptions | HttpsRequestOptions;
|
|
||||||
|
|
||||||
export type AgentLike = Pick<createAgent.Agent, 'addRequest'> | http.Agent;
|
|
||||||
|
|
||||||
export type AgentCallbackReturn = Duplex | AgentLike;
|
|
||||||
|
|
||||||
export type AgentCallbackCallback = (
|
|
||||||
err?: Error | null,
|
|
||||||
socket?: createAgent.AgentCallbackReturn
|
|
||||||
) => void;
|
|
||||||
|
|
||||||
export type AgentCallbackPromise = (
|
|
||||||
req: createAgent.ClientRequest,
|
|
||||||
opts: createAgent.RequestOptions
|
|
||||||
) =>
|
|
||||||
| createAgent.AgentCallbackReturn
|
|
||||||
| Promise<createAgent.AgentCallbackReturn>;
|
|
||||||
|
|
||||||
export type AgentCallback = typeof Agent.prototype.callback;
|
|
||||||
|
|
||||||
export type AgentOptions = {
|
|
||||||
timeout?: number;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Base `http.Agent` implementation.
|
|
||||||
* No pooling/keep-alive is implemented by default.
|
|
||||||
*
|
|
||||||
* @param {Function} callback
|
|
||||||
* @api public
|
|
||||||
*/
|
|
||||||
export class Agent extends EventEmitter {
|
|
||||||
public timeout: number | null;
|
|
||||||
public maxFreeSockets: number;
|
|
||||||
public maxTotalSockets: number;
|
|
||||||
public maxSockets: number;
|
|
||||||
public sockets: {
|
|
||||||
[key: string]: net.Socket[];
|
|
||||||
};
|
|
||||||
public freeSockets: {
|
|
||||||
[key: string]: net.Socket[];
|
|
||||||
};
|
|
||||||
public requests: {
|
|
||||||
[key: string]: http.IncomingMessage[];
|
|
||||||
};
|
|
||||||
public options: https.AgentOptions;
|
|
||||||
private promisifiedCallback?: createAgent.AgentCallbackPromise;
|
|
||||||
private explicitDefaultPort?: number;
|
|
||||||
private explicitProtocol?: string;
|
|
||||||
|
|
||||||
constructor(
|
|
||||||
callback?: createAgent.AgentCallback | createAgent.AgentOptions,
|
|
||||||
_opts?: createAgent.AgentOptions
|
|
||||||
) {
|
|
||||||
super();
|
|
||||||
|
|
||||||
let opts = _opts;
|
|
||||||
if (typeof callback === 'function') {
|
|
||||||
this.callback = callback;
|
|
||||||
} else if (callback) {
|
|
||||||
opts = callback;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Timeout for the socket to be returned from the callback
|
|
||||||
this.timeout = null;
|
|
||||||
if (opts && typeof opts.timeout === 'number') {
|
|
||||||
this.timeout = opts.timeout;
|
|
||||||
}
|
|
||||||
|
|
||||||
// These aren't actually used by `agent-base`, but are required
|
|
||||||
// for the TypeScript definition files in `@types/node` :/
|
|
||||||
this.maxFreeSockets = 1;
|
|
||||||
this.maxSockets = 1;
|
|
||||||
this.maxTotalSockets = Infinity;
|
|
||||||
this.sockets = {};
|
|
||||||
this.freeSockets = {};
|
|
||||||
this.requests = {};
|
|
||||||
this.options = {};
|
|
||||||
}
|
|
||||||
|
|
||||||
get defaultPort(): number {
|
|
||||||
if (typeof this.explicitDefaultPort === 'number') {
|
|
||||||
return this.explicitDefaultPort;
|
|
||||||
}
|
|
||||||
return isSecureEndpoint() ? 443 : 80;
|
|
||||||
}
|
|
||||||
|
|
||||||
set defaultPort(v: number) {
|
|
||||||
this.explicitDefaultPort = v;
|
|
||||||
}
|
|
||||||
|
|
||||||
get protocol(): string {
|
|
||||||
if (typeof this.explicitProtocol === 'string') {
|
|
||||||
return this.explicitProtocol;
|
|
||||||
}
|
|
||||||
return isSecureEndpoint() ? 'https:' : 'http:';
|
|
||||||
}
|
|
||||||
|
|
||||||
set protocol(v: string) {
|
|
||||||
this.explicitProtocol = v;
|
|
||||||
}
|
|
||||||
|
|
||||||
callback(
|
|
||||||
req: createAgent.ClientRequest,
|
|
||||||
opts: createAgent.RequestOptions,
|
|
||||||
fn: createAgent.AgentCallbackCallback
|
|
||||||
): void;
|
|
||||||
callback(
|
|
||||||
req: createAgent.ClientRequest,
|
|
||||||
opts: createAgent.RequestOptions
|
|
||||||
):
|
|
||||||
| createAgent.AgentCallbackReturn
|
|
||||||
| Promise<createAgent.AgentCallbackReturn>;
|
|
||||||
callback(
|
|
||||||
req: createAgent.ClientRequest,
|
|
||||||
opts: createAgent.AgentOptions,
|
|
||||||
fn?: createAgent.AgentCallbackCallback
|
|
||||||
):
|
|
||||||
| createAgent.AgentCallbackReturn
|
|
||||||
| Promise<createAgent.AgentCallbackReturn>
|
|
||||||
| void {
|
|
||||||
throw new Error(
|
|
||||||
'"agent-base" has no default implementation, you must subclass and override `callback()`'
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Called by node-core's "_http_client.js" module when creating
|
|
||||||
* a new HTTP request with this Agent instance.
|
|
||||||
*
|
|
||||||
* @api public
|
|
||||||
*/
|
|
||||||
addRequest(req: ClientRequest, _opts: RequestOptions): void {
|
|
||||||
const opts: RequestOptions = { ..._opts };
|
|
||||||
|
|
||||||
if (typeof opts.secureEndpoint !== 'boolean') {
|
|
||||||
opts.secureEndpoint = isSecureEndpoint();
|
|
||||||
}
|
|
||||||
|
|
||||||
if (opts.host == null) {
|
|
||||||
opts.host = 'localhost';
|
|
||||||
}
|
|
||||||
|
|
||||||
if (opts.port == null) {
|
|
||||||
opts.port = opts.secureEndpoint ? 443 : 80;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (opts.protocol == null) {
|
|
||||||
opts.protocol = opts.secureEndpoint ? 'https:' : 'http:';
|
|
||||||
}
|
|
||||||
|
|
||||||
if (opts.host && opts.path) {
|
|
||||||
// If both a `host` and `path` are specified then it's most
|
|
||||||
// likely the result of a `url.parse()` call... we need to
|
|
||||||
// remove the `path` portion so that `net.connect()` doesn't
|
|
||||||
// attempt to open that as a unix socket file.
|
|
||||||
delete opts.path;
|
|
||||||
}
|
|
||||||
|
|
||||||
delete opts.agent;
|
|
||||||
delete opts.hostname;
|
|
||||||
delete opts._defaultAgent;
|
|
||||||
delete opts.defaultPort;
|
|
||||||
delete opts.createConnection;
|
|
||||||
|
|
||||||
// Hint to use "Connection: close"
|
|
||||||
// XXX: non-documented `http` module API :(
|
|
||||||
req._last = true;
|
|
||||||
req.shouldKeepAlive = false;
|
|
||||||
|
|
||||||
let timedOut = false;
|
|
||||||
let timeoutId: ReturnType<typeof setTimeout> | null = null;
|
|
||||||
const timeoutMs = opts.timeout || this.timeout;
|
|
||||||
|
|
||||||
const onerror = (err: NodeJS.ErrnoException) => {
|
|
||||||
if (req._hadError) return;
|
|
||||||
req.emit('error', err);
|
|
||||||
// For Safety. Some additional errors might fire later on
|
|
||||||
// and we need to make sure we don't double-fire the error event.
|
|
||||||
req._hadError = true;
|
|
||||||
};
|
|
||||||
|
|
||||||
const ontimeout = () => {
|
|
||||||
timeoutId = null;
|
|
||||||
timedOut = true;
|
|
||||||
const err: NodeJS.ErrnoException = new Error(
|
|
||||||
`A "socket" was not created for HTTP request before ${timeoutMs}ms`
|
|
||||||
);
|
|
||||||
err.code = 'ETIMEOUT';
|
|
||||||
onerror(err);
|
|
||||||
};
|
|
||||||
|
|
||||||
const callbackError = (err: NodeJS.ErrnoException) => {
|
|
||||||
if (timedOut) return;
|
|
||||||
if (timeoutId !== null) {
|
|
||||||
clearTimeout(timeoutId);
|
|
||||||
timeoutId = null;
|
|
||||||
}
|
|
||||||
onerror(err);
|
|
||||||
};
|
|
||||||
|
|
||||||
const onsocket = (socket: AgentCallbackReturn) => {
|
|
||||||
if (timedOut) return;
|
|
||||||
if (timeoutId != null) {
|
|
||||||
clearTimeout(timeoutId);
|
|
||||||
timeoutId = null;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (isAgent(socket)) {
|
|
||||||
// `socket` is actually an `http.Agent` instance, so
|
|
||||||
// relinquish responsibility for this `req` to the Agent
|
|
||||||
// from here on
|
|
||||||
debug(
|
|
||||||
'Callback returned another Agent instance %o',
|
|
||||||
socket.constructor.name
|
|
||||||
);
|
|
||||||
(socket as createAgent.Agent).addRequest(req, opts);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (socket) {
|
|
||||||
socket.once('free', () => {
|
|
||||||
this.freeSocket(socket as net.Socket, opts);
|
|
||||||
});
|
|
||||||
req.onSocket(socket as net.Socket);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const err = new Error(
|
|
||||||
`no Duplex stream was returned to agent-base for \`${req.method} ${req.path}\``
|
|
||||||
);
|
|
||||||
onerror(err);
|
|
||||||
};
|
|
||||||
|
|
||||||
if (typeof this.callback !== 'function') {
|
|
||||||
onerror(new Error('`callback` is not defined'));
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!this.promisifiedCallback) {
|
|
||||||
if (this.callback.length >= 3) {
|
|
||||||
debug('Converting legacy callback function to promise');
|
|
||||||
this.promisifiedCallback = promisify(this.callback);
|
|
||||||
} else {
|
|
||||||
this.promisifiedCallback = this.callback;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (typeof timeoutMs === 'number' && timeoutMs > 0) {
|
|
||||||
timeoutId = setTimeout(ontimeout, timeoutMs);
|
|
||||||
}
|
|
||||||
|
|
||||||
if ('port' in opts && typeof opts.port !== 'number') {
|
|
||||||
opts.port = Number(opts.port);
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
|
||||||
debug(
|
|
||||||
'Resolving socket for %o request: %o',
|
|
||||||
opts.protocol,
|
|
||||||
`${req.method} ${req.path}`
|
|
||||||
);
|
|
||||||
Promise.resolve(this.promisifiedCallback(req, opts)).then(
|
|
||||||
onsocket,
|
|
||||||
callbackError
|
|
||||||
);
|
|
||||||
} catch (err) {
|
|
||||||
Promise.reject(err).catch(callbackError);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
freeSocket(socket: net.Socket, opts: AgentOptions) {
|
|
||||||
debug('Freeing socket %o %o', socket.constructor.name, opts);
|
|
||||||
socket.destroy();
|
|
||||||
}
|
|
||||||
|
|
||||||
destroy() {
|
|
||||||
debug('Destroying agent %o', this.constructor.name);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// So that `instanceof` works correctly
|
|
||||||
createAgent.prototype = createAgent.Agent.prototype;
|
|
||||||
}
|
|
||||||
|
|
||||||
export = createAgent;
|
|
||||||
@ -1,33 +0,0 @@
|
|||||||
import {
|
|
||||||
Agent,
|
|
||||||
ClientRequest,
|
|
||||||
RequestOptions,
|
|
||||||
AgentCallbackCallback,
|
|
||||||
AgentCallbackPromise,
|
|
||||||
AgentCallbackReturn
|
|
||||||
} from './index';
|
|
||||||
|
|
||||||
type LegacyCallback = (
|
|
||||||
req: ClientRequest,
|
|
||||||
opts: RequestOptions,
|
|
||||||
fn: AgentCallbackCallback
|
|
||||||
) => void;
|
|
||||||
|
|
||||||
export default function promisify(fn: LegacyCallback): AgentCallbackPromise {
|
|
||||||
return function(this: Agent, req: ClientRequest, opts: RequestOptions) {
|
|
||||||
return new Promise((resolve, reject) => {
|
|
||||||
fn.call(
|
|
||||||
this,
|
|
||||||
req,
|
|
||||||
opts,
|
|
||||||
(err: Error | null | undefined, rtn?: AgentCallbackReturn) => {
|
|
||||||
if (err) {
|
|
||||||
reject(err);
|
|
||||||
} else {
|
|
||||||
resolve(rtn);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
);
|
|
||||||
});
|
|
||||||
};
|
|
||||||
}
|
|
||||||
@ -1,37 +0,0 @@
|
|||||||
declare namespace ansiRegex {
|
|
||||||
interface Options {
|
|
||||||
/**
|
|
||||||
Match only the first ANSI escape.
|
|
||||||
|
|
||||||
@default false
|
|
||||||
*/
|
|
||||||
onlyFirst: boolean;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
Regular expression for matching ANSI escape codes.
|
|
||||||
|
|
||||||
@example
|
|
||||||
```
|
|
||||||
import ansiRegex = require('ansi-regex');
|
|
||||||
|
|
||||||
ansiRegex().test('\u001B[4mcake\u001B[0m');
|
|
||||||
//=> true
|
|
||||||
|
|
||||||
ansiRegex().test('cake');
|
|
||||||
//=> false
|
|
||||||
|
|
||||||
'\u001B[4mcake\u001B[0m'.match(ansiRegex());
|
|
||||||
//=> ['\u001B[4m', '\u001B[0m']
|
|
||||||
|
|
||||||
'\u001B[4mcake\u001B[0m'.match(ansiRegex({onlyFirst: true}));
|
|
||||||
//=> ['\u001B[4m']
|
|
||||||
|
|
||||||
'\u001B]8;;https://github.com\u0007click\u001B]8;;\u0007'.match(ansiRegex());
|
|
||||||
//=> ['\u001B]8;;https://github.com\u0007', '\u001B]8;;\u0007']
|
|
||||||
```
|
|
||||||
*/
|
|
||||||
declare function ansiRegex(options?: ansiRegex.Options): RegExp;
|
|
||||||
|
|
||||||
export = ansiRegex;
|
|
||||||
@ -1,10 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
module.exports = ({onlyFirst = false} = {}) => {
|
|
||||||
const pattern = [
|
|
||||||
'[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]+)*|[a-zA-Z\\d]+(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)',
|
|
||||||
'(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))'
|
|
||||||
].join('|');
|
|
||||||
|
|
||||||
return new RegExp(pattern, onlyFirst ? undefined : 'g');
|
|
||||||
};
|
|
||||||
@ -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,55 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "ansi-regex",
|
|
||||||
"version": "5.0.1",
|
|
||||||
"description": "Regular expression for matching ANSI escape codes",
|
|
||||||
"license": "MIT",
|
|
||||||
"repository": "chalk/ansi-regex",
|
|
||||||
"author": {
|
|
||||||
"name": "Sindre Sorhus",
|
|
||||||
"email": "sindresorhus@gmail.com",
|
|
||||||
"url": "sindresorhus.com"
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": ">=8"
|
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"test": "xo && ava && tsd",
|
|
||||||
"view-supported": "node fixtures/view-codes.js"
|
|
||||||
},
|
|
||||||
"files": [
|
|
||||||
"index.js",
|
|
||||||
"index.d.ts"
|
|
||||||
],
|
|
||||||
"keywords": [
|
|
||||||
"ansi",
|
|
||||||
"styles",
|
|
||||||
"color",
|
|
||||||
"colour",
|
|
||||||
"colors",
|
|
||||||
"terminal",
|
|
||||||
"console",
|
|
||||||
"cli",
|
|
||||||
"string",
|
|
||||||
"tty",
|
|
||||||
"escape",
|
|
||||||
"formatting",
|
|
||||||
"rgb",
|
|
||||||
"256",
|
|
||||||
"shell",
|
|
||||||
"xterm",
|
|
||||||
"command-line",
|
|
||||||
"text",
|
|
||||||
"regex",
|
|
||||||
"regexp",
|
|
||||||
"re",
|
|
||||||
"match",
|
|
||||||
"test",
|
|
||||||
"find",
|
|
||||||
"pattern"
|
|
||||||
],
|
|
||||||
"devDependencies": {
|
|
||||||
"ava": "^2.4.0",
|
|
||||||
"tsd": "^0.9.0",
|
|
||||||
"xo": "^0.25.3"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,78 +0,0 @@
|
|||||||
# ansi-regex
|
|
||||||
|
|
||||||
> Regular expression for matching [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code)
|
|
||||||
|
|
||||||
|
|
||||||
## Install
|
|
||||||
|
|
||||||
```
|
|
||||||
$ npm install ansi-regex
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```js
|
|
||||||
const ansiRegex = require('ansi-regex');
|
|
||||||
|
|
||||||
ansiRegex().test('\u001B[4mcake\u001B[0m');
|
|
||||||
//=> true
|
|
||||||
|
|
||||||
ansiRegex().test('cake');
|
|
||||||
//=> false
|
|
||||||
|
|
||||||
'\u001B[4mcake\u001B[0m'.match(ansiRegex());
|
|
||||||
//=> ['\u001B[4m', '\u001B[0m']
|
|
||||||
|
|
||||||
'\u001B[4mcake\u001B[0m'.match(ansiRegex({onlyFirst: true}));
|
|
||||||
//=> ['\u001B[4m']
|
|
||||||
|
|
||||||
'\u001B]8;;https://github.com\u0007click\u001B]8;;\u0007'.match(ansiRegex());
|
|
||||||
//=> ['\u001B]8;;https://github.com\u0007', '\u001B]8;;\u0007']
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## API
|
|
||||||
|
|
||||||
### ansiRegex(options?)
|
|
||||||
|
|
||||||
Returns a regex for matching ANSI escape codes.
|
|
||||||
|
|
||||||
#### options
|
|
||||||
|
|
||||||
Type: `object`
|
|
||||||
|
|
||||||
##### onlyFirst
|
|
||||||
|
|
||||||
Type: `boolean`<br>
|
|
||||||
Default: `false` *(Matches any ANSI escape codes in a string)*
|
|
||||||
|
|
||||||
Match only the first ANSI escape.
|
|
||||||
|
|
||||||
|
|
||||||
## FAQ
|
|
||||||
|
|
||||||
### Why do you test for codes not in the ECMA 48 standard?
|
|
||||||
|
|
||||||
Some of the codes we run as a test are codes that we acquired finding various lists of non-standard or manufacturer specific codes. We test for both standard and non-standard codes, as most of them follow the same or similar format and can be safely matched in strings without the risk of removing actual string content. There are a few non-standard control codes that do not follow the traditional format (i.e. they end in numbers) thus forcing us to exclude them from the test because we cannot reliably match them.
|
|
||||||
|
|
||||||
On the historical side, those ECMA standards were established in the early 90's whereas the VT100, for example, was designed in the mid/late 70's. At that point in time, control codes were still pretty ungoverned and engineers used them for a multitude of things, namely to activate hardware ports that may have been proprietary. Somewhere else you see a similar 'anarchy' of codes is in the x86 architecture for processors; there are a ton of "interrupts" that can mean different things on certain brands of processors, most of which have been phased out.
|
|
||||||
|
|
||||||
|
|
||||||
## Maintainers
|
|
||||||
|
|
||||||
- [Sindre Sorhus](https://github.com/sindresorhus)
|
|
||||||
- [Josh Junon](https://github.com/qix-)
|
|
||||||
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
<div align="center">
|
|
||||||
<b>
|
|
||||||
<a href="https://tidelift.com/subscription/pkg/npm-ansi-regex?utm_source=npm-ansi-regex&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,4 +0,0 @@
|
|||||||
2.0.0
|
|
||||||
* Drop support for 0.10 and 0.12. They haven't been in travis but still,
|
|
||||||
since we _know_ we'll break with them now it's only polite to do a
|
|
||||||
major bump.
|
|
||||||
@ -1,14 +0,0 @@
|
|||||||
Copyright (c) 2015, Rebecca Turner <me@re-becca.org>
|
|
||||||
|
|
||||||
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,94 +0,0 @@
|
|||||||
aproba
|
|
||||||
======
|
|
||||||
|
|
||||||
A ridiculously light-weight function argument validator
|
|
||||||
|
|
||||||
```
|
|
||||||
var validate = require("aproba")
|
|
||||||
|
|
||||||
function myfunc(a, b, c) {
|
|
||||||
// `a` must be a string, `b` a number, `c` a function
|
|
||||||
validate('SNF', arguments) // [a,b,c] is also valid
|
|
||||||
}
|
|
||||||
|
|
||||||
myfunc('test', 23, function () {}) // ok
|
|
||||||
myfunc(123, 23, function () {}) // type error
|
|
||||||
myfunc('test', 23) // missing arg error
|
|
||||||
myfunc('test', 23, function () {}, true) // too many args error
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
Valid types are:
|
|
||||||
|
|
||||||
| type | description
|
|
||||||
| :--: | :----------
|
|
||||||
| * | matches any type
|
|
||||||
| A | `Array.isArray` OR an `arguments` object
|
|
||||||
| S | typeof == string
|
|
||||||
| N | typeof == number
|
|
||||||
| F | typeof == function
|
|
||||||
| O | typeof == object and not type A and not type E
|
|
||||||
| B | typeof == boolean
|
|
||||||
| E | `instanceof Error` OR `null` **(special: see below)**
|
|
||||||
| Z | == `null`
|
|
||||||
|
|
||||||
Validation failures throw one of three exception types, distinguished by a
|
|
||||||
`code` property of `EMISSINGARG`, `EINVALIDTYPE` or `ETOOMANYARGS`.
|
|
||||||
|
|
||||||
If you pass in an invalid type then it will throw with a code of
|
|
||||||
`EUNKNOWNTYPE`.
|
|
||||||
|
|
||||||
If an **error** argument is found and is not null then the remaining
|
|
||||||
arguments are optional. That is, if you say `ESO` then that's like using a
|
|
||||||
non-magical `E` in: `E|ESO|ZSO`.
|
|
||||||
|
|
||||||
### But I have optional arguments?!
|
|
||||||
|
|
||||||
You can provide more than one signature by separating them with pipes `|`.
|
|
||||||
If any signature matches the arguments then they'll be considered valid.
|
|
||||||
|
|
||||||
So for example, say you wanted to write a signature for
|
|
||||||
`fs.createWriteStream`. The docs for it describe it thusly:
|
|
||||||
|
|
||||||
```
|
|
||||||
fs.createWriteStream(path[, options])
|
|
||||||
```
|
|
||||||
|
|
||||||
This would be a signature of `SO|S`. That is, a string and and object, or
|
|
||||||
just a string.
|
|
||||||
|
|
||||||
Now, if you read the full `fs` docs, you'll see that actually path can ALSO
|
|
||||||
be a buffer. And options can be a string, that is:
|
|
||||||
```
|
|
||||||
path <String> | <Buffer>
|
|
||||||
options <String> | <Object>
|
|
||||||
```
|
|
||||||
|
|
||||||
To reproduce this you have to fully enumerate all of the possible
|
|
||||||
combinations and that implies a signature of `SO|SS|OO|OS|S|O`. The
|
|
||||||
awkwardness is a feature: It reminds you of the complexity you're adding to
|
|
||||||
your API when you do this sort of thing.
|
|
||||||
|
|
||||||
|
|
||||||
### Browser support
|
|
||||||
|
|
||||||
This has no dependencies and should work in browsers, though you'll have
|
|
||||||
noisier stack traces.
|
|
||||||
|
|
||||||
### Why this exists
|
|
||||||
|
|
||||||
I wanted a very simple argument validator. It needed to do two things:
|
|
||||||
|
|
||||||
1. Be more concise and easier to use than assertions
|
|
||||||
|
|
||||||
2. Not encourage an infinite bikeshed of DSLs
|
|
||||||
|
|
||||||
This is why types are specified by a single character and there's no such
|
|
||||||
thing as an optional argument.
|
|
||||||
|
|
||||||
This is not intended to validate user data. This is specifically about
|
|
||||||
asserting the interface of your functions.
|
|
||||||
|
|
||||||
If you need greater validation, I encourage you to write them by hand or
|
|
||||||
look elsewhere.
|
|
||||||
|
|
||||||
@ -1,105 +0,0 @@
|
|||||||
'use strict'
|
|
||||||
module.exports = validate
|
|
||||||
|
|
||||||
function isArguments (thingy) {
|
|
||||||
return thingy != null && typeof thingy === 'object' && thingy.hasOwnProperty('callee')
|
|
||||||
}
|
|
||||||
|
|
||||||
const types = {
|
|
||||||
'*': {label: 'any', check: () => true},
|
|
||||||
A: {label: 'array', check: _ => Array.isArray(_) || isArguments(_)},
|
|
||||||
S: {label: 'string', check: _ => typeof _ === 'string'},
|
|
||||||
N: {label: 'number', check: _ => typeof _ === 'number'},
|
|
||||||
F: {label: 'function', check: _ => typeof _ === 'function'},
|
|
||||||
O: {label: 'object', check: _ => typeof _ === 'object' && _ != null && !types.A.check(_) && !types.E.check(_)},
|
|
||||||
B: {label: 'boolean', check: _ => typeof _ === 'boolean'},
|
|
||||||
E: {label: 'error', check: _ => _ instanceof Error},
|
|
||||||
Z: {label: 'null', check: _ => _ == null}
|
|
||||||
}
|
|
||||||
|
|
||||||
function addSchema (schema, arity) {
|
|
||||||
const group = arity[schema.length] = arity[schema.length] || []
|
|
||||||
if (group.indexOf(schema) === -1) group.push(schema)
|
|
||||||
}
|
|
||||||
|
|
||||||
function validate (rawSchemas, args) {
|
|
||||||
if (arguments.length !== 2) throw wrongNumberOfArgs(['SA'], arguments.length)
|
|
||||||
if (!rawSchemas) throw missingRequiredArg(0, 'rawSchemas')
|
|
||||||
if (!args) throw missingRequiredArg(1, 'args')
|
|
||||||
if (!types.S.check(rawSchemas)) throw invalidType(0, ['string'], rawSchemas)
|
|
||||||
if (!types.A.check(args)) throw invalidType(1, ['array'], args)
|
|
||||||
const schemas = rawSchemas.split('|')
|
|
||||||
const arity = {}
|
|
||||||
|
|
||||||
schemas.forEach(schema => {
|
|
||||||
for (let ii = 0; ii < schema.length; ++ii) {
|
|
||||||
const type = schema[ii]
|
|
||||||
if (!types[type]) throw unknownType(ii, type)
|
|
||||||
}
|
|
||||||
if (/E.*E/.test(schema)) throw moreThanOneError(schema)
|
|
||||||
addSchema(schema, arity)
|
|
||||||
if (/E/.test(schema)) {
|
|
||||||
addSchema(schema.replace(/E.*$/, 'E'), arity)
|
|
||||||
addSchema(schema.replace(/E/, 'Z'), arity)
|
|
||||||
if (schema.length === 1) addSchema('', arity)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
let matching = arity[args.length]
|
|
||||||
if (!matching) {
|
|
||||||
throw wrongNumberOfArgs(Object.keys(arity), args.length)
|
|
||||||
}
|
|
||||||
for (let ii = 0; ii < args.length; ++ii) {
|
|
||||||
let newMatching = matching.filter(schema => {
|
|
||||||
const type = schema[ii]
|
|
||||||
const typeCheck = types[type].check
|
|
||||||
return typeCheck(args[ii])
|
|
||||||
})
|
|
||||||
if (!newMatching.length) {
|
|
||||||
const labels = matching.map(_ => types[_[ii]].label).filter(_ => _ != null)
|
|
||||||
throw invalidType(ii, labels, args[ii])
|
|
||||||
}
|
|
||||||
matching = newMatching
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function missingRequiredArg (num) {
|
|
||||||
return newException('EMISSINGARG', 'Missing required argument #' + (num + 1))
|
|
||||||
}
|
|
||||||
|
|
||||||
function unknownType (num, type) {
|
|
||||||
return newException('EUNKNOWNTYPE', 'Unknown type ' + type + ' in argument #' + (num + 1))
|
|
||||||
}
|
|
||||||
|
|
||||||
function invalidType (num, expectedTypes, value) {
|
|
||||||
let valueType
|
|
||||||
Object.keys(types).forEach(typeCode => {
|
|
||||||
if (types[typeCode].check(value)) valueType = types[typeCode].label
|
|
||||||
})
|
|
||||||
return newException('EINVALIDTYPE', 'Argument #' + (num + 1) + ': Expected ' +
|
|
||||||
englishList(expectedTypes) + ' but got ' + valueType)
|
|
||||||
}
|
|
||||||
|
|
||||||
function englishList (list) {
|
|
||||||
return list.join(', ').replace(/, ([^,]+)$/, ' or $1')
|
|
||||||
}
|
|
||||||
|
|
||||||
function wrongNumberOfArgs (expected, got) {
|
|
||||||
const english = englishList(expected)
|
|
||||||
const args = expected.every(ex => ex.length === 1)
|
|
||||||
? 'argument'
|
|
||||||
: 'arguments'
|
|
||||||
return newException('EWRONGARGCOUNT', 'Expected ' + english + ' ' + args + ' but got ' + got)
|
|
||||||
}
|
|
||||||
|
|
||||||
function moreThanOneError (schema) {
|
|
||||||
return newException('ETOOMANYERRORTYPES',
|
|
||||||
'Only one error type per argument signature is allowed, more than one found in "' + schema + '"')
|
|
||||||
}
|
|
||||||
|
|
||||||
function newException (code, msg) {
|
|
||||||
const err = new Error(msg)
|
|
||||||
err.code = code
|
|
||||||
/* istanbul ignore else */
|
|
||||||
if (Error.captureStackTrace) Error.captureStackTrace(err, validate)
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
@ -1,35 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "aproba",
|
|
||||||
"version": "2.0.0",
|
|
||||||
"description": "A ridiculously light-weight argument validator (now browser friendly)",
|
|
||||||
"main": "index.js",
|
|
||||||
"directories": {
|
|
||||||
"test": "test"
|
|
||||||
},
|
|
||||||
"dependencies": {},
|
|
||||||
"devDependencies": {
|
|
||||||
"standard": "^11.0.1",
|
|
||||||
"tap": "^12.0.1"
|
|
||||||
},
|
|
||||||
"files": [
|
|
||||||
"index.js"
|
|
||||||
],
|
|
||||||
"scripts": {
|
|
||||||
"pretest": "standard",
|
|
||||||
"test": "tap --100 -J test/*.js"
|
|
||||||
},
|
|
||||||
"repository": {
|
|
||||||
"type": "git",
|
|
||||||
"url": "https://github.com/iarna/aproba"
|
|
||||||
},
|
|
||||||
"keywords": [
|
|
||||||
"argument",
|
|
||||||
"validate"
|
|
||||||
],
|
|
||||||
"author": "Rebecca Turner <me@re-becca.org>",
|
|
||||||
"license": "ISC",
|
|
||||||
"bugs": {
|
|
||||||
"url": "https://github.com/iarna/aproba/issues"
|
|
||||||
},
|
|
||||||
"homepage": "https://github.com/iarna/aproba"
|
|
||||||
}
|
|
||||||
@ -1,18 +0,0 @@
|
|||||||
ISC License
|
|
||||||
|
|
||||||
Copyright npm, Inc.
|
|
||||||
|
|
||||||
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 NPM DISCLAIMS ALL
|
|
||||||
WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
|
|
||||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
|
|
||||||
EVENT SHALL NPM 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,208 +0,0 @@
|
|||||||
are-we-there-yet
|
|
||||||
----------------
|
|
||||||
|
|
||||||
Track complex hierarchies of asynchronous task completion statuses. This is
|
|
||||||
intended to give you a way of recording and reporting the progress of the big
|
|
||||||
recursive fan-out and gather type workflows that are so common in async.
|
|
||||||
|
|
||||||
What you do with this completion data is up to you, but the most common use case is to
|
|
||||||
feed it to one of the many progress bar modules.
|
|
||||||
|
|
||||||
Most progress bar modules include a rudimentary version of this, but my
|
|
||||||
needs were more complex.
|
|
||||||
|
|
||||||
Usage
|
|
||||||
=====
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
var TrackerGroup = require("are-we-there-yet").TrackerGroup
|
|
||||||
|
|
||||||
var top = new TrackerGroup("program")
|
|
||||||
|
|
||||||
var single = top.newItem("one thing", 100)
|
|
||||||
single.completeWork(20)
|
|
||||||
|
|
||||||
console.log(top.completed()) // 0.2
|
|
||||||
|
|
||||||
fs.stat("file", function(er, stat) {
|
|
||||||
if (er) throw er
|
|
||||||
var stream = top.newStream("file", stat.size)
|
|
||||||
console.log(top.completed()) // now 0.1 as single is 50% of the job and is 20% complete
|
|
||||||
// and 50% * 20% == 10%
|
|
||||||
fs.createReadStream("file").pipe(stream).on("data", function (chunk) {
|
|
||||||
// do stuff with chunk
|
|
||||||
})
|
|
||||||
top.on("change", function (name) {
|
|
||||||
// called each time a chunk is read from "file"
|
|
||||||
// top.completed() will start at 0.1 and fill up to 0.6 as the file is read
|
|
||||||
})
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
Shared Methods
|
|
||||||
==============
|
|
||||||
|
|
||||||
* var completed = tracker.completed()
|
|
||||||
|
|
||||||
Implemented in: `Tracker`, `TrackerGroup`, `TrackerStream`
|
|
||||||
|
|
||||||
Returns the ratio of completed work to work to be done. Range of 0 to 1.
|
|
||||||
|
|
||||||
* tracker.finish()
|
|
||||||
|
|
||||||
Implemented in: `Tracker`, `TrackerGroup`
|
|
||||||
|
|
||||||
Marks the tracker as completed. With a TrackerGroup this marks all of its
|
|
||||||
components as completed.
|
|
||||||
|
|
||||||
Marks all of the components of this tracker as finished, which in turn means
|
|
||||||
that `tracker.completed()` for this will now be 1.
|
|
||||||
|
|
||||||
This will result in one or more `change` events being emitted.
|
|
||||||
|
|
||||||
Events
|
|
||||||
======
|
|
||||||
|
|
||||||
All tracker objects emit `change` events with the following arguments:
|
|
||||||
|
|
||||||
```
|
|
||||||
function (name, completed, tracker)
|
|
||||||
```
|
|
||||||
|
|
||||||
`name` is the name of the tracker that originally emitted the event,
|
|
||||||
or if it didn't have one, the first containing tracker group that had one.
|
|
||||||
|
|
||||||
`completed` is the percent complete (as returned by `tracker.completed()` method).
|
|
||||||
|
|
||||||
`tracker` is the tracker object that you are listening for events on.
|
|
||||||
|
|
||||||
TrackerGroup
|
|
||||||
============
|
|
||||||
|
|
||||||
* var tracker = new TrackerGroup(**name**)
|
|
||||||
|
|
||||||
* **name** *(optional)* - The name of this tracker group, used in change
|
|
||||||
notifications if the component updating didn't have a name. Defaults to undefined.
|
|
||||||
|
|
||||||
Creates a new empty tracker aggregation group. These are trackers whose
|
|
||||||
completion status is determined by the completion status of other trackers added to this aggregation group.
|
|
||||||
|
|
||||||
Ex.
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
var tracker = new TrackerGroup("parent")
|
|
||||||
var foo = tracker.newItem("firstChild", 100)
|
|
||||||
var bar = tracker.newItem("secondChild", 100)
|
|
||||||
|
|
||||||
foo.finish()
|
|
||||||
console.log(tracker.completed()) // 0.5
|
|
||||||
bar.finish()
|
|
||||||
console.log(tracker.completed()) // 1
|
|
||||||
```
|
|
||||||
|
|
||||||
* tracker.addUnit(**otherTracker**, **weight**)
|
|
||||||
|
|
||||||
* **otherTracker** - Any of the other are-we-there-yet tracker objects
|
|
||||||
* **weight** *(optional)* - The weight to give the tracker, defaults to 1.
|
|
||||||
|
|
||||||
Adds the **otherTracker** to this aggregation group. The weight determines
|
|
||||||
how long you expect this tracker to take to complete in proportion to other
|
|
||||||
units. So for instance, if you add one tracker with a weight of 1 and
|
|
||||||
another with a weight of 2, you're saying the second will take twice as long
|
|
||||||
to complete as the first. As such, the first will account for 33% of the
|
|
||||||
completion of this tracker and the second will account for the other 67%.
|
|
||||||
|
|
||||||
Returns **otherTracker**.
|
|
||||||
|
|
||||||
* var subGroup = tracker.newGroup(**name**, **weight**)
|
|
||||||
|
|
||||||
The above is exactly equivalent to:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
var subGroup = tracker.addUnit(new TrackerGroup(name), weight)
|
|
||||||
```
|
|
||||||
|
|
||||||
* var subItem = tracker.newItem(**name**, **todo**, **weight**)
|
|
||||||
|
|
||||||
The above is exactly equivalent to:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
var subItem = tracker.addUnit(new Tracker(name, todo), weight)
|
|
||||||
```
|
|
||||||
|
|
||||||
* var subStream = tracker.newStream(**name**, **todo**, **weight**)
|
|
||||||
|
|
||||||
The above is exactly equivalent to:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
var subStream = tracker.addUnit(new TrackerStream(name, todo), weight)
|
|
||||||
```
|
|
||||||
|
|
||||||
* console.log( tracker.debug() )
|
|
||||||
|
|
||||||
Returns a tree showing the completion of this tracker group and all of its
|
|
||||||
children, including recursively entering all of the children.
|
|
||||||
|
|
||||||
Tracker
|
|
||||||
=======
|
|
||||||
|
|
||||||
* var tracker = new Tracker(**name**, **todo**)
|
|
||||||
|
|
||||||
* **name** *(optional)* The name of this counter to report in change
|
|
||||||
events. Defaults to undefined.
|
|
||||||
* **todo** *(optional)* The amount of work todo (a number). Defaults to 0.
|
|
||||||
|
|
||||||
Ordinarily these are constructed as a part of a tracker group (via
|
|
||||||
`newItem`).
|
|
||||||
|
|
||||||
* var completed = tracker.completed()
|
|
||||||
|
|
||||||
Returns the ratio of completed work to work to be done. Range of 0 to 1. If
|
|
||||||
total work to be done is 0 then it will return 0.
|
|
||||||
|
|
||||||
* tracker.addWork(**todo**)
|
|
||||||
|
|
||||||
* **todo** A number to add to the amount of work to be done.
|
|
||||||
|
|
||||||
Increases the amount of work to be done, thus decreasing the completion
|
|
||||||
percentage. Triggers a `change` event.
|
|
||||||
|
|
||||||
* tracker.completeWork(**completed**)
|
|
||||||
|
|
||||||
* **completed** A number to add to the work complete
|
|
||||||
|
|
||||||
Increase the amount of work complete, thus increasing the completion percentage.
|
|
||||||
Will never increase the work completed past the amount of work todo. That is,
|
|
||||||
percentages > 100% are not allowed. Triggers a `change` event.
|
|
||||||
|
|
||||||
* tracker.finish()
|
|
||||||
|
|
||||||
Marks this tracker as finished, tracker.completed() will now be 1. Triggers
|
|
||||||
a `change` event.
|
|
||||||
|
|
||||||
TrackerStream
|
|
||||||
=============
|
|
||||||
|
|
||||||
* var tracker = new TrackerStream(**name**, **size**, **options**)
|
|
||||||
|
|
||||||
* **name** *(optional)* The name of this counter to report in change
|
|
||||||
events. Defaults to undefined.
|
|
||||||
* **size** *(optional)* The number of bytes being sent through this stream.
|
|
||||||
* **options** *(optional)* A hash of stream options
|
|
||||||
|
|
||||||
The tracker stream object is a pass through stream that updates an internal
|
|
||||||
tracker object each time a block passes through. It's intended to track
|
|
||||||
downloads, file extraction and other related activities. You use it by piping
|
|
||||||
your data source into it and then using it as your data source.
|
|
||||||
|
|
||||||
If your data has a length attribute then that's used as the amount of work
|
|
||||||
completed when the chunk is passed through. If it does not (eg, object
|
|
||||||
streams) then each chunk counts as completing 1 unit of work, so your size
|
|
||||||
should be the total number of objects being streamed.
|
|
||||||
|
|
||||||
* tracker.addWork(**todo**)
|
|
||||||
|
|
||||||
* **todo** Increase the expected overall size by **todo** bytes.
|
|
||||||
|
|
||||||
Increases the amount of work to be done, thus decreasing the completion
|
|
||||||
percentage. Triggers a `change` event.
|
|
||||||
@ -1,4 +0,0 @@
|
|||||||
'use strict'
|
|
||||||
exports.TrackerGroup = require('./tracker-group.js')
|
|
||||||
exports.Tracker = require('./tracker.js')
|
|
||||||
exports.TrackerStream = require('./tracker-stream.js')
|
|
||||||
@ -1,11 +0,0 @@
|
|||||||
'use strict'
|
|
||||||
var EventEmitter = require('events').EventEmitter
|
|
||||||
var util = require('util')
|
|
||||||
|
|
||||||
var trackerId = 0
|
|
||||||
var TrackerBase = module.exports = function (name) {
|
|
||||||
EventEmitter.call(this)
|
|
||||||
this.id = ++trackerId
|
|
||||||
this.name = name
|
|
||||||
}
|
|
||||||
util.inherits(TrackerBase, EventEmitter)
|
|
||||||
@ -1,116 +0,0 @@
|
|||||||
'use strict'
|
|
||||||
var util = require('util')
|
|
||||||
var TrackerBase = require('./tracker-base.js')
|
|
||||||
var Tracker = require('./tracker.js')
|
|
||||||
var TrackerStream = require('./tracker-stream.js')
|
|
||||||
|
|
||||||
var TrackerGroup = module.exports = function (name) {
|
|
||||||
TrackerBase.call(this, name)
|
|
||||||
this.parentGroup = null
|
|
||||||
this.trackers = []
|
|
||||||
this.completion = {}
|
|
||||||
this.weight = {}
|
|
||||||
this.totalWeight = 0
|
|
||||||
this.finished = false
|
|
||||||
this.bubbleChange = bubbleChange(this)
|
|
||||||
}
|
|
||||||
util.inherits(TrackerGroup, TrackerBase)
|
|
||||||
|
|
||||||
function bubbleChange (trackerGroup) {
|
|
||||||
return function (name, completed, tracker) {
|
|
||||||
trackerGroup.completion[tracker.id] = completed
|
|
||||||
if (trackerGroup.finished) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
trackerGroup.emit('change', name || trackerGroup.name, trackerGroup.completed(), trackerGroup)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
TrackerGroup.prototype.nameInTree = function () {
|
|
||||||
var names = []
|
|
||||||
var from = this
|
|
||||||
while (from) {
|
|
||||||
names.unshift(from.name)
|
|
||||||
from = from.parentGroup
|
|
||||||
}
|
|
||||||
return names.join('/')
|
|
||||||
}
|
|
||||||
|
|
||||||
TrackerGroup.prototype.addUnit = function (unit, weight) {
|
|
||||||
if (unit.addUnit) {
|
|
||||||
var toTest = this
|
|
||||||
while (toTest) {
|
|
||||||
if (unit === toTest) {
|
|
||||||
throw new Error(
|
|
||||||
'Attempted to add tracker group ' +
|
|
||||||
unit.name + ' to tree that already includes it ' +
|
|
||||||
this.nameInTree(this))
|
|
||||||
}
|
|
||||||
toTest = toTest.parentGroup
|
|
||||||
}
|
|
||||||
unit.parentGroup = this
|
|
||||||
}
|
|
||||||
this.weight[unit.id] = weight || 1
|
|
||||||
this.totalWeight += this.weight[unit.id]
|
|
||||||
this.trackers.push(unit)
|
|
||||||
this.completion[unit.id] = unit.completed()
|
|
||||||
unit.on('change', this.bubbleChange)
|
|
||||||
if (!this.finished) {
|
|
||||||
this.emit('change', unit.name, this.completion[unit.id], unit)
|
|
||||||
}
|
|
||||||
return unit
|
|
||||||
}
|
|
||||||
|
|
||||||
TrackerGroup.prototype.completed = function () {
|
|
||||||
if (this.trackers.length === 0) {
|
|
||||||
return 0
|
|
||||||
}
|
|
||||||
var valPerWeight = 1 / this.totalWeight
|
|
||||||
var completed = 0
|
|
||||||
for (var ii = 0; ii < this.trackers.length; ii++) {
|
|
||||||
var trackerId = this.trackers[ii].id
|
|
||||||
completed +=
|
|
||||||
valPerWeight * this.weight[trackerId] * this.completion[trackerId]
|
|
||||||
}
|
|
||||||
return completed
|
|
||||||
}
|
|
||||||
|
|
||||||
TrackerGroup.prototype.newGroup = function (name, weight) {
|
|
||||||
return this.addUnit(new TrackerGroup(name), weight)
|
|
||||||
}
|
|
||||||
|
|
||||||
TrackerGroup.prototype.newItem = function (name, todo, weight) {
|
|
||||||
return this.addUnit(new Tracker(name, todo), weight)
|
|
||||||
}
|
|
||||||
|
|
||||||
TrackerGroup.prototype.newStream = function (name, todo, weight) {
|
|
||||||
return this.addUnit(new TrackerStream(name, todo), weight)
|
|
||||||
}
|
|
||||||
|
|
||||||
TrackerGroup.prototype.finish = function () {
|
|
||||||
this.finished = true
|
|
||||||
if (!this.trackers.length) {
|
|
||||||
this.addUnit(new Tracker(), 1, true)
|
|
||||||
}
|
|
||||||
for (var ii = 0; ii < this.trackers.length; ii++) {
|
|
||||||
var tracker = this.trackers[ii]
|
|
||||||
tracker.finish()
|
|
||||||
tracker.removeListener('change', this.bubbleChange)
|
|
||||||
}
|
|
||||||
this.emit('change', this.name, 1, this)
|
|
||||||
}
|
|
||||||
|
|
||||||
var buffer = ' '
|
|
||||||
TrackerGroup.prototype.debug = function (depth) {
|
|
||||||
depth = depth || 0
|
|
||||||
var indent = depth ? buffer.substr(0, depth) : ''
|
|
||||||
var output = indent + (this.name || 'top') + ': ' + this.completed() + '\n'
|
|
||||||
this.trackers.forEach(function (tracker) {
|
|
||||||
if (tracker instanceof TrackerGroup) {
|
|
||||||
output += tracker.debug(depth + 1)
|
|
||||||
} else {
|
|
||||||
output += indent + ' ' + tracker.name + ': ' + tracker.completed() + '\n'
|
|
||||||
}
|
|
||||||
})
|
|
||||||
return output
|
|
||||||
}
|
|
||||||
@ -1,36 +0,0 @@
|
|||||||
'use strict'
|
|
||||||
var util = require('util')
|
|
||||||
var stream = require('readable-stream')
|
|
||||||
var delegate = require('delegates')
|
|
||||||
var Tracker = require('./tracker.js')
|
|
||||||
|
|
||||||
var TrackerStream = module.exports = function (name, size, options) {
|
|
||||||
stream.Transform.call(this, options)
|
|
||||||
this.tracker = new Tracker(name, size)
|
|
||||||
this.name = name
|
|
||||||
this.id = this.tracker.id
|
|
||||||
this.tracker.on('change', delegateChange(this))
|
|
||||||
}
|
|
||||||
util.inherits(TrackerStream, stream.Transform)
|
|
||||||
|
|
||||||
function delegateChange (trackerStream) {
|
|
||||||
return function (name, completion, tracker) {
|
|
||||||
trackerStream.emit('change', name, completion, trackerStream)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
TrackerStream.prototype._transform = function (data, encoding, cb) {
|
|
||||||
this.tracker.completeWork(data.length ? data.length : 1)
|
|
||||||
this.push(data)
|
|
||||||
cb()
|
|
||||||
}
|
|
||||||
|
|
||||||
TrackerStream.prototype._flush = function (cb) {
|
|
||||||
this.tracker.finish()
|
|
||||||
cb()
|
|
||||||
}
|
|
||||||
|
|
||||||
delegate(TrackerStream.prototype, 'tracker')
|
|
||||||
.method('completed')
|
|
||||||
.method('addWork')
|
|
||||||
.method('finish')
|
|
||||||
@ -1,32 +0,0 @@
|
|||||||
'use strict'
|
|
||||||
var util = require('util')
|
|
||||||
var TrackerBase = require('./tracker-base.js')
|
|
||||||
|
|
||||||
var Tracker = module.exports = function (name, todo) {
|
|
||||||
TrackerBase.call(this, name)
|
|
||||||
this.workDone = 0
|
|
||||||
this.workTodo = todo || 0
|
|
||||||
}
|
|
||||||
util.inherits(Tracker, TrackerBase)
|
|
||||||
|
|
||||||
Tracker.prototype.completed = function () {
|
|
||||||
return this.workTodo === 0 ? 0 : this.workDone / this.workTodo
|
|
||||||
}
|
|
||||||
|
|
||||||
Tracker.prototype.addWork = function (work) {
|
|
||||||
this.workTodo += work
|
|
||||||
this.emit('change', this.name, this.completed(), this)
|
|
||||||
}
|
|
||||||
|
|
||||||
Tracker.prototype.completeWork = function (work) {
|
|
||||||
this.workDone += work
|
|
||||||
if (this.workDone > this.workTodo) {
|
|
||||||
this.workDone = this.workTodo
|
|
||||||
}
|
|
||||||
this.emit('change', this.name, this.completed(), this)
|
|
||||||
}
|
|
||||||
|
|
||||||
Tracker.prototype.finish = function () {
|
|
||||||
this.workTodo = this.workDone = 1
|
|
||||||
this.emit('change', this.name, 1, this)
|
|
||||||
}
|
|
||||||
@ -1,53 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "are-we-there-yet",
|
|
||||||
"version": "2.0.0",
|
|
||||||
"description": "Keep track of the overall completion of many disparate processes",
|
|
||||||
"main": "lib/index.js",
|
|
||||||
"scripts": {
|
|
||||||
"test": "tap",
|
|
||||||
"npmclilint": "npmcli-lint",
|
|
||||||
"lint": "eslint '**/*.js'",
|
|
||||||
"lintfix": "npm run lint -- --fix",
|
|
||||||
"posttest": "npm run lint",
|
|
||||||
"postsnap": "npm run lintfix --",
|
|
||||||
"preversion": "npm test",
|
|
||||||
"postversion": "npm publish",
|
|
||||||
"prepublishOnly": "git push origin --follow-tags",
|
|
||||||
"snap": "tap"
|
|
||||||
},
|
|
||||||
"repository": {
|
|
||||||
"type": "git",
|
|
||||||
"url": "https://github.com/npm/are-we-there-yet.git"
|
|
||||||
},
|
|
||||||
"author": "GitHub Inc.",
|
|
||||||
"license": "ISC",
|
|
||||||
"bugs": {
|
|
||||||
"url": "https://github.com/npm/are-we-there-yet/issues"
|
|
||||||
},
|
|
||||||
"homepage": "https://github.com/npm/are-we-there-yet",
|
|
||||||
"devDependencies": {
|
|
||||||
"@npmcli/eslint-config": "^1.0.0",
|
|
||||||
"@npmcli/template-oss": "^1.0.2",
|
|
||||||
"eslint": "^7.32.0",
|
|
||||||
"eslint-plugin-node": "^11.1.0",
|
|
||||||
"tap": "^15.0.9"
|
|
||||||
},
|
|
||||||
"dependencies": {
|
|
||||||
"delegates": "^1.0.0",
|
|
||||||
"readable-stream": "^3.6.0"
|
|
||||||
},
|
|
||||||
"files": [
|
|
||||||
"bin",
|
|
||||||
"lib"
|
|
||||||
],
|
|
||||||
"engines": {
|
|
||||||
"node": ">=10"
|
|
||||||
},
|
|
||||||
"tap": {
|
|
||||||
"branches": 68,
|
|
||||||
"statements": 92,
|
|
||||||
"functions": 86,
|
|
||||||
"lines": 92
|
|
||||||
},
|
|
||||||
"templateVersion": "1.0.2"
|
|
||||||
}
|
|
||||||
@ -1,2 +0,0 @@
|
|||||||
tidelift: "npm/balanced-match"
|
|
||||||
patreon: juliangruber
|
|
||||||
@ -1,21 +0,0 @@
|
|||||||
(MIT)
|
|
||||||
|
|
||||||
Copyright (c) 2013 Julian Gruber <julian@juliangruber.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,97 +0,0 @@
|
|||||||
# balanced-match
|
|
||||||
|
|
||||||
Match balanced string pairs, like `{` and `}` or `<b>` and `</b>`. Supports regular expressions as well!
|
|
||||||
|
|
||||||
[](http://travis-ci.org/juliangruber/balanced-match)
|
|
||||||
[](https://www.npmjs.org/package/balanced-match)
|
|
||||||
|
|
||||||
[](https://ci.testling.com/juliangruber/balanced-match)
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
Get the first matching pair of braces:
|
|
||||||
|
|
||||||
```js
|
|
||||||
var balanced = require('balanced-match');
|
|
||||||
|
|
||||||
console.log(balanced('{', '}', 'pre{in{nested}}post'));
|
|
||||||
console.log(balanced('{', '}', 'pre{first}between{second}post'));
|
|
||||||
console.log(balanced(/\s+\{\s+/, /\s+\}\s+/, 'pre { in{nest} } post'));
|
|
||||||
```
|
|
||||||
|
|
||||||
The matches are:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ node example.js
|
|
||||||
{ start: 3, end: 14, pre: 'pre', body: 'in{nested}', post: 'post' }
|
|
||||||
{ start: 3,
|
|
||||||
end: 9,
|
|
||||||
pre: 'pre',
|
|
||||||
body: 'first',
|
|
||||||
post: 'between{second}post' }
|
|
||||||
{ start: 3, end: 17, pre: 'pre', body: 'in{nest}', post: 'post' }
|
|
||||||
```
|
|
||||||
|
|
||||||
## API
|
|
||||||
|
|
||||||
### var m = balanced(a, b, str)
|
|
||||||
|
|
||||||
For the first non-nested matching pair of `a` and `b` in `str`, return an
|
|
||||||
object with those keys:
|
|
||||||
|
|
||||||
* **start** the index of the first match of `a`
|
|
||||||
* **end** the index of the matching `b`
|
|
||||||
* **pre** the preamble, `a` and `b` not included
|
|
||||||
* **body** the match, `a` and `b` not included
|
|
||||||
* **post** the postscript, `a` and `b` not included
|
|
||||||
|
|
||||||
If there's no match, `undefined` will be returned.
|
|
||||||
|
|
||||||
If the `str` contains more `a` than `b` / there are unmatched pairs, the first match that was closed will be used. For example, `{{a}` will match `['{', 'a', '']` and `{a}}` will match `['', 'a', '}']`.
|
|
||||||
|
|
||||||
### var r = balanced.range(a, b, str)
|
|
||||||
|
|
||||||
For the first non-nested matching pair of `a` and `b` in `str`, return an
|
|
||||||
array with indexes: `[ <a index>, <b index> ]`.
|
|
||||||
|
|
||||||
If there's no match, `undefined` will be returned.
|
|
||||||
|
|
||||||
If the `str` contains more `a` than `b` / there are unmatched pairs, the first match that was closed will be used. For example, `{{a}` will match `[ 1, 3 ]` and `{a}}` will match `[0, 2]`.
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
With [npm](https://npmjs.org) do:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm install balanced-match
|
|
||||||
```
|
|
||||||
|
|
||||||
## Security contact information
|
|
||||||
|
|
||||||
To report a security vulnerability, please use the
|
|
||||||
[Tidelift security contact](https://tidelift.com/security).
|
|
||||||
Tidelift will coordinate the fix and disclosure.
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
(MIT)
|
|
||||||
|
|
||||||
Copyright (c) 2013 Julian Gruber <julian@juliangruber.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,62 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
module.exports = balanced;
|
|
||||||
function balanced(a, b, str) {
|
|
||||||
if (a instanceof RegExp) a = maybeMatch(a, str);
|
|
||||||
if (b instanceof RegExp) b = maybeMatch(b, str);
|
|
||||||
|
|
||||||
var r = range(a, b, str);
|
|
||||||
|
|
||||||
return r && {
|
|
||||||
start: r[0],
|
|
||||||
end: r[1],
|
|
||||||
pre: str.slice(0, r[0]),
|
|
||||||
body: str.slice(r[0] + a.length, r[1]),
|
|
||||||
post: str.slice(r[1] + b.length)
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
function maybeMatch(reg, str) {
|
|
||||||
var m = str.match(reg);
|
|
||||||
return m ? m[0] : null;
|
|
||||||
}
|
|
||||||
|
|
||||||
balanced.range = range;
|
|
||||||
function range(a, b, str) {
|
|
||||||
var begs, beg, left, right, result;
|
|
||||||
var ai = str.indexOf(a);
|
|
||||||
var bi = str.indexOf(b, ai + 1);
|
|
||||||
var i = ai;
|
|
||||||
|
|
||||||
if (ai >= 0 && bi > 0) {
|
|
||||||
if(a===b) {
|
|
||||||
return [ai, bi];
|
|
||||||
}
|
|
||||||
begs = [];
|
|
||||||
left = str.length;
|
|
||||||
|
|
||||||
while (i >= 0 && !result) {
|
|
||||||
if (i == ai) {
|
|
||||||
begs.push(i);
|
|
||||||
ai = str.indexOf(a, i + 1);
|
|
||||||
} else if (begs.length == 1) {
|
|
||||||
result = [ begs.pop(), bi ];
|
|
||||||
} else {
|
|
||||||
beg = begs.pop();
|
|
||||||
if (beg < left) {
|
|
||||||
left = beg;
|
|
||||||
right = bi;
|
|
||||||
}
|
|
||||||
|
|
||||||
bi = str.indexOf(b, i + 1);
|
|
||||||
}
|
|
||||||
|
|
||||||
i = ai < bi && ai >= 0 ? ai : bi;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (begs.length) {
|
|
||||||
result = [ left, right ];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return result;
|
|
||||||
}
|
|
||||||
@ -1,48 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "balanced-match",
|
|
||||||
"description": "Match balanced character pairs, like \"{\" and \"}\"",
|
|
||||||
"version": "1.0.2",
|
|
||||||
"repository": {
|
|
||||||
"type": "git",
|
|
||||||
"url": "git://github.com/juliangruber/balanced-match.git"
|
|
||||||
},
|
|
||||||
"homepage": "https://github.com/juliangruber/balanced-match",
|
|
||||||
"main": "index.js",
|
|
||||||
"scripts": {
|
|
||||||
"test": "tape test/test.js",
|
|
||||||
"bench": "matcha test/bench.js"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"matcha": "^0.7.0",
|
|
||||||
"tape": "^4.6.0"
|
|
||||||
},
|
|
||||||
"keywords": [
|
|
||||||
"match",
|
|
||||||
"regexp",
|
|
||||||
"test",
|
|
||||||
"balanced",
|
|
||||||
"parse"
|
|
||||||
],
|
|
||||||
"author": {
|
|
||||||
"name": "Julian Gruber",
|
|
||||||
"email": "mail@juliangruber.com",
|
|
||||||
"url": "http://juliangruber.com"
|
|
||||||
},
|
|
||||||
"license": "MIT",
|
|
||||||
"testling": {
|
|
||||||
"files": "test/*.js",
|
|
||||||
"browsers": [
|
|
||||||
"ie/8..latest",
|
|
||||||
"firefox/20..latest",
|
|
||||||
"firefox/nightly",
|
|
||||||
"chrome/25..latest",
|
|
||||||
"chrome/canary",
|
|
||||||
"opera/12..latest",
|
|
||||||
"opera/next",
|
|
||||||
"safari/5.1..latest",
|
|
||||||
"ipad/6.0..latest",
|
|
||||||
"iphone/6.0..latest",
|
|
||||||
"android-browser/4.2..latest"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,19 +0,0 @@
|
|||||||
root = true
|
|
||||||
|
|
||||||
[*]
|
|
||||||
indent_style = space
|
|
||||||
indent_size = 4
|
|
||||||
end_of_line = lf
|
|
||||||
charset = utf-8
|
|
||||||
trim_trailing_whitespace = true
|
|
||||||
insert_final_newline = true
|
|
||||||
|
|
||||||
[{package.json,*.yml}]
|
|
||||||
indent_style = space
|
|
||||||
indent_size = 2
|
|
||||||
|
|
||||||
[appveyor.yml]
|
|
||||||
end_of_line = crlf
|
|
||||||
|
|
||||||
[*.md]
|
|
||||||
trim_trailing_whitespace = false
|
|
||||||
@ -1,59 +0,0 @@
|
|||||||
name: ci
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
pull_request:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
os: [ubuntu-20.04, macos-11.0, windows-2019]
|
|
||||||
nodeVersion: [14, 16, 18, 20]
|
|
||||||
runs-on: ${{ matrix.os }}
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
- name: Use Node.js ${{ matrix.nodeVersion }}
|
|
||||||
uses: actions/setup-node@v3
|
|
||||||
with:
|
|
||||||
node-version: ${{ matrix.nodeVersion }}
|
|
||||||
- name: Test
|
|
||||||
run: npm test
|
|
||||||
- name: Package
|
|
||||||
if: startsWith(github.ref, 'refs/tags/') || startsWith(github.ref, 'refs/heads/master')
|
|
||||||
run: npx node-pre-gyp package
|
|
||||||
- name: Upload
|
|
||||||
uses: actions/upload-artifact@v3
|
|
||||||
if: matrix.nodeVersion == '14' && (startsWith(github.ref, 'refs/tags/') || startsWith(github.ref, 'refs/heads/master'))
|
|
||||||
with:
|
|
||||||
name: bcrypt-lib-${{ matrix.os }}-${{ matrix.nodeVersion }}
|
|
||||||
path: build/stage/**/bcrypt_lib*.tar.gz
|
|
||||||
|
|
||||||
build-alpine:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
nodeVersion: [14, 16, 18, 20]
|
|
||||||
container:
|
|
||||||
image: node:${{ matrix.nodeVersion }}-alpine
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
- name: Install dependencies
|
|
||||||
run: |
|
|
||||||
apk add make g++ python3
|
|
||||||
- name: Test
|
|
||||||
run: |
|
|
||||||
npm test --unsafe-perm
|
|
||||||
- name: Package
|
|
||||||
if: startsWith(github.ref, 'refs/tags/') || startsWith(github.ref, 'refs/heads/master')
|
|
||||||
run: npx node-pre-gyp package --unsafe-perm
|
|
||||||
- name: Upload
|
|
||||||
if: matrix.nodeVersion == '14' && (startsWith(github.ref, 'refs/tags/') || startsWith(github.ref, 'refs/heads/master'))
|
|
||||||
uses: actions/upload-artifact@v3
|
|
||||||
with:
|
|
||||||
name: bcrypt-lib-alpine-${{ matrix.nodeVersion }}
|
|
||||||
path: build/stage/**/bcrypt_lib*.tar.gz
|
|
||||||
@ -1,62 +0,0 @@
|
|||||||
language: node_js
|
|
||||||
|
|
||||||
services:
|
|
||||||
- docker
|
|
||||||
|
|
||||||
env:
|
|
||||||
- LINUX_CXX=g++-4.8
|
|
||||||
|
|
||||||
os:
|
|
||||||
- linux
|
|
||||||
- osx
|
|
||||||
|
|
||||||
arch:
|
|
||||||
- amd64
|
|
||||||
- arm64
|
|
||||||
|
|
||||||
node_js:
|
|
||||||
- '14'
|
|
||||||
- '16'
|
|
||||||
- '17'
|
|
||||||
- '18'
|
|
||||||
|
|
||||||
addons:
|
|
||||||
apt:
|
|
||||||
sources:
|
|
||||||
- ubuntu-toolchain-r-test
|
|
||||||
packages:
|
|
||||||
- g++-4.8
|
|
||||||
- bc
|
|
||||||
|
|
||||||
before_install:
|
|
||||||
- echo Building for Node $TRAVIS_NODE_VERSION
|
|
||||||
- if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then export CXX=$LINUX_CXX; $CXX --version;
|
|
||||||
fi;
|
|
||||||
- if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then c++ --version; fi;
|
|
||||||
- npm install -g npm@latest
|
|
||||||
|
|
||||||
install: true
|
|
||||||
|
|
||||||
script:
|
|
||||||
- npm test
|
|
||||||
- "./node_modules/.bin/node-pre-gyp configure"
|
|
||||||
- "./node_modules/.bin/node-pre-gyp build"
|
|
||||||
- "./node_modules/.bin/node-pre-gyp package"
|
|
||||||
- |
|
|
||||||
if [[ "$TRAVIS_OS_NAME" == "linux" ]]
|
|
||||||
then
|
|
||||||
docker image pull public.ecr.aws/docker/library/node:${TRAVIS_NODE_VERSION}-alpine
|
|
||||||
docker run -w /src --entrypoint /bin/sh -v`pwd`:/src "node:${TRAVIS_NODE_VERSION}-alpine" test_alpine.sh
|
|
||||||
fi
|
|
||||||
|
|
||||||
deploy:
|
|
||||||
provider: releases
|
|
||||||
skip_cleanup: true
|
|
||||||
api_key:
|
|
||||||
secure: j4gQ+m02izaw56EOd0gEStHAjCRfSCkohDWvpABiPzh1YPM9MvfEMSIvzzjV/0oMqi3Sy7eGyFv47EgQHZvouW0I8BIUzxuTCE5wP8z2SjABXCa/rz4WTppTc9d9ABq8JSdz80JxEwjmuwnYeMwWgOd7sT/VDiMxLYaXj0JWO7w=
|
|
||||||
file_glob: true
|
|
||||||
file: build/stage/kelektiv/node.bcrypt.js/releases/download/*/*
|
|
||||||
on:
|
|
||||||
node_js: '14'
|
|
||||||
repo: kelektiv/node.bcrypt.js
|
|
||||||
tags: true
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue