Skip to content

Commit 2b311bd

Browse files
committed
release: @-xun/[email protected] [skip ci]
## ✨ Features - **packages/run:** add `elideNodeDebuggerStringsFromStderr` option ([596a4ca][2]) ## 🪄 Fixes - **packages/run:** improve `runnerFactory` intellisense ([dd1e2c7][3]) ## ⚙️ Build System - **deps:** bump rejoinder from 1.2.4 to 1.2.5 ([e950bdc][4]) - **deps:** bump type-fest from 4.34.1 to 4.37.0 ([129df48][5]) [1]: https://github.com/Xunnamius/exec-utils/compare/@-xun/[email protected]...@-xun/[email protected] [2]: 596a4ca [3]: dd1e2c7 [4]: e950bdc [5]: 129df48
1 parent 49a6869 commit 2b311bd

14 files changed

+190
-98
lines changed

packages/run/CHANGELOG.md

+38-16
Original file line numberDiff line numberDiff line change
@@ -6,43 +6,65 @@ this project adheres to [Semantic Versioning][2].
66

77
<br />
88

9-
## @-xun/run[@1.0.0][3] (2025-02-16)
9+
## @-xun/run[@1.1.0][3] (2025-03-06)
1010

1111
### ✨ Features
1212

13-
- **packages/run:** greatly improve exported types and debug output ([6bc3c2f][4])
13+
- **packages/run:** add `elideNodeDebuggerStringsFromStderr` option ([596a4ca][4])
14+
15+
### 🪄 Fixes
16+
17+
- **packages/run:** improve `runnerFactory` intellisense ([dd1e2c7][5])
18+
19+
### ⚙️ Build System
20+
21+
- **deps:** bump rejoinder from 1.2.4 to 1.2.5 ([e950bdc][6])
22+
- **deps:** bump type-fest from 4.34.1 to 4.37.0 ([129df48][7])
23+
24+
<br />
25+
26+
## @-xun/run[@1.0.0][8] (2025-02-16)
27+
28+
### ✨ Features
29+
30+
- **packages/run:** greatly improve exported types and debug output ([6bc3c2f][9])
1431

1532
<br />
1633

17-
### 🏗️ Patch @-xun/run[@1.0.3][5] (2025-02-22)
34+
### 🏗️ Patch @-xun/run[@1.0.3][10] (2025-02-22)
1835

1936
#### 🪄 Fixes
2037

21-
- **packages/run:** ensure `runWithInheritedIo` inherits all io file descriptors ([3ca5d5a][6])
38+
- **packages/run:** ensure `runWithInheritedIo` inherits all io file descriptors ([3ca5d5a][11])
2239

2340
<br />
2441

25-
### 🏗️ Patch @-xun/run[@1.0.2][7] (2025-02-18)
42+
### 🏗️ Patch @-xun/run[@1.0.2][12] (2025-02-18)
2643

2744
#### 🪄 Fixes
2845

29-
- **packages/run:** account for generic parameters; simplify type logic ([0673591][8])
46+
- **packages/run:** account for generic parameters; simplify type logic ([0673591][13])
3047

3148
<br />
3249

33-
### 🏗️ Patch @-xun/run[@1.0.1][9] (2025-02-17)
50+
### 🏗️ Patch @-xun/run[@1.0.1][14] (2025-02-17)
3451

3552
#### 🪄 Fixes
3653

37-
- Improve types and intellisense, ensure functionality matches documentation ([99f80c9][10])
54+
- Improve types and intellisense, ensure functionality matches documentation ([99f80c9][15])
3855

