chore: initial release

Author: ctjlewis

.gitignore

@@ -0,0 +1 @@
+node_modules

assets/spinners-demo.gif

@@ -0,0 +1,19 @@
+{
+  "name": "bun-spinners",
+  "license": "MIT",
+  "version": "0.0.3",
+  "type": "module",
+  "types": "./src/index.ts",
+  "exports": {
+    ".": "./src/index.ts",
+    "./*": "./src/*/index.ts"
+  },
+  "devDependencies": {
+    "bun-types": "latest",
+    "eslint": "^8.22.0"
+  },
+  "dependencies": {
+    "bun-style": "^0.3.0",
+    "cli-spinners": "^2.7.0"
+  }
+}

bun.lockb

@@ -0,0 +1,42 @@
+# Bun Spinners
+
+Simple tool for logging any number of spinners.
+
+#### Preview
+
+![](/assets/spinners-demo.gif)
+
+#### Preview code
+
+See `test/index.test.ts`.
+
+```ts
+import { spinners } from "bun-spinners";
+
+const sleep = (ms: number) => new Promise(
+  (resolve) => setTimeout(resolve, ms)
+);
+
+try {
+  await spinners({
+    "Starting APU...": async () => {
+      await sleep(1000);
+    },
+
+    "Starting engines...": async () => {
+      await sleep(5000);
+      throw "Fuel mixture set to cutoff.";
+    },
+
+    "Setting flaps...": async () => {
+      await sleep(2000);
+    }
+  })
+} catch (e) {
+  await spinners({
+    "Aborting takeoff...": async () => {
+      await sleep(3000);
+    }
+  });
+}
+```

node_modules.bun

@@ -0,0 +1,99 @@
+import { LogStyles, style } from "bun-style";
+import * as cliSpinners from "cli-spinners";
+
+export interface SpinnerConfigs {
+  [text: string]: () => Promise<void>;
+}
+
+export type SpinnerState = "running" | "success" | "failure";
+
+export const spinners = async (
+  configs: SpinnerConfigs,
+  spinner: cliSpinners.SpinnerName = "dots",
+) => {
+  let failed = 0;
+  let finished = 0;
+
+  const spinnerEntries = Object.entries(configs);
+  const spinnerStates: Map<string, SpinnerState> = new Map();
+  const spinnerErrors = new Map<string, string>();
+
+  /**
+   * Initialize all spinner states to "running".
+   */
+  for (const [text] of spinnerEntries) {
+    spinnerStates.set(
+      text,
+      "running"
+    );
+  }
+
+  await Promise.all([
+    /**
+     * Run spinners.
+     */
+    (async () => {
+      const { frames, interval } = cliSpinners[spinner];
+
+      while (finished < spinnerEntries.length) {
+        for (const frame of frames) {
+          let frameOutput = "";
+
+          for (const [text] of spinnerEntries) {
+            const state = spinnerStates.get(text);
+
+            let prefix = frame;
+            const lineStyles: LogStyles[] = ["bold"];
+
+            switch (state) {
+              case "success":
+                prefix = "✓";
+                lineStyles.push("green")
+                break;
+
+              case "failure":
+                prefix = "✗";
+                lineStyles.push("red")
+                break;
+            }
+
+            frameOutput += style(`\n  ${prefix}  ${text}\n\r`, lineStyles);
+
+            const errors = spinnerErrors.get(text);
+            if (errors) {
+              frameOutput += style(`     ${errors}\n\r`, ["red"]);
+            }
+          }
+
+          console.log("\033[H\033[J");
+          console.log(style(`${frameOutput}\n`, ["grey"]));
+          await new Promise((resolve) => setTimeout(resolve, interval));
+        }
+      }
+    })(),
+    /**
+     * Execute spinner processes.
+     */
+    Promise.all(
+      spinnerEntries.map(
+        async ([text, fn]) => {
+          spinnerStates.set(text, "running");
+          try {
+            await fn();
+            spinnerStates.set(text, "success");
+          } catch (e) {
+            spinnerStates.set(text, "failure");
+            spinnerErrors.set(text, e?.toString());
+            failed++;
+          } finally {
+            finished++;
+          }
+        }
+      )
+    ),
+  ]);
+
+  if (failed > 0) {
+    throw `${failed} spinner(s) failed.`;
+  }
+};

package.json

@@ -0,0 +1,28 @@
+import { spinners } from "../src";
+
+const sleep = (ms: number) => new Promise(
+  (resolve) => setTimeout(resolve, ms)
+);
+
+try {
+  await spinners({
+    "Starting APU...": async () => {
+      await sleep(1000);
+    },
+
+    "Starting engines...": async () => {
+      await sleep(5000);
+      throw "Fuel mixture set to cutoff.";
+    },
+
+    "Setting flaps...": async () => {
+      await sleep(2000);
+    }
+  })
+} catch (e) {
+  await spinners({
+    "Aborting takeoff...": async () => {
+      await sleep(3000);
+    }
+  });
+}

readme.md

@@ -0,0 +1,16 @@
+{
+  "strict": true,
+  "compilerOptions": {
+    "noEmit": true,
+    "noImplicitAny": true,
+    "moduleResolution": "node",
+    "module": "esnext",
+    "target": "esnext",
+    "lib": [
+      "ESNext"
+    ],
+    "types": [
+      "bun-types"
+    ]
+  }
+}