@effectionx/tinyexec 0.1.2

package/README.md

@@ -0,0 +1,45 @@
+# tinyexec
+
+Effection compatible wrapper around
+[tinyexec](https://www.npmjs.com/package/tinyexec) package.
+
+---
+
+To run a process, use the `x` function:
+
+```ts
+import { x } from "@effectionx/tinyexec";
+import { each, main } from "effection";
+
+await main(function* () {
+  let proc = yield* x("echo", ["Hello, World"]);
+
+  for (let line of yield* each(proc.lines)) {
+    console.log(line);
+    yield* each.next();
+  }
+});
+// => prints "Hello, World"
+```
+
+The process will be automatically destroyed whenever it passes out of scope. For
+example, the following shows the output of the `top` command for five seconds
+before exiting.
+
+```ts
+import { x } from "@effectionx/tinyexec";
+import { each, main, sleep, spawn } from "effection";
+
+await main(function* () {
+  yield* spawn(function* () {
+    let proc = yield* x("top");
+
+    for (let line of yield* each(proc.lines)) {
+      console.log(line);
+      yield* each.next();
+    }
+  });
+
+  yield* sleep(5000);
+});
+```

package/esm/mod.d.ts

@@ -0,0 +1,2 @@
+export * from "./tinyexec.js";
+//# sourceMappingURL=mod.d.ts.map

package/esm/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC"}

package/esm/mod.js

@@ -0,0 +1 @@
+export * from "./tinyexec.js";

package/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/esm/tinyexec.d.ts

@@ -0,0 +1,27 @@
+import { type Operation, type Stream } from "effection";
+import { type KillSignal, type Options, type Output } from "tinyexec";
+/**
+ * Wraps a [tinyexec](https://github.com/tinylibs/tinyexec) process.
+ * To create one use the {@link x} function.
+ */
+export interface TinyProcess extends Operation<Output> {
+    /**
+     * A stream of lines coming from both stdin and stdout. The stream
+     * will terminate when stdout and stderr are closed which usually
+     * corresponds to the process ending.
+     */
+    lines: Stream<string, void>;
+    /**
+     * Send `signal` to this process
+     * @paramu signal - the OS signal to send to the process
+     */
+    kill(signal?: KillSignal): Operation<void>;
+}
+/**
+ * Run OS process with `cmd`
+ *
+ * This will create a {@link TinyProcess} resource. If it is still running
+ * when it passes out of scope, it will be killed.
+ */
+export declare function x(cmd: string, args?: string[], options?: Partial<Options>): Operation<TinyProcess>;
+//# sourceMappingURL=tinyexec.d.ts.map

package/esm/tinyexec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tinyexec.d.ts","sourceRoot":"","sources":["../src/tinyexec.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,SAAS,EAEd,KAAK,MAAM,EAEZ,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,KAAK,UAAU,EACf,KAAK,OAAO,EACZ,KAAK,MAAM,EAEZ,MAAM,UAAU,CAAC;AAElB;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,SAAS,CAAC,MAAM,CAAC;IACpD;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAE5B;;;OAGG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;CAC5C;AAED;;;;;GAKG;AACH,wBAAgB,CAAC,CACf,GAAG,EAAE,MAAM,EACX,IAAI,GAAE,MAAM,EAAO,EACnB,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,GACzB,SAAS,CAAC,WAAW,CAAC,CAyBxB"}

package/esm/tinyexec.js

@@ -0,0 +1,31 @@
+import { call, resource, stream, } from "effection";
+import { x as $x, } from "tinyexec";
+/**
+ * Run OS process with `cmd`
+ *
+ * This will create a {@link TinyProcess} resource. If it is still running
+ * when it passes out of scope, it will be killed.
+ */
+export function x(cmd, args = [], options) {
+    return resource(function* (provide) {
+        let tinyexec = $x(cmd, args, { ...options });
+        let promise = tinyexec;
+        let output = call(() => promise);
+        let tinyproc = {
+            *[Symbol.iterator]() {
+                return yield* output;
+            },
+            lines: stream(tinyexec),
+            *kill(signal) {
+                tinyexec.kill(signal);
+                yield* output;
+            },
+        };
+        try {
+            yield* provide(tinyproc);
+        }
+        finally {
+            yield* tinyproc.kill();
+        }
+    });
+}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@effectionx/tinyexec",
+  "version": "0.1.2",
+  "author": "engineering@frontside.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/thefrontside/effectionx.git"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/thefrontside/effectionx/issues"
+  },
+  "main": "./script/mod.js",
+  "module": "./esm/mod.js",
+  "exports": {
+    ".": {
+      "import": "./esm/mod.js",
+      "require": "./script/mod.js"
+    }
+  },
+  "engines": {
+    "node": ">= 16"
+  },
+  "sideEffects": false,
+  "dependencies": {
+    "effection": "3.0.3",
+    "tinyexec": "0.3.2"
+  },
+  "_generatedBy": "dnt@dev"
+}