3956
[1]: https://conventionalcommits.org
4057
[2]: https://semver.org
41-
[3]: https://github.com/Xunnamius/exec-utils/compare/6bc3c2f64e318fb45aac40a5534d0b575a57f170...@-xun/[email protected]
42-
[4]: https://github.com/Xunnamius/exec-utils/commit/6bc3c2f64e318fb45aac40a5534d0b575a57f170
43-
[5]: https://github.com/Xunnamius/exec-utils/compare/@-xun/[email protected]...@-xun/[email protected]
44-
[6]: https://github.com/Xunnamius/exec-utils/commit/3ca5d5a48edf233b2c3f06a5558c6dca408bd366
45-
[7]: https://github.com/Xunnamius/exec-utils/compare/@-xun/[email protected]...@-xun/[email protected]
46-
[8]: https://github.com/Xunnamius/exec-utils/commit/06735914ae278783fb4ee6a4cc1a3732191459ee
47-
[9]: https://github.com/Xunnamius/exec-utils/compare/@-xun/[email protected]...@-xun/[email protected]
48-
[10]: https://github.com/Xunnamius/exec-utils/commit/99f80c9423153055098aa3bf7b6f903f3ee1b65f
58+
[3]: https://github.com/Xunnamius/exec-utils/compare/@-xun/[email protected]...@-xun/[email protected]
59+
[4]: https://github.com/Xunnamius/exec-utils/commit/596a4ca63a2b17b0a8e1d7467f14581cfd100d5d
60+
[5]: https://github.com/Xunnamius/exec-utils/commit/dd1e2c7feb508649e5b5164f882176380432901f
61+
[6]: https://github.com/Xunnamius/exec-utils/commit/e950bdc88246d4df68cb4e148b36441b3b936f55
62+
[7]: https://github.com/Xunnamius/exec-utils/commit/129df486660f117039b2de4cd8ed17bd7f5a2f35
63+
[8]: https://github.com/Xunnamius/exec-utils/compare/6bc3c2f64e318fb45aac40a5534d0b575a57f170...@-xun/[email protected]
64+
[9]: https://github.com/Xunnamius/exec-utils/commit/6bc3c2f64e318fb45aac40a5534d0b575a57f170
65+
[10]: https://github.com/Xunnamius/exec-utils/compare/@-xun/[email protected]...@-xun/[email protected]
66+
[11]: https://github.com/Xunnamius/exec-utils/commit/3ca5d5a48edf233b2c3f06a5558c6dca408bd366
67+
[12]: https://github.com/Xunnamius/exec-utils/compare/@-xun/[email protected]...@-xun/[email protected]
68+
[13]: https://github.com/Xunnamius/exec-utils/commit/06735914ae278783fb4ee6a4cc1a3732191459ee
69+
[14]: https://github.com/Xunnamius/exec-utils/compare/@-xun/[email protected]...@-xun/[email protected]
70+
[15]: https://github.com/Xunnamius/exec-utils/commit/99f80c9423153055098aa3bf7b6f903f3ee1b65f

packages/run/docs/constant/variables/globalDebuggerNamespace.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@
88

