Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
BREAKING CHANGE: The existing banner is now emitted using `proc-log` instead of `console.log`. It is always emitted. Consuming libraries can decide under which situations to show the banner.
- Loading branch information
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -57,8 +57,6 @@ runScript({ | |
| // print the package id and script, and the command to be run, like: | ||
| // > [email protected] postinstall | ||
| // > make all-the-things | ||
| }) | ||
| .then(({ code, signal, stdout, stderr, pkgid, path, event, script }) => { | ||
| // do something with the results | ||
|
|
@@ -99,6 +97,11 @@ terminal, then it is up to the user to end it, of course. | |
| - `event` Lifecycle event being run | ||
| - `script` Command being run | ||
|
|
||
| If stdio is `inherit` this package will emit a banner with the package | ||
| name and version, event name, and script command to be run, and send it | ||
| to [`proc-log.output.standard`](https://npm.im/proc-log). Consuming | ||
| libraries can decide whether or not to display this. | ||
|
|
||
| ### Options | ||
|
|
||
| - `path` Required. The path to the package having its script run. | ||
|
|
@@ -124,10 +127,6 @@ terminal, then it is up to the user to end it, of course. | |
| - `stdioString` Optional, passed directly to `@npmcli/promise-spawn` which | ||
| defaults it to `true`. Return string values for `stderr` and `stdout` rather | ||
| than Buffers. | ||
|
|
||
| Note that this does _not_ run pre-event and post-event scripts. The | ||
| caller has to manage that process themselves. | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,18 +6,19 @@ const isWindows = process.platform === 'win32' | |
| const emptyDir = t.testdir({}) | ||
|
|
||
| const pkill = process.kill | ||
|
|
||
| const output = [] | ||
| const appendOutput = (level, ...args) => { | ||
| if (level === 'standard') { | ||
| output.push([...args]) | ||
| } | ||
| } | ||
| process.on('output', appendOutput) | ||
| t.afterEach(() => output.length = 0) | ||
| t.teardown(() => process.removeListener('output', appendOutput)) | ||
|
|
||
| t.test('run-script-pkg', async t => { | ||
| await t.test('stdio inherit no args and a pkgid', async t => { | ||
| spawk.spawn('sh', a => a.includes('bar\nbaz\n')) | ||
| await runScript({ | ||
| event: 'foo', | ||
|
|
@@ -33,34 +34,11 @@ t.test('run-script-pkg', async t => { | |
| scripts: {}, | ||
| }, | ||
| }) | ||
| t.strictSame(output, [['\n> [email protected] foo\n> bar\n> baz\n']]) | ||
| t.ok(spawk.done()) | ||
| }) | ||
|
|
||
| await t.test('stdio inherit args and no pkgid', async t => { | ||
| spawk.spawn('sh', a => a.includes('bar baz buzz')) | ||
| await runScript({ | ||
| event: 'foo', | ||
|
|
@@ -76,12 +54,11 @@ t.test('run-script-pkg', async t => { | |
| scripts: {}, | ||
| }, | ||
| }) | ||
| t.strictSame(output, [['\n> foo\n> bar baz buzz\n']]) | ||
| t.ok(spawk.done()) | ||
| }) | ||
|
|
||
| await t.test('pkg has foo script, with stdio pipe', async t => { | ||
| spawk.spawn('sh', a => a.includes('bar')) | ||
| await runScript({ | ||
| event: 'foo', | ||
|
|
@@ -98,12 +75,11 @@ t.test('run-script-pkg', async t => { | |
| }, | ||
| }, | ||
| }) | ||
| t.strictSame(output, []) | ||
| t.ok(spawk.done()) | ||
| }) | ||
|
|
||
| await t.test('pkg has foo script, with stdio pipe and args', async t => { | ||
| spawk.spawn('sh', a => a.includes('bar a b c')) | ||
| await runScript({ | ||
| event: 'foo', | ||
|
|
@@ -122,16 +98,15 @@ t.test('run-script-pkg', async t => { | |
| args: ['a', 'b', 'c'], | ||
| binPaths: false, | ||
| }) | ||
| t.strictSame(output, []) | ||
| t.ok(spawk.done()) | ||
| }) | ||
|
|
||
| await t.test('pkg has no install or preinstall script, node-gyp files present, stdio pipe', async t => { | ||
| const testdir = t.testdir({ | ||
| 'binding.gyp': 'exists', | ||
| }) | ||
|
|
||
| spawk.spawn('sh', a => a.includes('node-gyp rebuild')) | ||
| await runScript({ | ||
| event: 'install', | ||
|
|
@@ -146,11 +121,11 @@ t.test('run-script-pkg', async t => { | |
| scripts: {}, | ||
| }, | ||
| }) | ||
| t.strictSame(output, []) | ||
| t.ok(spawk.done()) | ||
| }) | ||
|
|
||
| t.test('pkg has no install or preinstall script, but gypfile:false, stdio pipe', async t => { | ||
| const testdir = t.testdir({ | ||
| 'binding.gyp': 'exists', | ||
| }) | ||
|
|
@@ -170,6 +145,7 @@ t.test('run-script-pkg', async t => { | |
| }, | ||
| }, | ||
| }) | ||
| t.strictSame(output, []) | ||
| t.strictSame(res, { code: 0, signal: null }) | ||
| }) | ||
|
|
||
|
|
@@ -190,7 +166,7 @@ t.test('run-script-pkg', async t => { | |
| t.ok(interceptor.calledWith.stdio[0].writableEnded, 'stdin was ended properly') | ||
| }) | ||
|
|
||
| await t.test('kill process when foreground process ends with signal, stdio inherit', async t => { | ||
| t.teardown(() => { | ||
| process.kill = pkill | ||
| }) | ||
|
|
@@ -219,14 +195,15 @@ t.test('run-script-pkg', async t => { | |
| }, | ||
| }, | ||
| })) | ||
| t.strictSame(output, [['\n> [email protected] sleep\n> sleep 1000000\n']]) | ||
| t.ok(spawk.done()) | ||
| if (!isWindows) { | ||
| t.equal(signal, 'SIGFOO', 'process.kill got expected signal') | ||
| t.equal(pid, process.pid, 'process.kill got expected pid') | ||
| } | ||
| }) | ||
|
|
||
| await t.test('kill process when foreground process ends with signal, stdio inherit', async t => { | ||
| t.teardown(() => { | ||
| process.kill = pkill | ||
| }) | ||
|
|
@@ -255,14 +232,15 @@ t.test('run-script-pkg', async t => { | |
| }, | ||
| }, | ||
| })) | ||
| t.strictSame(output, [['\n> [email protected] sleep\n> sleep 1000000\n']]) | ||
| t.ok(spawk.done()) | ||
| if (!isWindows) { | ||
| t.equal(signal, 'SIGFOO', 'process.kill got expected signal') | ||
| t.equal(pid, process.pid, 'process.kill got expected pid') | ||
| } | ||
| }) | ||
|
|
||
| t.test('rejects if process.kill fails to end process, stdio inherit', async t => { | ||
| t.teardown(() => { | ||
| process.kill = pkill | ||
| }) | ||
|
|
@@ -290,6 +268,7 @@ t.test('run-script-pkg', async t => { | |
| }, | ||
| }, | ||
| })) | ||
| t.strictSame(output, [['\n> [email protected] sleep\n> sleep 1000000\n']]) | ||
| t.ok(spawk.done()) | ||
| if (!isWindows) { | ||
| t.equal(signal, 'SIGFOO', 'process.kill got expected signal') | ||
|
|
@@ -314,6 +293,7 @@ t.test('run-script-pkg', async t => { | |
| }, | ||
| }, | ||
| })) | ||
| t.strictSame(output, []) | ||
| t.ok(spawk.done()) | ||
| }) | ||
| }) | ||