package/script/mod.d.ts

@@ -0,0 +1,2 @@
+export * from "./tinyexec.js";
+//# sourceMappingURL=mod.d.ts.map

package/script/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC"}

package/script/mod.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./tinyexec.js"), exports);

package/script/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/script/tinyexec.d.ts

@@ -0,0 +1,27 @@
+import { type Operation, type Stream } from "effection";
+import { type KillSignal, type Options, type Output } from "tinyexec";
+/**
+ * Wraps a [tinyexec](https://github.com/tinylibs/tinyexec) process.
+ * To create one use the {@link x} function.
+ */
+export interface TinyProcess extends Operation<Output> {
+    /**
+     * A stream of lines coming from both stdin and stdout. The stream
+     * will terminate when stdout and stderr are closed which usually
+     * corresponds to the process ending.
+     */
+    lines: Stream<string, void>;
+    /**
+     * Send `signal` to this process
+     * @paramu signal - the OS signal to send to the process
+     */
+    kill(signal?: KillSignal): Operation<void>;
+}
+/**
+ * Run OS process with `cmd`
+ *
+ * This will create a {@link TinyProcess} resource. If it is still running
+ * when it passes out of scope, it will be killed.
+ */
+export declare function x(cmd: string, args?: string[], options?: Partial<Options>): Operation<TinyProcess>;
+//# sourceMappingURL=tinyexec.d.ts.map

package/script/tinyexec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tinyexec.d.ts","sourceRoot":"","sources":["../src/tinyexec.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,SAAS,EAEd,KAAK,MAAM,EAEZ,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,KAAK,UAAU,EACf,KAAK,OAAO,EACZ,KAAK,MAAM,EAEZ,MAAM,UAAU,CAAC;AAElB;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,SAAS,CAAC,MAAM,CAAC;IACpD;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAE5B;;;OAGG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;CAC5C;AAED;;;;;GAKG;AACH,wBAAgB,CAAC,CACf,GAAG,EAAE,MAAM,EACX,IAAI,GAAE,MAAM,EAAO,EACnB,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,GACzB,SAAS,CAAC,WAAW,CAAC,CAyBxB"}

package/script/tinyexec.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.x = x;
+const effection_1 = require("effection");
+const tinyexec_1 = require("tinyexec");
+/**
+ * Run OS process with `cmd`
+ *
+ * This will create a {@link TinyProcess} resource. If it is still running
+ * when it passes out of scope, it will be killed.
+ */
+function x(cmd, args = [], options) {
+    return (0, effection_1.resource)(function* (provide) {
+        let tinyexec = (0, tinyexec_1.x)(cmd, args, { ...options });
+        let promise = tinyexec;
+        let output = (0, effection_1.call)(() => promise);
+        let tinyproc = {
+            *[Symbol.iterator]() {
+                return yield* output;
+            },
+            lines: (0, effection_1.stream)(tinyexec),
+            *kill(signal) {
+                tinyexec.kill(signal);
+                yield* output;
+            },
+        };
+        try {
+            yield* provide(tinyproc);
+        }
+        finally {
+            yield* tinyproc.kill();
+        }
+    });
+}