@lowlighter/run 2.0.3 → 2.0.5

package/README.md

@@ -9,6 +9,42 @@
 > [!WARNING]
 > Deno exclusive!
 
+## 📑 Examples
+
+### Run a command
+
+```ts
+import { command } from "./command.ts"
+
+// Commands are run asynchronously, and support Deno.command options alongside additional options
+// For example, stdio can also be set to a Logger level too or you can automatically append an extension when running on Windows
+await command("deno", ["version"], { stdout: "debug", stderr: "piped", winext: ".exe" })
+
+// Commands can be run synchronously too, and can also throw an error automatically when the process exits with a non-zero code
+command("deno", ["version"], { sync: true, throw: true })
+```
+
+### Writing to stdin
+
+```ts
+import { command } from "./command.ts"
+
+const { stdout } = await command("deno", ["repl"], {
+  env: { NO_COLOR: "true" },
+  // Passing a callback will automatically set `stdin` to `"piped"`
+  // You can then write to the process using utility functions
+  callback: async ({ i, stdio, write, close, wait }) => {
+    if ((!stdio.stdout.includes("exit using")) || i) {
+      return
+    }
+    await write("console.log('hello')")
+    await wait(1000)
+    close()
+  },
+})
+console.assert(stdout.includes("hello"))
+```
+
 ## ✨ Features
 
 - Supports `stdin` interactivity through callbacks.

package/command.ts

