@tapjs/spawn - npm Package Compare versions

Comparing version 0.0.0-15 to 0.0.0-16

dist/cjs/index.d.ts

 /// <reference types="node" resolution-mode="require"/>
 import { BaseOpts, PromiseWithSubtest, Spawn, TapPlugin, TestBase } from '@tapjs/core';
 import { StdioOptions } from 'child_process';
+/**
+ * Options for `t.spawn()`
+ *
+ * All of the normal Base and Extra options are also allowed.
+ */
 export interface SpawnOpts extends BaseOpts {
+    /**
+     * the current working directory of the subprocess
+     */
     cwd?: string;
+    /**
+     * the command to run (set by first argument to t.spawn)
+     *
+     * @internal
+     */
     command?: string;
+    /**
+     * arguments to subprocess (set by second argument to t.spawn)
+     *
+     * @internal
+     */
     args?: string[];
+    /**
+     * ChildProcess `stdio` option.
+     * Standard output is always set to `'pipe'`, because that's how it
+     * communicates test results, and file descriptor 3 is set to an IPC
+     * channel for sending timeout signals.
+     */
     stdio?: StdioOptions;
+    /**
+     * Environment variables for the subprocess
+     * Defaults to `process.env`
+     */
     env?: {
         [k: string]: string;
     } | typeof process.env;
+    /**
+     * Set on exit. The exit code of the process, or null if terminated
+     * with a signal.
+     *
+     * @internal
+     */
     exitCode?: number | null;
+    /**
+     * Set on exit. Terminating signal, or null of not terminated with a
+     * signal.
+     *
+     * @internal
+     */
     signal?: string | null;
@@ -14,0 +54,0 @@ }

dist/mjs/index.d.ts

 /// <reference types="node" resolution-mode="require"/>
 import { BaseOpts, PromiseWithSubtest, Spawn, TapPlugin, TestBase } from '@tapjs/core';
 import { StdioOptions } from 'child_process';
+/**
+ * Options for `t.spawn()`
+ *
+ * All of the normal Base and Extra options are also allowed.
+ */
 export interface SpawnOpts extends BaseOpts {
+    /**
+     * the current working directory of the subprocess
+     */
     cwd?: string;
+    /**
+     * the command to run (set by first argument to t.spawn)
+     *
+     * @internal
+     */
     command?: string;
+    /**
+     * arguments to subprocess (set by second argument to t.spawn)
+     *
+     * @internal
+     */
     args?: string[];
+    /**
+     * ChildProcess `stdio` option.
+     * Standard output is always set to `'pipe'`, because that's how it
+     * communicates test results, and file descriptor 3 is set to an IPC
+     * channel for sending timeout signals.
+     */
     stdio?: StdioOptions;
+    /**
+     * Environment variables for the subprocess
+     * Defaults to `process.env`
+     */
     env?: {
         [k: string]: string;
     } | typeof process.env;
+    /**
+     * Set on exit. The exit code of the process, or null if terminated
+     * with a signal.
+     *
+     * @internal
+     */
     exitCode?: number | null;
+    /**
+     * Set on exit. Terminating signal, or null of not terminated with a
+     * signal.
+     *
+     * @internal
+     */
     signal?: string | null;
@@ -14,0 +54,0 @@ }

package.json

 {
   "name": "@tapjs/spawn",
-  "version": "0.0.0-15",
+  "version": "0.0.0-16",
   "description": "a built-in tap extension for t.spawn()",
@@ -46,6 +46,6 @@ "type": "module",
   "peerDependencies": {
-    "@tapjs/core": "0.0.0-15"
+    "@tapjs/core": "0.0.0-16"
   },
   "engines": {
-    "node": "^14.17.0 || ^16.13.0 || >=18.0.0"
+    "node": ">=16"
   },
@@ -52,0 +52,0 @@ "repository": {

README.md

 # `@tapjs/spawn`
 
-A default tap plugin providing `t.spawn()`
+A default tap plugin providing `t.spawn()`.
+
+## USAGE
+
+This plugin is installed with tap by default. If you had
+previously removed it, you can `tap plugin add @tapjs/spawn` to
+bring it back.
+
+### Interface `SpawnOpts`
+
+Options for `t.spawn()`
+
+All of the normal Base and Extra options are also allowed.
+
+- `cwd` - string, the current working directory of the subprocess
+- `env` - Environment variables for the subprocess. Defaults to
+  `process.env`
+- `stdio` - ChildProcess `stdio` option. Standard output is
+  always set to `'pipe'`, because that's how it communicates test
+  results, and file descriptor 3 is set to an IPC channel for
+  sending timeout signals.
+- `command` (internal) - the command to run (set by first
+  argument to t.spawn)
+- `args` (internal) - arguments to subprocess (set by second
+  argument to t.spawn)
+- `exitCode` (internal) - Set on exit. The exit code of the
+  process, or null if terminated with a signal.
+- `signal` (internal) - Set on exit. Terminating signal, or null
+  of not terminated with a signal.
+
+### `t.spawn(cmd, [args], [options], [name]): PromiseWithSpawn`
+
+Arguments:
+
+- `cmd` `string` - The command to run
+- `args` (optional) `string | string[]` - Arguments to pass to
+  the command.
+- `options` (optional) `SpawnOpts` object
+
+Spawns a process when the test starts, parsing its standard
+output as a TAP stream.
+
+This is how the tap CLI runs test programs.
+
+Returns a Promise that resolves when the test is complete. The
+`subtest` member on the Promise is a
+[`Spawn`](https://tapjs.github.io/tapjs/classes/_tapjs_core.spawn.Spawn.html)
+instance.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

20650

increased by37.1%

Lines of code

199

increased by67.23%

Number of lines in readme file

51

increased by1175%

No dependency changes