99
> `const` **globalDebuggerNamespace**: `"xrun"` = `'xrun'`
1010
11-
Defined in: [packages/run/src/constant.ts:4](https://github.com/Xunnamius/exec-utils/blob/bf5e65a2582e7e8aeaba89dc9f922437cbff4809/packages/run/src/constant.ts#L4)
11+
Defined in: [packages/run/src/constant.ts:4](https://github.com/Xunnamius/exec-utils/blob/49a686926412eee8a176a3c8893c62abf78eaebf/packages/run/src/constant.ts#L4)
1212

1313
The project-wide namespace that appears in debugger output.

packages/run/docs/index/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,12 @@ Re-exports [RunIntermediateReturnType](../types/type-aliases/RunIntermediateRetu
3131

3232
***
3333

34+
### RunnerFactoryReturnType
35+
36+
Re-exports [RunnerFactoryReturnType](../types/type-aliases/RunnerFactoryReturnType.md)
37+
38+
***
39+
3440
### RunOptions
3541

3642
Re-exports [RunOptions](../types/type-aliases/RunOptions.md)

packages/run/docs/index/functions/run.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
> **run**(`file`, `args`?, `options`?): `Promise`\<\{ `all`: `undefined`; `cause`: `unknown`; `code`: `undefined` \| `string`; `command`: `string`; `cwd`: `string`; `durationMs`: `number`; `escapedCommand`: `string`; `exitCode`: `number`; `failed`: `boolean`; `ipcOutput`: \[\] \| (`null` \| `string` \| `number` \| `boolean` \| `object` \| readonly `JsonMessage`[] \| \{\})[]; `isCanceled`: `boolean`; `isForcefullyTerminated`: `boolean`; `isGracefullyCanceled`: `boolean`; `isMaxBuffer`: `boolean`; `isTerminated`: `boolean`; `message`: `undefined` \| `string`; `name`: `undefined` \| `string`; `originalMessage`: `undefined` \| `string`; `pipedFrom`: `Result`\<`Options`\>[]; `shortMessage`: `undefined` \| `string`; `signal`: `Signals`; `signalDescription`: `string`; `stack`: `undefined` \| `string`; `stderr`: `string`; `stdio`: `MapResultStdio`\<readonly \[`StdinOptionCommon`\<`false`, `false`\>, `StdoutStderrOptionCommon`\<`false`, `false`\>, `StdoutStderrOptionCommon`\<`false`, `false`\>, `StdioExtraOptionCommon`\<`false`\>\] \| readonly \[`undefined`, `undefined`, `undefined`\] \| readonly \[`"pipe"`, `"pipe"`, `"pipe"`\] \| readonly \[`"inherit"`, `"inherit"`, `"inherit"`\] \| readonly \[`"ignore"`, `"ignore"`, `"ignore"`\] \| readonly \[`"overlapped"`, `"overlapped"`, `"overlapped"`\]\>; `stdout`: `string`; `timedOut`: `boolean`; \}\>
1212

13-
Defined in: [packages/run/src/index.ts:31](https://github.com/Xunnamius/exec-utils/blob/bf5e65a2582e7e8aeaba89dc9f922437cbff4809/packages/run/src/index.ts#L31)
13+
Defined in: [packages/run/src/index.ts:40](https://github.com/Xunnamius/exec-utils/blob/49a686926412eee8a176a3c8893c62abf78eaebf/packages/run/src/index.ts#L40)
1414

1515
Runs (executes) `file` with the given `args` with respect to the given
1616
`options`.
@@ -23,6 +23,9 @@ Note that, by default, this function:
2323
2. Coerces output to a string. Set `coerceOutputToString: false` (or `lines:
2424
true`) to override this.
2525

26+
3. Elides Node.js debugger strings. Set `elideNodeDebuggerStringsFromStderr:
27+
false` to override this.
28+
2629
### Parameters
2730

2831
#### file
@@ -43,9 +46,9 @@ Note that, by default, this function:
4346

4447
## Call Signature
4548

46-
> **run**\<`OptionsType`\>(`file`, `args`?, `options`?): `Promise`\<\{ \[KeyType in string \| number \| symbol\]: (\[\{ \[KeyType in string \| number \| symbol\]: (\{\} & PickIndexSignature\<OptionsType\> & \{ \[Key in (keyof Options) \| "useIntermediate" \| "coerceOutputToString" as Key extends keyof (...) ? never : Key\]: OmitIndexSignature\<(...)\>\[Key\] \} & OmitIndexSignature\<OptionsType\>)\[KeyType\] \}\] extends \[ReifiedOptionsType\] ? ReifiedOptionsType extends \{ lines: true \} ? \{ \[KeyType in string \| number \| symbol\]: (\{\} & PickIndexSignature\<\{ stderr: ...; stdout: ... \} & ((...) extends (...) ? (...) : (...))\> & \{ \[Key in "stdout" \| "stderr" \| "all" \| "cwd" \| "stdio" \| "name" \| "message" \| "stack" \| "cause" \| "shortMessage" \| "originalMessage" \| "code" \| "ipcOutput" \| "pipedFrom" \| "command" \| "escapedCommand" \| "durationMs" \| "failed" \| "timedOut" \| "isCanceled" \| "isGracefullyCanceled" \| "isMaxBuffer" \| "isTerminated" \| "isForcefullyTerminated" \| "exitCode" \| "signal" \| "signalDescription" as Key extends keyof (...) ? never : Key\]: OmitIndexSignature\<(...)\>\[Key\] \} & OmitIndexSignature\<\{ stderr: ...; stdout: ... \} & ((...) extends (...) ? (...) : (...))\>)\[KeyType\] \} : ReifiedOptionsType extends \{ coerceOutputToString: true \} ? \{ \[KeyType in string \| number \| symbol\]: (\{\} & PickIndexSignature\<(...) & (...)\> & \{ \[Key in (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) as (...) extends (...) ? (...) : (...)\]: (...)\[(...)\] \} & OmitIndexSignature\<(...) & (...)\>)\[KeyType\] \} : Result\<ReifiedOptionsType\> : never)\[KeyType\] \}\>
49+
> **run**\<`OptionsType`\>(`file`, `args`?, `options`?): `Promise`\<\{ \[KeyType in string \| number \| symbol\]: (\[\{ \[KeyType in string \| number \| symbol\]: (\{\} & PickIndexSignature\<OptionsType\> & \{ \[Key in (keyof Options) \| "useIntermediate" \| "coerceOutputToString" \| "elideNodeDebuggerStringsFromStderr" as Key extends keyof (...) ? never : Key\]: OmitIndexSignature\<(...)\>\[Key\] \} & OmitIndexSignature\<OptionsType\>)\[KeyType\] \}\] extends \[ReifiedOptionsType\] ? ReifiedOptionsType extends \{ lines: true \} ? \{ \[KeyType in string \| number \| symbol\]: (\{\} & PickIndexSignature\<\{ stderr: ...; stdout: ... \} & ((...) extends (...) ? (...) : (...))\> & \{ \[Key in "stdout" \| "stderr" \| "all" \| "cwd" \| "stdio" \| "name" \| "message" \| "stack" \| "cause" \| "shortMessage" \| "originalMessage" \| "code" \| "ipcOutput" \| "pipedFrom" \| "command" \| "escapedCommand" \| "durationMs" \| "failed" \| "timedOut" \| "isCanceled" \| "isGracefullyCanceled" \| "isMaxBuffer" \| "isTerminated" \| "isForcefullyTerminated" \| "exitCode" \| "signal" \| "signalDescription" as Key extends keyof (...) ? never : Key\]: OmitIndexSignature\<(...)\>\[Key\] \} & OmitIndexSignature\<\{ stderr: ...; stdout: ... \} & ((...) extends (...) ? (...) : (...))\>)\[KeyType\] \} : ReifiedOptionsType extends \{ coerceOutputToString: true \} ? \{ \[KeyType in string \| number \| symbol\]: (\{\} & PickIndexSignature\<(...) & (...)\> & \{ \[Key in (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) as (...) extends (...) ? (...) : (...)\]: (...)\[(...)\] \} & OmitIndexSignature\<(...) & (...)\>)\[KeyType\] \} : Result\<ReifiedOptionsType\> : never)\[KeyType\] \}\>
4750

48-
Defined in: [packages/run/src/index.ts:36](https://github.com/Xunnamius/exec-utils/blob/bf5e65a2582e7e8aeaba89dc9f922437cbff4809/packages/run/src/index.ts#L36)
51+
Defined in: [packages/run/src/index.ts:45](https://github.com/Xunnamius/exec-utils/blob/49a686926412eee8a176a3c8893c62abf78eaebf/packages/run/src/index.ts#L45)
4952

5053
Runs (executes) `file` with the given `args` with respect to the given
5154
`options`.
@@ -58,6 +61,9 @@ Note that, by default, this function:
5861
2. Coerces output to a string. Set `coerceOutputToString: false` (or `lines:
5962
true`) to override this.
6063

64+
3. Elides Node.js debugger strings. Set `elideNodeDebuggerStringsFromStderr:
65+
false` to override this.
66+
6167
### Type Parameters
6268

6369
**OptionsType** *extends* [`RunOptions`](../../types/type-aliases/RunOptions.md)
@@ -78,4 +84,4 @@ Note that, by default, this function:
7884

7985
### Returns
8086

81-
`Promise`\<\{ \[KeyType in string \| number \| symbol\]: (\[\{ \[KeyType in string \| number \| symbol\]: (\{\} & PickIndexSignature\<OptionsType\> & \{ \[Key in (keyof Options) \| "useIntermediate" \| "coerceOutputToString" as Key extends keyof (...) ? never : Key\]: OmitIndexSignature\<(...)\>\[Key\] \} & OmitIndexSignature\<OptionsType\>)\[KeyType\] \}\] extends \[ReifiedOptionsType\] ? ReifiedOptionsType extends \{ lines: true \} ? \{ \[KeyType in string \| number \| symbol\]: (\{\} & PickIndexSignature\<\{ stderr: ...; stdout: ... \} & ((...) extends (...) ? (...) : (...))\> & \{ \[Key in "stdout" \| "stderr" \| "all" \| "cwd" \| "stdio" \| "name" \| "message" \| "stack" \| "cause" \| "shortMessage" \| "originalMessage" \| "code" \| "ipcOutput" \| "pipedFrom" \| "command" \| "escapedCommand" \| "durationMs" \| "failed" \| "timedOut" \| "isCanceled" \| "isGracefullyCanceled" \| "isMaxBuffer" \| "isTerminated" \| "isForcefullyTerminated" \| "exitCode" \| "signal" \| "signalDescription" as Key extends keyof (...) ? never : Key\]: OmitIndexSignature\<(...)\>\[Key\] \} & OmitIndexSignature\<\{ stderr: ...; stdout: ... \} & ((...) extends (...) ? (...) : (...))\>)\[KeyType\] \} : ReifiedOptionsType extends \{ coerceOutputToString: true \} ? \{ \[KeyType in string \| number \| symbol\]: (\{\} & PickIndexSignature\<(...) & (...)\> & \{ \[Key in (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) as (...) extends (...) ? (...) : (...)\]: (...)\[(...)\] \} & OmitIndexSignature\<(...) & (...)\>)\[KeyType\] \} : Result\<ReifiedOptionsType\> : never)\[KeyType\] \}\>
87+
`Promise`\<\{ \[KeyType in string \| number \| symbol\]: (\[\{ \[KeyType in string \| number \| symbol\]: (\{\} & PickIndexSignature\<OptionsType\> & \{ \[Key in (keyof Options) \| "useIntermediate" \| "coerceOutputToString" \| "elideNodeDebuggerStringsFromStderr" as Key extends keyof (...) ? never : Key\]: OmitIndexSignature\<(...)\>\[Key\] \} & OmitIndexSignature\<OptionsType\>)\[KeyType\] \}\] extends \[ReifiedOptionsType\] ? ReifiedOptionsType extends \{ lines: true \} ? \{ \[KeyType in string \| number \| symbol\]: (\{\} & PickIndexSignature\<\{ stderr: ...; stdout: ... \} & ((...) extends (...) ? (...) : (...))\> & \{ \[Key in "stdout" \| "stderr" \| "all" \| "cwd" \| "stdio" \| "name" \| "message" \| "stack" \| "cause" \| "shortMessage" \| "originalMessage" \| "code" \| "ipcOutput" \| "pipedFrom" \| "command" \| "escapedCommand" \| "durationMs" \| "failed" \| "timedOut" \| "isCanceled" \| "isGracefullyCanceled" \| "isMaxBuffer" \| "isTerminated" \| "isForcefullyTerminated" \| "exitCode" \| "signal" \| "signalDescription" as Key extends keyof (...) ? never : Key\]: OmitIndexSignature\<(...)\>\[Key\] \} & OmitIndexSignature\<\{ stderr: ...; stdout: ... \} & ((...) extends (...) ? (...) : (...))\>)\[KeyType\] \} : ReifiedOptionsType extends \{ coerceOutputToString: true \} ? \{ \[KeyType in string \| number \| symbol\]: (\{\} & PickIndexSignature\<(...) & (...)\> & \{ \[Key in (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) \| (...) as (...) extends (...) ? (...) : (...)\]: (...)\[(...)\] \} & OmitIndexSignature\<(...) & (...)\>)\[KeyType\] \} : Result\<ReifiedOptionsType\> : never)\[KeyType\] \}\>

0 commit comments

Comments
 (0)