@@ -161,9 +161,18 @@ export function command(bin: string, args: string[], options?: options & { sync:
  * @example
  * ```ts
  * import { command } from "./command.ts"
+ *
  * const { stdout } = await command("deno", ["repl"], {
  *   env: { NO_COLOR: "true" },
- *   callback: ({ i, write, close }) => i === 0 ? write("console.log('hello')") : close(),
+ *   // Passing a callback will automatically set `stdin` to `"piped"`
+ *   // You can then write to the process using utility functions
+ *   callback: async ({ i, stdio, write, close, wait }) => {
+ *     if ((!stdio.stdout.includes("exit using")) || (i))
+ *       return
+ *     await write("console.log('hello')")
+ *     await wait(1000)
+ *     close()
+ *   },
  * })
  * console.assert(stdout.includes("hello"))
  * ```

package/command_test.ts

@@ -20,7 +20,7 @@ test("deno")("command() can spawn subprocesses synchronously", () => {
 }, { permissions: { run: ["deno"] } })
 
 test("deno")("command() handles callback<write()> and callback<close()> calls", async () => {
-  const result = await command("deno", ["repl"], { env: { NO_COLOR: "true" }, callback: ({ i, write, close }) => i === 0 ? write("console.log('hello')") : close() })
+  const result = await command("deno", ["repl"], { stdin: "debug", env: { NO_COLOR: "true" }, callback: ({ i, write, close }) => i === 0 ? write("console.log('hello')") : close() })
   expect(result).toMatchObject({ success: true, code: 0, stdin: "console.log('hello')" })
   expect(result.stdout).toMatch(/hello/)
 }, { permissions: { run: ["deno"] } })
@@ -48,7 +48,7 @@ test("deno")("command() handles callback<wait()> calls", async () => {
 for (const sync of [false, true]) {
   for (const mode of ["inherit", "piped", null, "debug", "log", "info", "warn", "error"] as const) {
     test("deno")(`command() supports stdio set to "${mode}" in "${sync ? "sync" : "async"}" mode`, async () => {
-      const result = await command("deno", ["--version"], {
+      const result = await command("deno", ["eval", "null"], {
         logger: new Logger({ level: "disabled" }),
         env: { NO_COLOR: "true" },
         stdin: mode,
@@ -121,3 +121,7 @@ test("deno")("command() does nothing in dryrun", async () => {
   expect(command("deno", ["--version"], { dryrun: true, sync: true })).toMatchObject({ success: true, code: 0, stdio: [], stdin: "", stderr: "", stdout: "" })
   await expect(command("deno", ["--version"], { dryrun: true })).resolves.toMatchObject({ success: true, code: 0, stdio: [], stdin: "", stderr: "", stdout: "" })
 }, { permissions: { run: ["deno"] } })
+
+test("deno")("command() appends windows extension when os platform is windows", () => {
+  expect(command("", ["--version"], { logger: new Logger({ level: "disabled" }), sync: true, winext: "deno", os: "windows" })).toMatchObject({ success: true, code: 0 })
+}, { permissions: { run: ["deno"] } })

package/deno.jsonc

@@ -1,7 +1,7 @@
 {
   "icon": "⏯️",
   "name": "@libs/run",
-  "version": "2.0.3",
+  "version": "2.0.5",
   "description": "Utilities to run subprocess.",
   "keywords": [
     "subprocess",
@@ -43,11 +43,13 @@
   "tasks": {
     "test": "deno test --allow-run=deno,node,bun,npx --no-prompt --coverage --clean --trace-leaks --doc",
     "dev": "deno fmt && deno task test --filter='/^\\[deno\\]/' && deno coverage --exclude=.js --detailed && deno task lint",
-    "test:deno": "deno fmt --check && deno task test --filter='/^\\[deno\\]/' --quiet && deno coverage --exclude=.js && deno lint",
-    "test:deno-future": "DENO_FUTURE=1 && deno task test:deno",
-    "test:others": "deno fmt --check && deno task test --filter='/^\\[node|bun \\]/' --quiet && deno coverage --exclude=.js && deno lint",
+    "test:deno": "deno task clean:deno && deno fmt --check && deno task test --filter='/^\\[deno\\]/' --quiet && deno coverage --exclude=.js && deno lint",
+    "test:deno-future": "deno task clean:deno && DENO_FUTURE=1 && deno task test:deno",
+    "test:others": "deno task clean:others && deno fmt --check && deno task test --filter='/^\\[node|bun \\]/' --quiet && deno coverage --exclude=.js && deno lint",
     "coverage:html": "deno task test --filter='/^\\[deno\\]/' --quiet && deno coverage --exclude=.js --html && sleep 1",
-    "lint": "deno fmt --check && deno lint && deno doc --lint mod.ts && deno publish --dry-run --quiet --allow-dirty"
+    "lint": "deno fmt --check && deno lint && deno doc --lint mod.ts && deno publish --dry-run --quiet --allow-dirty",
+    "clean:deno": "rm -rf node_modules .npmrc deno.lock",
+    "clean:others": "rm -rf node_modules .npmrc deno.lock package.json package-lock.json bun.lockb"
   },
   "lint": {
     "rules": {

package/deno.lock

@@ -2,22 +2,22 @@
   "version": "3",
   "packages": {
     "specifiers": {
-      "jsr:@libs/logger": "jsr:@libs/logger@2.1.1",
-      "jsr:@libs/logger@2": "jsr:@libs/logger@2.1.1",
+      "jsr:@libs/logger": "jsr:@libs/logger@2.1.2",
+      "jsr:@libs/logger@2": "jsr:@libs/logger@2.1.2",
       "jsr:@libs/testing@2": "jsr:@libs/testing@2.2.4",
       "jsr:@libs/typing@2": "jsr:@libs/typing@2.8.2",
-      "jsr:@std/assert@1": "jsr:@std/assert@1.0.2",
-      "jsr:@std/assert@^1.0.1": "jsr:@std/assert@1.0.2",
-      "jsr:@std/async@1": "jsr:@std/async@1.0.3",
-      "jsr:@std/bytes@^1.0.2-rc.3": "jsr:@std/bytes@1.0.2",
-      "jsr:@std/expect@1": "jsr:@std/expect@1.0.0",
-      "jsr:@std/http@1": "jsr:@std/http@1.0.3",
-      "jsr:@std/internal@^1.0.1": "jsr:@std/internal@1.0.1",
-      "jsr:@std/streams@1": "jsr:@std/streams@1.0.2"
+      "jsr:@std/assert@1": "jsr:@std/assert@1.0.3",
+      "jsr:@std/assert@^1.0.3": "jsr:@std/assert@1.0.3",
+      "jsr:@std/async@1": "jsr:@std/async@1.0.4",
+      "jsr:@std/bytes@^1.0.2": "jsr:@std/bytes@1.0.2",
+      "jsr:@std/expect@1": "jsr:@std/expect@1.0.1",
+      "jsr:@std/http@1": "jsr:@std/http@1.0.4",
+      "jsr:@std/internal@^1.0.2": "jsr:@std/internal@1.0.2",
+      "jsr:@std/streams@1": "jsr:@std/streams@1.0.3"
     },
     "jsr": {
-      "@libs/logger@2.1.1": {
-        "integrity": "508216c245aa7a13d55972cec6cf2ff45b341469334634a2748cd60c938677d6"
+      "@libs/logger@2.1.2": {
+        "integrity": "2a5f4b148fd8d6b1221ff89cff73367ca0511137f4d6548c532b6e220ed22bcc"
       },
       "@libs/testing@2.2.4": {
         "integrity": "3ef407b62cf18424b3e2e604eef5df81d3c07cf8adb4b78ab4cf40db2a029f2c",
@@ -31,35 +31,35 @@
       "@libs/typing@2.8.2": {
         "integrity": "c53f8aad9b01621de893aeac5d6cd592ec2ce783f8e89b677dcd81490a3be0a0"
       },
-      "@std/assert@1.0.2": {
-        "integrity": "ccacec332958126deaceb5c63ff8b4eaf9f5ed0eac9feccf124110435e59e49c",
+      "@std/assert@1.0.3": {
+        "integrity": "b0d03ce1ced880df67132eea140623010d415848df66f6aa5df76507ca7c26d8",
         "dependencies": [
-          "jsr:@std/internal@^1.0.1"
+          "jsr:@std/internal@^1.0.2"
         ]
       },
-      "@std/async@1.0.3": {
-        "integrity": "6ed64678db43451683c6c176a21426a2ccd21ba0269ebb2c36133ede3f165792"
+      "@std/async@1.0.4": {
+        "integrity": "373f5168a01b46ecaabc785d4e0f9ef18a010ab867af069fb905d93a9129ae5b"
       },
       "@std/bytes@1.0.2": {
         "integrity": "fbdee322bbd8c599a6af186a1603b3355e59a5fb1baa139f8f4c3c9a1b3e3d57"
       },
-      "@std/expect@1.0.0": {
-        "integrity": "030275683c23d6708878c5439a3ffd99285948d708e00835fd38fcef9a0bb921",
+      "@std/expect@1.0.1": {
+        "integrity": "44075d9c2cb701ddfc4d5a260da2fb26ba3cfd94c45d3a0359f63cabbf85a058",
         "dependencies": [
-          "jsr:@std/assert@^1.0.1",
-          "jsr:@std/internal@^1.0.1"
+          "jsr:@std/assert@^1.0.3",
+          "jsr:@std/internal@^1.0.2"
         ]
       },
-      "@std/http@1.0.3": {
-        "integrity": "bff3770c4df4711567de1711fe988d28db9535be0c9b0f1d2de8d0fb97e8b44c"
+      "@std/http@1.0.4": {
+        "integrity": "1a8142217907d49c4687f90ef3d257e7df2baf344c5122c322d7316df09df453"
       },
-      "@std/internal@1.0.1": {
-        "integrity": "6f8c7544d06a11dd256c8d6ba54b11ed870aac6c5aeafff499892662c57673e6"
+      "@std/internal@1.0.2": {
+        "integrity": "f4cabe2021352e8bfc24e6569700df87bf070914fc38d4b23eddd20108ac4495"
       },
-      "@std/streams@1.0.2": {
-        "integrity": "187c3c875675221f5355807a735e51b0f8769caade2cbca6d7f4fa710ea4ace4",
+      "@std/streams@1.0.3": {
+        "integrity": "d62e645ab981cee2c3d03040eb03cf387fc6bceef6d4564f3ed485a43741a81f",
         "dependencies": [
-          "jsr:@std/bytes@^1.0.2-rc.3"
+          "jsr:@std/bytes@^1.0.2"
         ]
       }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lowlighter/run",
-  "version": "2.0.3",
+  "version": "2.0.5",
   "type": "module",
   "scripts": {},
   "dependencies": {},