@lowlighter/run 1.0.3 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -0
- package/command.mjs +75 -18
- package/command.ts +74 -46
- package/command_test.ts +1 -1
- package/deno.jsonc +3 -3
- package/deno.lock +20 -3
- package/mod.mjs +75 -18
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,6 +9,15 @@
|
|
|
9
9
|
> [!WARNING]
|
|
10
10
|
> Deno exclusive!
|
|
11
11
|
|
|
12
|
+
## ✨ Features
|
|
13
|
+
|
|
14
|
+
- Supports `stdin` interactivity through callbacks.
|
|
15
|
+
- Make it possible to monitor `stdout` and `stderr` content and react accordingly.
|
|
16
|
+
- Auto-detects os and can automatically append an extension when running on Windows.
|
|
17
|
+
- Supports both `sync` and `async` modes in a single function.
|
|
18
|
+
- Optionally decide to throw an error when the process exits with a non-zero code.
|
|
19
|
+
- Generates a `stdio` history that contains timestamped entries with configurable buffering
|
|
20
|
+
|
|
12
21
|
## 📜 Licenses
|
|
13
22
|
|
|
14
23
|
```plaintext
|
package/command.mjs
CHANGED
|
@@ -1,33 +1,90 @@
|
|
|
1
|
-
var e=class e{constructor({level:t,format:n,output:
|
|
1
|
+
var e=class e{constructor({level:t,format:n,output:r,tags:o,...i}={}){"granted"===globalThis.Deno?.permissions.querySync?.({name:"env",variable:"LOG_LEVEL"}).state&&(t??=globalThis.Deno?.env.get("LOG_LEVEL")),this.#e=r||null===r?r:console,this.#t=e.level.log,this.#n=e.format.text,this.#r={date:!1,time:!1,delta:!0,caller:{file:!1,name:!1,line:!1,fileformat:null}},this.level(t).format(n).options(i),this.tags=o??{}}#e;#r;options(e){if(!e)return structuredClone(this.#r);if("date"in e&&(this.#r.date=e.date),"time"in e&&(this.#r.time=e.time),"delta"in e&&(this.#r.delta=e.delta),"caller"in e)switch(!0){case!0===e.caller:this.#r.caller={file:!0,name:!0,line:!0,fileformat:this.#r.caller.fileformat};break;case!1===e.caller:this.#r.caller={file:!1,name:!1,line:!1,fileformat:this.#r.caller.fileformat};break;case"object"==typeof e.caller:"file"in e.caller&&(this.#r.caller.file=e.caller.file),"name"in e.caller&&(this.#r.caller.name=e.caller.name),"line"in e.caller&&(this.#r.caller.line=e.caller.line),"fileformat"in e.caller&&void 0!==e.caller.fileformat&&(this.#r.caller.fileformat=e.caller.fileformat)}return this}#t;level(t){return arguments.length?(Number.isNaN(Number.parseInt(`${t}`))||(t=Number.parseInt(`${t}`)),"string"==typeof t&&t in e.level&&(t=e.level[t]),"number"==typeof t&&(this.#t=!Number.isNaN(t)&&t>=0?t:-1),this):this.#t>=0?this.#t:NaN}static level=Object.freeze({disabled:NaN,error:0,warn:1,info:2,ok:2,log:3,debug:4,wdebug:4,trace:5,probe:NaN,always:1/0});error(...t){return this.#t>=e.level.error&&this.#e?.error(...this.#n(this,{level:"error",content:t,options:this.#r})),this}warn(...t){return this.#t>=e.level.warn&&this.#e?.warn(...this.#n(this,{level:"warn",content:t,options:this.#r})),this}info(...t){return this.#t>=e.level.info&&this.#e?.info(...this.#n(this,{level:"info",content:t,options:this.#r})),this}ok(...t){return this.#t>=e.level.info&&this.#e?.info(...this.#n(this,{level:"ok",content:t,options:this.#r})),this}log(...t){return this.#t>=e.level.log&&this.#e?.log(...this.#n(this,{level:"log",content:t,options:this.#r})),this}debug(...t){return this.#t>=e.level.debug&&this.#e?.debug(...this.#n(this,{level:"debug",content:t,options:this.#r})),this}wdebug(...t){return this.#t>=e.level.debug&&this.#e?.debug(...this.#n(this,{level:"wdebug",content:t,options:this.#r})),this}trace(...t){return this.#t>=e.level.trace&&this.#e?.debug(...this.#n(this,{level:"trace",content:t,options:this.#r})),this}probe(...e){return this.#e?.debug(...this.#n(this,{level:"probe",content:e,options:this.#r})),this}tags;with(t={}){return new e({level:this.#t,format:this.#n,output:this.#e,...this.#r,tags:{...this.tags,...t}})}#o(e=3){const t=Error,n=t.prepareStackTrace;t.prepareStackTrace=(e,t)=>t;const{stack:r}=new Error;t.prepareStackTrace=n;return r.map((e=>({file:e.getFileName(),name:e.getFunctionName(),line:e.getLineNumber(),column:e.getColumnNumber()})))[e]}static inspect(e){return globalThis.Deno?.inspect(e,{colors:!0,depth:1/0,strAbbreviateSize:1/0})??e}#n;format(t){return this.#n=("string"==typeof t?e.format[t]:t)??e.format.text,this}static format={text(t,{level:n,content:r,options:o}){const i={error:"red",warn:"orange",info:"cyan",ok:"green",log:"white",debug:"gray",wdebug:"yellow",trace:"gray",probe:"magenta"}[n],s=[`%c ${n.replace("wdebug","debug").toLocaleUpperCase().padEnd(5)} │%c`],l=[`color: black; background-color: ${i}`,""];if(o.date||o.time||o.delta){const e=(new Date).toISOString(),t=[];if(o.delta){const e=performance.now()/1e3;let n=e.toPrecision(4);e<1&&(n=e.toPrecision(2)),t.push(`+${n}`)}o.date&&o.time?t.push(e):o.date?t.push(e.slice(0,e.indexOf("T"))):o.time&&t.push(e.slice(e.indexOf("T")+1,-1)),s.push(`%c ${t.join(" ¦ ").trim()} %c`),l.push(`color: black; background-color: ${i}`,"")}if(o.caller.file||o.caller.name||o.caller.line){const e=t.#o();if(e){const t=[];if(o.caller.file){let n=`${e.file}`;Array.isArray(o.caller.fileformat)&&(n=n.replace(o.caller.fileformat[0],o.caller.fileformat[1])),t.push(n)}o.caller.name&&e.name&&t.push(e.name),o.caller.line&&t.push(e.line,e.column),s.push(`%c ${t.join(":").trim()} %c`),l.push("color: black; background-color: gray","")}}const a=[];for(const[n,r]of Object.entries(t.tags))a.push(`${n}:${e.inspect(r)}`);return s.push(`%c ${a.join(" ").trim()} %c`),l.push("background-color: black",""),[s.join(""),...l,...r.map(e.inspect)]},json(e,{level:t,content:n,options:r}){const o={level:t,timestamp:Date.now(),tags:e.tags,content:n},i={};if(r.date||r.time){const e=new Date(o.timestamp).toISOString();r.date&&(i.date=e.slice(0,e.indexOf("T"))),r.time&&(i.time=e.slice(e.indexOf("T")+1,-1))}if(r.delta&&(i.delta=performance.now()/1e3),r.caller.file||r.caller.name||r.caller.line){const t=e.#o();if(t){if(i.caller={},r.caller.file){let e=`${t.file}`;Array.isArray(r.caller.fileformat)&&(e=e.replace(r.caller.fileformat[0],r.caller.fileformat[1])),i.caller.file=e}r.caller.name&&t.name&&(i.caller.name=t.name),r.caller.line&&(i.caller.line=[t.line,t.column])}}return[JSON.stringify({...o,...i})]}}};TransformStream;function t(e){let t=0;for(const n of e)t+=n.length;const n=new Uint8Array(t);let r=0;for(const t of e)n.set(t,r),r+=t.length;return n}function n(e){const t=e.length,n=new Uint8Array(t);n[0]=0;let r=0,o=1;for(;o<t;)e[o]===e[r]?(r++,n[o]=r,o++):0===r?(n[o]=0,o++):r=n[r-1];return n}TransformStream,TransformStream,TransformStream,TransformStream;var r=class extends TransformStream{#i="";constructor(e={allowCR:!1}){super({transform:(t,n)=>{for(t=this.#i+t;;){const r=t.indexOf("\n"),o=e.allowCR?t.indexOf("\r"):-1;if(-1!==o&&o!==t.length-1&&(-1===r||r-1>o)){n.enqueue(t.slice(0,o)),t=t.slice(o+1);continue}if(-1===r)break;const i="\r"===t[r-1]?r-1:r;n.enqueue(t.slice(0,i)),t=t.slice(r+1)}this.#i=t},flush:t=>{if(""===this.#i)return;const n=e.allowCR&&this.#i.endsWith("\r")?this.#i.slice(0,-1):this.#i;t.enqueue(n)}})}};new TextDecoder;var o=new TextEncoder,i=new TextDecoder;function s(t,n,{logger:s=new e,stdin:a=null,stdout:c="debug",stderr:u="error",env:d,cwd:h,raw:f,callback:p,buffering:m,sync:g,throw:w,dryrun:b,winext:v="",os:y=Deno.build.os}={}){"windows"===y&&(t=`${t}${v}`),s=s.with({bin:t}),p&&"piped"!==l(a)&&(a="piped");const T=new Deno.Command(t,{args:n,stdin:g?"null":l(a),stdout:l(c),stderr:l(u),env:d,cwd:h,windowsRawArguments:f});if(b){s.wdebug(`dryrun: ${t} not executed`);const e={success:!0,code:0,stdio:[],stdin:"",stdout:"",stderr:""};return g?e:Promise.resolve(e)}return g?function(e,{bin:t,log:n,throw:r,stdout:o,stderr:s}){const a=Date.now(),c=e.outputSync(),{success:u,code:d}=c,h=Date.now()-a,f={get stdio(){return[[h,1,this.stdout],[h,2,this.stderr]]},stdin:"",stdout:"piped"===l(o)?i.decode(c.stdout):"",stderr:"piped"===l(s)?i.decode(c.stderr):""};for(const{channel:e,mode:t}of[{channel:"stdout",mode:o},{channel:"stderr",mode:s}])"piped"===l(t)&&f[e]&&n.with({t:h,channel:e})[t]?.(f[e]);if(!u&&r)throw new EvalError(`${t} exited with non-zero code ${d}:\n${f.stdout}\n${f.stderr}`);return{success:u,code:d,...f}}(T,{bin:t,log:s,throw:w,stdout:c,stderr:u}):async function(e,{bin:t,log:n,callback:i=({close:e})=>e?.(),buffering:s=250,throw:a,...c}){const u=e.spawn(),d=Date.now(),h={stdio:[],get stdin(){return this.stdio.filter((([e,t])=>0===t)).map((([e,t,n])=>n)).join("\n")},get stdout(){return this.stdio.filter((([e,t])=>1===t)).map((([e,t,n])=>n)).join("\n")},get stderr(){return this.stdio.filter((([e,t])=>2===t)).map((([e,t,n])=>n)).join("\n")}},f={};let p="";const m=function(e,t){let n=null,r=null;const o=(...i)=>{o.clear(),r=()=>{o.clear(),e.call(o,...i)},n=setTimeout(r,t)};return o.clear=()=>{"number"==typeof n&&(clearTimeout(n),n=null,r=null)},o.flush=()=>{r?.()},Object.defineProperty(o,"pending",{get:()=>"number"==typeof n}),o}((async e=>{n.with({t:e}).trace("debounced"),p="",await i({stdio:h,i:h.stdin.length,...f})}),s);if("piped"===l(c.stdin)){const e=u.stdin.getWriter();Object.assign(f,{async write(t,r=!0){const i=Date.now()-d;c.stdin&&n.with({t:i,channel:"stdin"})[c.stdin]?.(t),h.stdio.push([i,0,t]),r&&!t.endsWith("\n")&&(t+="\n"),await e.write(o.encode(t)),p="stdin",e.releaseLock()},async close(){try{e.releaseLock(),await u.stdin.close(),n.with({t:Date.now()-d,closed:"stdin"}).trace()}catch{}},async wait(e=1e3){const t=Date.now()-d;n.with({t:t,waiting:e}).trace(),await function(e,t={}){const{signal:n,persistent:r=!0}=t;return n?.aborted?Promise.reject(n.reason):new Promise(((t,o)=>{const i=()=>{clearTimeout(s),o(n?.reason)},s=setTimeout((()=>{n?.removeEventListener("abort",i),t()}),e);if(n?.addEventListener("abort",i,{once:!0}),!1===r)try{Deno.unrefTimer(s)}catch(e){if(!(e instanceof ReferenceError))throw e;console.error("`persistent` option is only available in Deno")}}))}(e),m(t)}}),m(Date.now()-d)}await Promise.all(["stdout","stderr"].filter((e=>"piped"===l(c[e]))).map((async e=>{for await(const t of u[e].pipeThrough(new TextDecoderStream).pipeThrough(new r)){const r=Date.now()-d,o={stdout:1,stderr:2}[e];if(c[e]&&n.with({t:r,channel:e})[c[e]]?.(t),h.stdio.length&&p===e){const e=h.stdio.at(-1);e[1]===o&&(e[2]+=`\n${t}`)}else h.stdio.push([r,o,t]);p=e,m(r)}}))),m.flush();const{success:g,code:w}=await u.status;if(!g&&a)throw new EvalError(`${t} exited with non-zero code ${w}:\n${h.stdout}\n${h.stderr}`);return{success:g,code:w,...h}}(T,{bin:t,log:s,callback:p,buffering:m,throw:w,stdin:"piped"===l(a)?a:null,stdout:"piped"===l(c)?c:null,stderr:"piped"===l(u)?u:null})}function l(e){return["inherit","null"].includes(`${e}`)?`${e}`:"piped"}export{s as command};
|
|
2
2
|
/**
|
|
3
|
-
* Logger
|
|
3
|
+
* Logger class.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
* -
|
|
8
|
-
*
|
|
9
|
-
* - Timestamps
|
|
10
|
-
* - Delta
|
|
11
|
-
* - Caller information
|
|
12
|
-
* - Log formatters
|
|
5
|
+
* This class provides a simple and efficient logging framework intended to supersed the native {@link https://developer.mozilla.org/en-US/docs/Web/API/console | console} by providing additional features and metadata.
|
|
6
|
+
*
|
|
7
|
+
* It supports out-of-the-box colored output, a log level mechanism (that honor `LOG_LEVEL` environment variable), a tag system, and a variety of options to customize the output.
|
|
8
|
+
* A neat addition is the ability to display caller information (file, name, line) which can be especially useful for debugging.
|
|
13
9
|
*
|
|
14
10
|
* @example
|
|
15
11
|
* ```ts
|
|
16
12
|
* import { Logger } from "./mod.ts"
|
|
17
13
|
*
|
|
18
14
|
* // Configure logger
|
|
19
|
-
* const tags = { foo:
|
|
20
|
-
* const
|
|
21
|
-
* const log = new Logger({ level: Logger.level.debug, options, tags })
|
|
15
|
+
* const tags = { foo: "bar" }
|
|
16
|
+
* const log = new Logger({ level: "trace", tags, date: true, time: true, delta:true, caller:true })
|
|
22
17
|
*
|
|
23
18
|
* // Print logs
|
|
24
|
-
* log
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
19
|
+
* log
|
|
20
|
+
* .error("🍱 bento")
|
|
21
|
+
* .warn("🍜 ramen")
|
|
22
|
+
* .ok("🍚 gohan")
|
|
23
|
+
* .info("🍣 sushi")
|
|
24
|
+
* .log("🍥 narutomaki")
|
|
25
|
+
* .debug("🍡 dango")
|
|
26
|
+
* .wdebug("🍵 matcha")
|
|
27
|
+
* .trace("🍙 onigiri")
|
|
28
|
+
* .probe("🥟 gyoza")
|
|
29
|
+
*
|
|
30
|
+
* // Create a new inherited logger with additional tags
|
|
31
|
+
* log.with({ bar: "true" }).log("🍶 sake")
|
|
32
|
+
* ```
|
|
33
|
+
*
|
|
34
|
+
* @author Simon Lecoq (lowlighter)
|
|
35
|
+
* @license MIT
|
|
36
|
+
*/
|
|
37
|
+
/**
|
|
38
|
+
* Run a command.
|
|
39
|
+
*
|
|
40
|
+
* This is a wrapper around {@link https://docs.deno.com/api/deno/~/Deno.Command | Deno.command} that provides a better handling of stdio for interactive processes.
|
|
41
|
+
*
|
|
42
|
+
* Like `Deno.command`, the `env`, `cwd`, and `raw` (alias for `windowsRawArguments`) options are supported.
|
|
43
|
+
*
|
|
44
|
+
* The `stdin`, `stdout` and `stderr` options can be either set to an allowed {@link https://docs.deno.com/api/deno/~/Deno.Command | Deno.command} values (`"inherit"`, `"null"`, `"piped"`), or either to a supported log level of {@link Logger}.
|
|
45
|
+
* In the later case, the content will be always be "piped" and logged to the specified level of the provided {@link Logger} instance.
|
|
46
|
+
*
|
|
47
|
+
* Set `winext` option to automatically append an extension to the binary path on Windows (like `.cmd` or `.exe`).
|
|
48
|
+
* This is useful when the binary path isn't automatically resolved on Windows.
|
|
49
|
+
*
|
|
50
|
+
* Pass a `callback` option to interact with the process stdin and stdout.
|
|
51
|
+
* It is called each time data is received on of the piped channels, after input buffering.
|
|
52
|
+
* It will receive an object with the current stdio content, the current command index (based on the content written to stdin), along with a few additional functions:
|
|
53
|
+
* - `write(content: string, newline?: boolean): Promise<void>` encodes and writes content to stdin.
|
|
54
|
+
* - A newline is automatically appended by default but can be toggled off by passing `false` as second argument.
|
|
55
|
+
* - `close(): Promise<void>` closes stdin.
|
|
56
|
+
* - Note that you **need** to eventually call this method to prevent most processes from hanging as they're waiting for more input.
|
|
57
|
+
* - `wait(dt: number): Promise<void>` waits for a given amount of time before calling the callback again.
|
|
58
|
+
* - It is especially useful for polling, like checking if a specific line has been written to stdio or not.
|
|
59
|
+
*
|
|
60
|
+
* The `buffering` option is used to merge messages that are received relatively closely.
|
|
61
|
+
* Setting this option to a low value will also increase the rate at which the `callback` is called.
|
|
62
|
+
*
|
|
63
|
+
* Resulting object contains the same properties as {@link https://docs.deno.com/api/deno/~/Deno.CommandStatus | Deno.CommandStatus}
|
|
64
|
+
* with an additional `stdio` property that contains an array of ordered tuples with the delta timestamp since process start, the channel idenfitier (0:stdin, 1:stdout, 2:stderr) and the content.
|
|
65
|
+
* This offers a proper history of exchanged content.
|
|
66
|
+
*
|
|
67
|
+
* @example
|
|
68
|
+
* ```ts
|
|
69
|
+
* import { command } from "./command.ts"
|
|
70
|
+
* import { Logger } from "jsr:@libs/logger"
|
|
71
|
+
* await command("deno", ["version"], { env: { NO_COLOR: "true" }, cwd: "/tmp", raw: true })
|
|
72
|
+
* await command("deno", ["version"], { stdout: "piped" })
|
|
73
|
+
* await command("deno", ["version"], { logger: new Logger(), stdout: "debug" })
|
|
74
|
+
* await command("deno", ["version"], { winext: ".exe" })
|
|
75
|
+
* ```
|
|
76
|
+
*
|
|
77
|
+
* @example
|
|
78
|
+
* ```ts
|
|
79
|
+
* import { command } from "./command.ts"
|
|
80
|
+
* const { stdout } = await command("deno", ["repl"], {
|
|
81
|
+
* env: { NO_COLOR: "true" },
|
|
82
|
+
* callback: ({ i, write, close }) => i === 0 ? write("console.log('hello')") : close(),
|
|
83
|
+
* })
|
|
84
|
+
* console.assert(stdout.includes("hello"))
|
|
29
85
|
* ```
|
|
30
86
|
*
|
|
31
87
|
* @author Simon Lecoq (lowlighter)
|
|
32
88
|
* @license MIT
|
|
89
|
+
* @module
|
|
33
90
|
*/
|
package/command.ts
CHANGED
|
@@ -1,8 +1,3 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @module
|
|
3
|
-
* A wrapper around `Deno.command` that provides a better handling of stdio for interactive processes.
|
|
4
|
-
*/
|
|
5
|
-
|
|
6
1
|
// Imports
|
|
7
2
|
import type { Arg, Nullable, Promisable } from "@libs/typing"
|
|
8
3
|
import { Logger, type loglevel } from "@libs/logger"
|
|
@@ -13,8 +8,8 @@ export type { Logger, loglevel, Promisable }
|
|
|
13
8
|
|
|
14
9
|
/** Run options. */
|
|
15
10
|
export type options = {
|
|
16
|
-
/** Logger. */
|
|
17
|
-
|
|
11
|
+
/** Logger instance. */
|
|
12
|
+
logger?: Logger
|
|
18
13
|
/** Environment variables. */
|
|
19
14
|
env?: Deno.CommandOptions["env"]
|
|
20
15
|
/** Current working directory. */
|
|
@@ -86,47 +81,82 @@ const encoder = new TextEncoder()
|
|
|
86
81
|
/** Text decoder */
|
|
87
82
|
const decoder = new TextDecoder()
|
|
88
83
|
|
|
89
|
-
/**
|
|
84
|
+
/**
|
|
85
|
+
* Asynchronous version of {@link command}.
|
|
86
|
+
*
|
|
87
|
+
* Note that stdin is not usable in sync mode and will always be empty.
|
|
88
|
+
*
|
|
89
|
+
* @example
|
|
90
|
+
* ```ts
|
|
91
|
+
* import { command } from "./command.ts"
|
|
92
|
+
* command("deno", ["version"], { sync: true })
|
|
93
|
+
* ```
|
|
94
|
+
* @example
|
|
95
|
+
* ```
|
|
96
|
+
* import { command } from "./command.ts"
|
|
97
|
+
* try {
|
|
98
|
+
* command("deno", ["eval", "Deno.exit(1)"], { sync: true, throw: true })
|
|
99
|
+
* }
|
|
100
|
+
* catch (error) {
|
|
101
|
+
* console.log(error)
|
|
102
|
+
* }
|
|
103
|
+
* ```
|
|
104
|
+
*/
|
|
90
105
|
export function command(bin: string, args: string[], options?: options & { sync?: false }): Promise<result>
|
|
91
|
-
/**
|
|
106
|
+
/**
|
|
107
|
+
* Synchronous version of {@link command}.
|
|
108
|
+
*
|
|
109
|
+
* @example
|
|
110
|
+
* ```
|
|
111
|
+
* import { command } from "./command.ts"
|
|
112
|
+
* try {
|
|
113
|
+
* await command("deno", ["eval", "Deno.exit(1)"], { throw: true })
|
|
114
|
+
* }
|
|
115
|
+
* catch (error) {
|
|
116
|
+
* console.log(error)
|
|
117
|
+
* }
|
|
118
|
+
* ```
|
|
119
|
+
*/
|
|
92
120
|
export function command(bin: string, args: string[], options?: options & { sync: true }): result
|
|
93
121
|
/**
|
|
94
122
|
* Run a command.
|
|
95
123
|
*
|
|
96
|
-
* This is a wrapper around
|
|
97
|
-
*
|
|
98
|
-
* `stdin`, `stdout` and `stderr` can be set to allowed `Deno.command` values (`"inherit"`, `"null"`, `"piped"`),
|
|
99
|
-
* or can be set to a supported log level of `@libs/logger` library. In the later case, the content will be piped and
|
|
100
|
-
* logged to the specified level.
|
|
124
|
+
* This is a wrapper around {@link https://docs.deno.com/api/deno/~/Deno.Command | Deno.command} that provides a better handling of stdio for interactive processes.
|
|
101
125
|
*
|
|
102
|
-
* Like `Deno.command`,
|
|
126
|
+
* Like `Deno.command`, the `env`, `cwd`, and `raw` (alias for `windowsRawArguments`) options are supported.
|
|
103
127
|
*
|
|
104
|
-
*
|
|
105
|
-
* always be
|
|
128
|
+
* The `stdin`, `stdout` and `stderr` options can be either set to an allowed {@link https://docs.deno.com/api/deno/~/Deno.Command | Deno.command} values (`"inherit"`, `"null"`, `"piped"`), or either to a supported log level of {@link Logger}.
|
|
129
|
+
* In the later case, the content will be always be "piped" and logged to the specified level of the provided {@link Logger} instance.
|
|
106
130
|
*
|
|
107
|
-
*
|
|
131
|
+
* Set `winext` option to automatically append an extension to the binary path on Windows (like `.cmd` or `.exe`).
|
|
132
|
+
* This is useful when the binary path isn't automatically resolved on Windows.
|
|
108
133
|
*
|
|
109
|
-
*
|
|
110
|
-
*
|
|
134
|
+
* Pass a `callback` option to interact with the process stdin and stdout.
|
|
135
|
+
* It is called each time data is received on of the piped channels, after input buffering.
|
|
136
|
+
* It will receive an object with the current stdio content, the current command index (based on the content written to stdin), along with a few additional functions:
|
|
137
|
+
* - `write(content: string, newline?: boolean): Promise<void>` encodes and writes content to stdin.
|
|
138
|
+
* - A newline is automatically appended by default but can be toggled off by passing `false` as second argument.
|
|
139
|
+
* - `close(): Promise<void>` closes stdin.
|
|
140
|
+
* - Note that you **need** to eventually call this method to prevent most processes from hanging as they're waiting for more input.
|
|
141
|
+
* - `wait(dt: number): Promise<void>` waits for a given amount of time before calling the callback again.
|
|
142
|
+
* - It is especially useful for polling, like checking if a specific line has been written to stdio or not.
|
|
111
143
|
*
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
* This allows to easily track the order of messages and have a proper history rather than a merged output.
|
|
144
|
+
* The `buffering` option is used to merge messages that are received relatively closely.
|
|
145
|
+
* Setting this option to a low value will also increase the rate at which the `callback` is called.
|
|
115
146
|
*
|
|
116
|
-
*
|
|
147
|
+
* Resulting object contains the same properties as {@link https://docs.deno.com/api/deno/~/Deno.CommandStatus | Deno.CommandStatus}
|
|
148
|
+
* with an additional `stdio` property that contains an array of ordered tuples with the delta timestamp since process start, the channel idenfitier (0:stdin, 1:stdout, 2:stderr) and the content.
|
|
149
|
+
* This offers a proper history of exchanged content.
|
|
117
150
|
*
|
|
118
|
-
*
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
*
|
|
127
|
-
*
|
|
128
|
-
* The callback is called at each new line from piped channels, except that it is debounced by the `buffering` option which makes it more
|
|
129
|
-
* likely to send input when the process is actually expecting it.
|
|
151
|
+
* @example
|
|
152
|
+
* ```ts
|
|
153
|
+
* import { command } from "./command.ts"
|
|
154
|
+
* import { Logger } from "jsr:@libs/logger"
|
|
155
|
+
* await command("deno", ["version"], { env: { NO_COLOR: "true" }, cwd: "/tmp", raw: true })
|
|
156
|
+
* await command("deno", ["version"], { stdout: "piped" })
|
|
157
|
+
* await command("deno", ["version"], { logger: new Logger(), stdout: "debug" })
|
|
158
|
+
* await command("deno", ["version"], { winext: ".exe" })
|
|
159
|
+
* ```
|
|
130
160
|
*
|
|
131
161
|
* @example
|
|
132
162
|
* ```ts
|
|
@@ -138,13 +168,11 @@ export function command(bin: string, args: string[], options?: options & { sync:
|
|
|
138
168
|
* console.assert(stdout.includes("hello"))
|
|
139
169
|
* ```
|
|
140
170
|
*
|
|
141
|
-
* @
|
|
142
|
-
*
|
|
143
|
-
*
|
|
144
|
-
* command("deno", ["eval", "Deno.exit(1)"], { throw: true, sync: true })
|
|
145
|
-
* ```
|
|
171
|
+
* @author Simon Lecoq (lowlighter)
|
|
172
|
+
* @license MIT
|
|
173
|
+
* @module
|
|
146
174
|
*/
|
|
147
|
-
export function command(bin: string, args: string[], { log = new Logger(), stdin = null, stdout = "debug", stderr = "error", env, cwd, raw, callback, buffering, sync, throw: _throw, dryrun, winext = "", os = Deno.build.os } = {} as options): Promisable<result> {
|
|
175
|
+
export function command(bin: string, args: string[], { logger: log = new Logger(), stdin = null, stdout = "debug", stderr = "error", env, cwd, raw, callback, buffering, sync, throw: _throw, dryrun, winext = "", os = Deno.build.os } = {} as options): Promisable<result> {
|
|
148
176
|
if (os === "windows") {
|
|
149
177
|
bin = `${bin}${winext}`
|
|
150
178
|
}
|
|
@@ -154,7 +182,7 @@ export function command(bin: string, args: string[], { log = new Logger(), stdin
|
|
|
154
182
|
}
|
|
155
183
|
const command = new Deno.Command(bin, { args, stdin: !sync ? handle(stdin) : "null", stdout: handle(stdout), stderr: handle(stderr), env, cwd, windowsRawArguments: raw })
|
|
156
184
|
if (dryrun) {
|
|
157
|
-
log.
|
|
185
|
+
log.wdebug(`dryrun: ${bin} not executed`)
|
|
158
186
|
const result = { success: true, code: 0, stdio: [], stdin: "", stdout: "", stderr: "" }
|
|
159
187
|
return sync ? result : Promise.resolve(result)
|
|
160
188
|
}
|
|
@@ -216,7 +244,7 @@ async function spawn(
|
|
|
216
244
|
const options = {} as Pick<Arg<callback>, "write" | "close" | "wait">
|
|
217
245
|
let last = ""
|
|
218
246
|
const debounced = debounce(async (t: number) => {
|
|
219
|
-
log.with({ t }).
|
|
247
|
+
log.with({ t }).trace("debounced")
|
|
220
248
|
last = ""
|
|
221
249
|
await callback({ stdio, i: stdio.stdin.length, ...options })
|
|
222
250
|
}, buffering)
|
|
@@ -241,14 +269,14 @@ async function spawn(
|
|
|
241
269
|
try {
|
|
242
270
|
writer.releaseLock()
|
|
243
271
|
await process.stdin.close()
|
|
244
|
-
log.with({ t: Date.now() - start, closed: "stdin" }).
|
|
272
|
+
log.with({ t: Date.now() - start, closed: "stdin" }).trace()
|
|
245
273
|
} catch {
|
|
246
274
|
// Ignore
|
|
247
275
|
}
|
|
248
276
|
},
|
|
249
277
|
async wait(dt = 1000) {
|
|
250
278
|
const t = Date.now() - start
|
|
251
|
-
log.with({ t, waiting: dt }).
|
|
279
|
+
log.with({ t, waiting: dt }).trace()
|
|
252
280
|
await delay(dt)
|
|
253
281
|
debounced(t)
|
|
254
282
|
},
|
package/command_test.ts
CHANGED
|
@@ -49,7 +49,7 @@ for (const sync of [false, true]) {
|
|
|
49
49
|
for (const mode of ["inherit", "piped", null, "debug", "log", "info", "warn", "error"] as const) {
|
|
50
50
|
test("deno")(`command() supports stdio set to "${mode}" in "${sync ? "sync" : "async"}" mode`, async () => {
|
|
51
51
|
const result = await command("deno", ["--version"], {
|
|
52
|
-
|
|
52
|
+
logger: new Logger({ level: "disabled" }),
|
|
53
53
|
env: { NO_COLOR: "true" },
|
|
54
54
|
stdin: mode,
|
|
55
55
|
stdout: mode,
|
package/deno.jsonc
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"icon": "⏯️",
|
|
3
3
|
"name": "@libs/run",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "2.0.1",
|
|
5
5
|
"description": "Utilities to run subprocess.",
|
|
6
6
|
"keywords": [
|
|
7
7
|
"subprocess",
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
"@std/async/delay": "jsr:@std/async@0.224.2/delay",
|
|
29
29
|
"@std/async/debounce": "jsr:@std/async@0.224.2/debounce",
|
|
30
30
|
"@std/streams": "jsr:@std/streams@0.224.5",
|
|
31
|
-
"@libs/logger": "jsr:@libs/logger@
|
|
31
|
+
"@libs/logger": "jsr:@libs/logger@2",
|
|
32
32
|
"@libs/testing": "jsr:@libs/testing@2",
|
|
33
33
|
"@libs/typing": "jsr:@libs/typing@2"
|
|
34
34
|
},
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"test:deno": "deno fmt --check && deno task test --filter='/^\\[deno\\]/' --quiet && deno coverage --exclude=.js && deno lint",
|
|
47
47
|
"test:deno-future": "DENO_FUTURE=1 && deno task test:deno",
|
|
48
48
|
"test:others": "deno fmt --check && deno task test --filter='/^\\[node|bun \\]/' --quiet && deno coverage --exclude=.js && deno lint",
|
|
49
|
-
"coverage:html": "deno
|
|
49
|
+
"coverage:html": "deno task test --filter='/^\\[deno\\]/' --quiet && deno coverage --exclude=.js --html && sleep 1",
|
|
50
50
|
"lint": "deno fmt --check && deno lint && deno doc --lint mod.ts && deno publish --dry-run --quiet --allow-dirty"
|
|
51
51
|
},
|
|
52
52
|
"lint": {
|
package/deno.lock
CHANGED
|
@@ -2,10 +2,12 @@
|
|
|
2
2
|
"version": "3",
|
|
3
3
|
"packages": {
|
|
4
4
|
"specifiers": {
|
|
5
|
+
"jsr:@libs/logger": "jsr:@libs/logger@2.0.1",
|
|
5
6
|
"jsr:@libs/logger@1.1.3": "jsr:@libs/logger@1.1.3",
|
|
7
|
+
"jsr:@libs/logger@2": "jsr:@libs/logger@2.0.1",
|
|
8
|
+
"jsr:@libs/run@1": "jsr:@libs/run@1.0.3",
|
|
6
9
|
"jsr:@libs/testing@2": "jsr:@libs/testing@2.0.0",
|
|
7
10
|
"jsr:@libs/typing@2": "jsr:@libs/typing@2.6.0",
|
|
8
|
-
"jsr:@libs/typing@2.6": "jsr:@libs/typing@2.6.0",
|
|
9
11
|
"jsr:@std/assert@0.226.0": "jsr:@std/assert@0.226.0",
|
|
10
12
|
"jsr:@std/assert@1.0.0-rc.2": "jsr:@std/assert@1.0.0-rc.2",
|
|
11
13
|
"jsr:@std/async@0.224.2": "jsr:@std/async@0.224.2",
|
|
@@ -22,6 +24,18 @@
|
|
|
22
24
|
"@libs/logger@1.1.3": {
|
|
23
25
|
"integrity": "a359d5ce4aa9f2508b1515ad6f48f41e9dfbc2250ebaa1fd9059930b3a9bab3a"
|
|
24
26
|
},
|
|
27
|
+
"@libs/logger@2.0.1": {
|
|
28
|
+
"integrity": "b712d36396dfbd8018af092afdba919afc1f92062d11ce27a83724fe7eb22b13"
|
|
29
|
+
},
|
|
30
|
+
"@libs/run@1.0.3": {
|
|
31
|
+
"integrity": "21eeabe1f8fdcc8d5ebb20e950bc8de3142eb74b6edaa2281572ce890ce1f5a0",
|
|
32
|
+
"dependencies": [
|
|
33
|
+
"jsr:@libs/logger@1.1.3",
|
|
34
|
+
"jsr:@libs/typing@2",
|
|
35
|
+
"jsr:@std/async@0.224.2",
|
|
36
|
+
"jsr:@std/streams@0.224.5"
|
|
37
|
+
]
|
|
38
|
+
},
|
|
25
39
|
"@libs/testing@2.0.0": {
|
|
26
40
|
"integrity": "a1cb40f127ec8ab3a37814beb13ff604b5aacbf9da633b413b243b7fcbd2309a",
|
|
27
41
|
"dependencies": [
|
|
@@ -43,7 +57,10 @@
|
|
|
43
57
|
]
|
|
44
58
|
},
|
|
45
59
|
"@std/assert@1.0.0-rc.2": {
|
|
46
|
-
"integrity": "0484eab1d76b55fca1c3beaff485a274e67dd3b9f065edcbe70030dfc0b964d3"
|
|
60
|
+
"integrity": "0484eab1d76b55fca1c3beaff485a274e67dd3b9f065edcbe70030dfc0b964d3",
|
|
61
|
+
"dependencies": [
|
|
62
|
+
"jsr:@std/internal@^1.0.0"
|
|
63
|
+
]
|
|
47
64
|
},
|
|
48
65
|
"@std/async@0.224.2": {
|
|
49
66
|
"integrity": "4d277d6e165df43d5e061ba0ef3edfddb8e8d558f5b920e3e6b1d2614b44d074"
|
|
@@ -85,7 +102,7 @@
|
|
|
85
102
|
"remote": {},
|
|
86
103
|
"workspace": {
|
|
87
104
|
"dependencies": [
|
|
88
|
-
"jsr:@libs/logger@
|
|
105
|
+
"jsr:@libs/logger@2",
|
|
89
106
|
"jsr:@libs/testing@2",
|
|
90
107
|
"jsr:@libs/typing@2",
|
|
91
108
|
"jsr:@std/async@0.224.2",
|
package/mod.mjs
CHANGED
|
@@ -1,33 +1,90 @@
|
|
|
1
|
-
var e=class e{constructor({level:t,format:n,output:
|
|
1
|
+
var e=class e{constructor({level:t,format:n,output:r,tags:o,...i}={}){"granted"===globalThis.Deno?.permissions.querySync?.({name:"env",variable:"LOG_LEVEL"}).state&&(t??=globalThis.Deno?.env.get("LOG_LEVEL")),this.#e=r||null===r?r:console,this.#t=e.level.log,this.#n=e.format.text,this.#r={date:!1,time:!1,delta:!0,caller:{file:!1,name:!1,line:!1,fileformat:null}},this.level(t).format(n).options(i),this.tags=o??{}}#e;#r;options(e){if(!e)return structuredClone(this.#r);if("date"in e&&(this.#r.date=e.date),"time"in e&&(this.#r.time=e.time),"delta"in e&&(this.#r.delta=e.delta),"caller"in e)switch(!0){case!0===e.caller:this.#r.caller={file:!0,name:!0,line:!0,fileformat:this.#r.caller.fileformat};break;case!1===e.caller:this.#r.caller={file:!1,name:!1,line:!1,fileformat:this.#r.caller.fileformat};break;case"object"==typeof e.caller:"file"in e.caller&&(this.#r.caller.file=e.caller.file),"name"in e.caller&&(this.#r.caller.name=e.caller.name),"line"in e.caller&&(this.#r.caller.line=e.caller.line),"fileformat"in e.caller&&void 0!==e.caller.fileformat&&(this.#r.caller.fileformat=e.caller.fileformat)}return this}#t;level(t){return arguments.length?(Number.isNaN(Number.parseInt(`${t}`))||(t=Number.parseInt(`${t}`)),"string"==typeof t&&t in e.level&&(t=e.level[t]),"number"==typeof t&&(this.#t=!Number.isNaN(t)&&t>=0?t:-1),this):this.#t>=0?this.#t:NaN}static level=Object.freeze({disabled:NaN,error:0,warn:1,info:2,ok:2,log:3,debug:4,wdebug:4,trace:5,probe:NaN,always:1/0});error(...t){return this.#t>=e.level.error&&this.#e?.error(...this.#n(this,{level:"error",content:t,options:this.#r})),this}warn(...t){return this.#t>=e.level.warn&&this.#e?.warn(...this.#n(this,{level:"warn",content:t,options:this.#r})),this}info(...t){return this.#t>=e.level.info&&this.#e?.info(...this.#n(this,{level:"info",content:t,options:this.#r})),this}ok(...t){return this.#t>=e.level.info&&this.#e?.info(...this.#n(this,{level:"ok",content:t,options:this.#r})),this}log(...t){return this.#t>=e.level.log&&this.#e?.log(...this.#n(this,{level:"log",content:t,options:this.#r})),this}debug(...t){return this.#t>=e.level.debug&&this.#e?.debug(...this.#n(this,{level:"debug",content:t,options:this.#r})),this}wdebug(...t){return this.#t>=e.level.debug&&this.#e?.debug(...this.#n(this,{level:"wdebug",content:t,options:this.#r})),this}trace(...t){return this.#t>=e.level.trace&&this.#e?.debug(...this.#n(this,{level:"trace",content:t,options:this.#r})),this}probe(...e){return this.#e?.debug(...this.#n(this,{level:"probe",content:e,options:this.#r})),this}tags;with(t={}){return new e({level:this.#t,format:this.#n,output:this.#e,...this.#r,tags:{...this.tags,...t}})}#o(e=3){const t=Error,n=t.prepareStackTrace;t.prepareStackTrace=(e,t)=>t;const{stack:r}=new Error;t.prepareStackTrace=n;return r.map((e=>({file:e.getFileName(),name:e.getFunctionName(),line:e.getLineNumber(),column:e.getColumnNumber()})))[e]}static inspect(e){return globalThis.Deno?.inspect(e,{colors:!0,depth:1/0,strAbbreviateSize:1/0})??e}#n;format(t){return this.#n=("string"==typeof t?e.format[t]:t)??e.format.text,this}static format={text(t,{level:n,content:r,options:o}){const i={error:"red",warn:"orange",info:"cyan",ok:"green",log:"white",debug:"gray",wdebug:"yellow",trace:"gray",probe:"magenta"}[n],s=[`%c ${n.replace("wdebug","debug").toLocaleUpperCase().padEnd(5)} │%c`],l=[`color: black; background-color: ${i}`,""];if(o.date||o.time||o.delta){const e=(new Date).toISOString(),t=[];if(o.delta){const e=performance.now()/1e3;let n=e.toPrecision(4);e<1&&(n=e.toPrecision(2)),t.push(`+${n}`)}o.date&&o.time?t.push(e):o.date?t.push(e.slice(0,e.indexOf("T"))):o.time&&t.push(e.slice(e.indexOf("T")+1,-1)),s.push(`%c ${t.join(" ¦ ").trim()} %c`),l.push(`color: black; background-color: ${i}`,"")}if(o.caller.file||o.caller.name||o.caller.line){const e=t.#o();if(e){const t=[];if(o.caller.file){let n=`${e.file}`;Array.isArray(o.caller.fileformat)&&(n=n.replace(o.caller.fileformat[0],o.caller.fileformat[1])),t.push(n)}o.caller.name&&e.name&&t.push(e.name),o.caller.line&&t.push(e.line,e.column),s.push(`%c ${t.join(":").trim()} %c`),l.push("color: black; background-color: gray","")}}const a=[];for(const[n,r]of Object.entries(t.tags))a.push(`${n}:${e.inspect(r)}`);return s.push(`%c ${a.join(" ").trim()} %c`),l.push("background-color: black",""),[s.join(""),...l,...r.map(e.inspect)]},json(e,{level:t,content:n,options:r}){const o={level:t,timestamp:Date.now(),tags:e.tags,content:n},i={};if(r.date||r.time){const e=new Date(o.timestamp).toISOString();r.date&&(i.date=e.slice(0,e.indexOf("T"))),r.time&&(i.time=e.slice(e.indexOf("T")+1,-1))}if(r.delta&&(i.delta=performance.now()/1e3),r.caller.file||r.caller.name||r.caller.line){const t=e.#o();if(t){if(i.caller={},r.caller.file){let e=`${t.file}`;Array.isArray(r.caller.fileformat)&&(e=e.replace(r.caller.fileformat[0],r.caller.fileformat[1])),i.caller.file=e}r.caller.name&&t.name&&(i.caller.name=t.name),r.caller.line&&(i.caller.line=[t.line,t.column])}}return[JSON.stringify({...o,...i})]}}};TransformStream;function t(e){let t=0;for(const n of e)t+=n.length;const n=new Uint8Array(t);let r=0;for(const t of e)n.set(t,r),r+=t.length;return n}function n(e){const t=e.length,n=new Uint8Array(t);n[0]=0;let r=0,o=1;for(;o<t;)e[o]===e[r]?(r++,n[o]=r,o++):0===r?(n[o]=0,o++):r=n[r-1];return n}TransformStream,TransformStream,TransformStream,TransformStream;var r=class extends TransformStream{#i="";constructor(e={allowCR:!1}){super({transform:(t,n)=>{for(t=this.#i+t;;){const r=t.indexOf("\n"),o=e.allowCR?t.indexOf("\r"):-1;if(-1!==o&&o!==t.length-1&&(-1===r||r-1>o)){n.enqueue(t.slice(0,o)),t=t.slice(o+1);continue}if(-1===r)break;const i="\r"===t[r-1]?r-1:r;n.enqueue(t.slice(0,i)),t=t.slice(r+1)}this.#i=t},flush:t=>{if(""===this.#i)return;const n=e.allowCR&&this.#i.endsWith("\r")?this.#i.slice(0,-1):this.#i;t.enqueue(n)}})}};new TextDecoder;var o=new TextEncoder,i=new TextDecoder;function s(t,n,{logger:s=new e,stdin:a=null,stdout:c="debug",stderr:u="error",env:d,cwd:h,raw:f,callback:p,buffering:m,sync:g,throw:w,dryrun:b,winext:v="",os:y=Deno.build.os}={}){"windows"===y&&(t=`${t}${v}`),s=s.with({bin:t}),p&&"piped"!==l(a)&&(a="piped");const T=new Deno.Command(t,{args:n,stdin:g?"null":l(a),stdout:l(c),stderr:l(u),env:d,cwd:h,windowsRawArguments:f});if(b){s.wdebug(`dryrun: ${t} not executed`);const e={success:!0,code:0,stdio:[],stdin:"",stdout:"",stderr:""};return g?e:Promise.resolve(e)}return g?function(e,{bin:t,log:n,throw:r,stdout:o,stderr:s}){const a=Date.now(),c=e.outputSync(),{success:u,code:d}=c,h=Date.now()-a,f={get stdio(){return[[h,1,this.stdout],[h,2,this.stderr]]},stdin:"",stdout:"piped"===l(o)?i.decode(c.stdout):"",stderr:"piped"===l(s)?i.decode(c.stderr):""};for(const{channel:e,mode:t}of[{channel:"stdout",mode:o},{channel:"stderr",mode:s}])"piped"===l(t)&&f[e]&&n.with({t:h,channel:e})[t]?.(f[e]);if(!u&&r)throw new EvalError(`${t} exited with non-zero code ${d}:\n${f.stdout}\n${f.stderr}`);return{success:u,code:d,...f}}(T,{bin:t,log:s,throw:w,stdout:c,stderr:u}):async function(e,{bin:t,log:n,callback:i=({close:e})=>e?.(),buffering:s=250,throw:a,...c}){const u=e.spawn(),d=Date.now(),h={stdio:[],get stdin(){return this.stdio.filter((([e,t])=>0===t)).map((([e,t,n])=>n)).join("\n")},get stdout(){return this.stdio.filter((([e,t])=>1===t)).map((([e,t,n])=>n)).join("\n")},get stderr(){return this.stdio.filter((([e,t])=>2===t)).map((([e,t,n])=>n)).join("\n")}},f={};let p="";const m=function(e,t){let n=null,r=null;const o=(...i)=>{o.clear(),r=()=>{o.clear(),e.call(o,...i)},n=setTimeout(r,t)};return o.clear=()=>{"number"==typeof n&&(clearTimeout(n),n=null,r=null)},o.flush=()=>{r?.()},Object.defineProperty(o,"pending",{get:()=>"number"==typeof n}),o}((async e=>{n.with({t:e}).trace("debounced"),p="",await i({stdio:h,i:h.stdin.length,...f})}),s);if("piped"===l(c.stdin)){const e=u.stdin.getWriter();Object.assign(f,{async write(t,r=!0){const i=Date.now()-d;c.stdin&&n.with({t:i,channel:"stdin"})[c.stdin]?.(t),h.stdio.push([i,0,t]),r&&!t.endsWith("\n")&&(t+="\n"),await e.write(o.encode(t)),p="stdin",e.releaseLock()},async close(){try{e.releaseLock(),await u.stdin.close(),n.with({t:Date.now()-d,closed:"stdin"}).trace()}catch{}},async wait(e=1e3){const t=Date.now()-d;n.with({t:t,waiting:e}).trace(),await function(e,t={}){const{signal:n,persistent:r=!0}=t;return n?.aborted?Promise.reject(n.reason):new Promise(((t,o)=>{const i=()=>{clearTimeout(s),o(n?.reason)},s=setTimeout((()=>{n?.removeEventListener("abort",i),t()}),e);if(n?.addEventListener("abort",i,{once:!0}),!1===r)try{Deno.unrefTimer(s)}catch(e){if(!(e instanceof ReferenceError))throw e;console.error("`persistent` option is only available in Deno")}}))}(e),m(t)}}),m(Date.now()-d)}await Promise.all(["stdout","stderr"].filter((e=>"piped"===l(c[e]))).map((async e=>{for await(const t of u[e].pipeThrough(new TextDecoderStream).pipeThrough(new r)){const r=Date.now()-d,o={stdout:1,stderr:2}[e];if(c[e]&&n.with({t:r,channel:e})[c[e]]?.(t),h.stdio.length&&p===e){const e=h.stdio.at(-1);e[1]===o&&(e[2]+=`\n${t}`)}else h.stdio.push([r,o,t]);p=e,m(r)}}))),m.flush();const{success:g,code:w}=await u.status;if(!g&&a)throw new EvalError(`${t} exited with non-zero code ${w}:\n${h.stdout}\n${h.stderr}`);return{success:g,code:w,...h}}(T,{bin:t,log:s,callback:p,buffering:m,throw:w,stdin:"piped"===l(a)?a:null,stdout:"piped"===l(c)?c:null,stderr:"piped"===l(u)?u:null})}function l(e){return["inherit","null"].includes(`${e}`)?`${e}`:"piped"}export{s as command};
|
|
2
2
|
/**
|
|
3
|
-
* Logger
|
|
3
|
+
* Logger class.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
* -
|
|
8
|
-
*
|
|
9
|
-
* - Timestamps
|
|
10
|
-
* - Delta
|
|
11
|
-
* - Caller information
|
|
12
|
-
* - Log formatters
|
|
5
|
+
* This class provides a simple and efficient logging framework intended to supersed the native {@link https://developer.mozilla.org/en-US/docs/Web/API/console | console} by providing additional features and metadata.
|
|
6
|
+
*
|
|
7
|
+
* It supports out-of-the-box colored output, a log level mechanism (that honor `LOG_LEVEL` environment variable), a tag system, and a variety of options to customize the output.
|
|
8
|
+
* A neat addition is the ability to display caller information (file, name, line) which can be especially useful for debugging.
|
|
13
9
|
*
|
|
14
10
|
* @example
|
|
15
11
|
* ```ts
|
|
16
12
|
* import { Logger } from "./mod.ts"
|
|
17
13
|
*
|
|
18
14
|
* // Configure logger
|
|
19
|
-
* const tags = { foo:
|
|
20
|
-
* const
|
|
21
|
-
* const log = new Logger({ level: Logger.level.debug, options, tags })
|
|
15
|
+
* const tags = { foo: "bar" }
|
|
16
|
+
* const log = new Logger({ level: "trace", tags, date: true, time: true, delta:true, caller:true })
|
|
22
17
|
*
|
|
23
18
|
* // Print logs
|
|
24
|
-
* log
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
19
|
+
* log
|
|
20
|
+
* .error("🍱 bento")
|
|
21
|
+
* .warn("🍜 ramen")
|
|
22
|
+
* .ok("🍚 gohan")
|
|
23
|
+
* .info("🍣 sushi")
|
|
24
|
+
* .log("🍥 narutomaki")
|
|
25
|
+
* .debug("🍡 dango")
|
|
26
|
+
* .wdebug("🍵 matcha")
|
|
27
|
+
* .trace("🍙 onigiri")
|
|
28
|
+
* .probe("🥟 gyoza")
|
|
29
|
+
*
|
|
30
|
+
* // Create a new inherited logger with additional tags
|
|
31
|
+
* log.with({ bar: "true" }).log("🍶 sake")
|
|
32
|
+
* ```
|
|
33
|
+
*
|
|
34
|
+
* @author Simon Lecoq (lowlighter)
|
|
35
|
+
* @license MIT
|
|
36
|
+
*/
|
|
37
|
+
/**
|
|
38
|
+
* Run a command.
|
|
39
|
+
*
|
|
40
|
+
* This is a wrapper around {@link https://docs.deno.com/api/deno/~/Deno.Command | Deno.command} that provides a better handling of stdio for interactive processes.
|
|
41
|
+
*
|
|
42
|
+
* Like `Deno.command`, the `env`, `cwd`, and `raw` (alias for `windowsRawArguments`) options are supported.
|
|
43
|
+
*
|
|
44
|
+
* The `stdin`, `stdout` and `stderr` options can be either set to an allowed {@link https://docs.deno.com/api/deno/~/Deno.Command | Deno.command} values (`"inherit"`, `"null"`, `"piped"`), or either to a supported log level of {@link Logger}.
|
|
45
|
+
* In the later case, the content will be always be "piped" and logged to the specified level of the provided {@link Logger} instance.
|
|
46
|
+
*
|
|
47
|
+
* Set `winext` option to automatically append an extension to the binary path on Windows (like `.cmd` or `.exe`).
|
|
48
|
+
* This is useful when the binary path isn't automatically resolved on Windows.
|
|
49
|
+
*
|
|
50
|
+
* Pass a `callback` option to interact with the process stdin and stdout.
|
|
51
|
+
* It is called each time data is received on of the piped channels, after input buffering.
|
|
52
|
+
* It will receive an object with the current stdio content, the current command index (based on the content written to stdin), along with a few additional functions:
|
|
53
|
+
* - `write(content: string, newline?: boolean): Promise<void>` encodes and writes content to stdin.
|
|
54
|
+
* - A newline is automatically appended by default but can be toggled off by passing `false` as second argument.
|
|
55
|
+
* - `close(): Promise<void>` closes stdin.
|
|
56
|
+
* - Note that you **need** to eventually call this method to prevent most processes from hanging as they're waiting for more input.
|
|
57
|
+
* - `wait(dt: number): Promise<void>` waits for a given amount of time before calling the callback again.
|
|
58
|
+
* - It is especially useful for polling, like checking if a specific line has been written to stdio or not.
|
|
59
|
+
*
|
|
60
|
+
* The `buffering` option is used to merge messages that are received relatively closely.
|
|
61
|
+
* Setting this option to a low value will also increase the rate at which the `callback` is called.
|
|
62
|
+
*
|
|
63
|
+
* Resulting object contains the same properties as {@link https://docs.deno.com/api/deno/~/Deno.CommandStatus | Deno.CommandStatus}
|
|
64
|
+
* with an additional `stdio` property that contains an array of ordered tuples with the delta timestamp since process start, the channel idenfitier (0:stdin, 1:stdout, 2:stderr) and the content.
|
|
65
|
+
* This offers a proper history of exchanged content.
|
|
66
|
+
*
|
|
67
|
+
* @example
|
|
68
|
+
* ```ts
|
|
69
|
+
* import { command } from "./command.ts"
|
|
70
|
+
* import { Logger } from "jsr:@libs/logger"
|
|
71
|
+
* await command("deno", ["version"], { env: { NO_COLOR: "true" }, cwd: "/tmp", raw: true })
|
|
72
|
+
* await command("deno", ["version"], { stdout: "piped" })
|
|
73
|
+
* await command("deno", ["version"], { logger: new Logger(), stdout: "debug" })
|
|
74
|
+
* await command("deno", ["version"], { winext: ".exe" })
|
|
75
|
+
* ```
|
|
76
|
+
*
|
|
77
|
+
* @example
|
|
78
|
+
* ```ts
|
|
79
|
+
* import { command } from "./command.ts"
|
|
80
|
+
* const { stdout } = await command("deno", ["repl"], {
|
|
81
|
+
* env: { NO_COLOR: "true" },
|
|
82
|
+
* callback: ({ i, write, close }) => i === 0 ? write("console.log('hello')") : close(),
|
|
83
|
+
* })
|
|
84
|
+
* console.assert(stdout.includes("hello"))
|
|
29
85
|
* ```
|
|
30
86
|
*
|
|
31
87
|
* @author Simon Lecoq (lowlighter)
|
|
32
88
|
* @license MIT
|
|
89
|
+
* @module
|
|
33
90
|
*/
|