Installations
npm install demurgos-foreground-childDeveloper Guide
Typescript
No
Module System
CommonJS
Min. Node Version
>=6.0.0
Node Version
13.7.0
NPM Version
6.13.6
Score
71.6
Supply Chain
86.7
Quality
75.2
Maintenance
100
Vulnerability
100
License
Releases
Unable to fetch releases
Contributors
Unable to fetch Contributors
Languages
TypeScript (83.37%)
JavaScript (15.81%)
Shell (0.82%)
Developer
Download Statistics
Total Downloads
8,472
Last Day
1
Last Week
8
Last Month
61
Last Year
885
GitHub Statistics
40 Stars
101 Commits
20 Forks
4 Watching
4 Branches
9 Contributors
Bundle Size
27.38 kB
Minified
8.71 kB
Minified + Gzipped
Maintainers
Package Meta Information
Latest Version
1.6.0-beta.2
Package Id
demurgos-foreground-child@1.6.0-beta.2
Unpacked Size
42.36 kB
Size
11.35 kB
File Count
8
NPM Version
6.13.6
Node Version
13.7.0
Total Downloads
Cumulative downloads
Total Downloads
8,472
Last day
-83.3%
1
Compared to previous day
Last week
-63.6%
8
Compared to previous week
Last month
-14.1%
61
Compared to previous month
Last year
-6.3%
885
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
3
Dev Dependencies
4
foreground-child
Run a child as if it's the foreground process. Give it stdio.
Mostly this module is here to support some use cases around wrapping child processes for test coverage and such.
USAGE
1const fg = require('foreground-child') 2 3// cats out this file 4const {child, close} = fg('cat', [__filename]) 5 6// At this point, it's best to just do nothing else. 7// return or whatever. 8// If the child gets a signal, or just exits, then this 9// parent process will exit in the same way. 10 11// Close is a promise resolved when the child is closed. 12// You can use it to inspected its exit code and exit the parent process. 13close.then((close) => { 14 // You can use this handler to perform an action before exiting the 15 // foreground child. 16 console.log(close.code); 17 console.log(close.status); 18 close(); // Kills the parent process using the result of the child process. 19}); 20
Caveats
The "normal" standard IO file descriptors (0, 1, and 2 for stdin, stdout, and stderr respectively) are shared with the child process. Additionally, if there is an IPC channel set up in the parent, then messages are proxied to the child on file descriptor 3.
However, in Node, it's possible to also map arbitrary file descriptors into a child process. In these cases, foreground-child will not map the file descriptors into the child. If file descriptors 0, 1, or 2 are used for the IPC channel, then strange behavior may happen (like printing IPC messages to stderr, for example).
Note that a SIGKILL will always kill the parent process, and never the child process, because SIGKILL cannot be caught or proxied. The only way to do this would be if Node provided a way to truly exec a process as the new foreground program in the same process space, without forking a separate child process.
API
The canonical documentation is in the source code. See index.ts.
fg(file, args): Original APIfg.compat: Alias forfg.fg.spawn(file, args, options): New API, based on Node'scp.spawn.fg.proxy(parent, child): Forward IO, IPC and signals from parent to child.
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: ISC License: LICENSE:0
Reason
3 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Reason
Found 5/27 approved changesets -- score normalized to 1
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/ci.yml:1
- Warn: no topLevel permission defined: .github/workflows/isaacs-makework.yml:1
- Info: topLevel 'contents' permission set to 'read': .github/workflows/typedoc.yml:14
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/tapjs/foreground-child/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/tapjs/foreground-child/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/isaacs-makework.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/tapjs/foreground-child/isaacs-makework.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/isaacs-makework.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/tapjs/foreground-child/isaacs-makework.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typedoc.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/tapjs/foreground-child/typedoc.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typedoc.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/tapjs/foreground-child/typedoc.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typedoc.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/tapjs/foreground-child/typedoc.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typedoc.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/tapjs/foreground-child/typedoc.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typedoc.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/tapjs/foreground-child/typedoc.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/typedoc.yml:39
- Info: 0 out of 9 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 npmCommand dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 9 are checked with a SAST tool
Score
3.2
/10
Last Scanned on 2025-01-27
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More