@lowlighter/run 2.0.4 → 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/deno.jsonc

@@ -1,7 +1,7 @@
 {
   "icon": "⏯️",
   "name": "@libs/run",
-  "version": "2.0.4",
+  "version": "2.0.5",
   "description": "Utilities to run subprocess.",
   "keywords": [
     "subprocess",

package/package.json

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