effective-progress 0.6.0 → 0.6.1

package/README.md

@@ -17,7 +17,7 @@
 - spinner support for “we have no idea how long this takes” work
 - keep using `Console.log` / `Effect.logInfo` while progress rendering is active
 - familiar `.all` and `.forEach` APIs — swap `Effect` for `Progress`, get progress bars basically for free
-- flicker-free rendering (in theory) by drawing everything in a single terminal frame
+- flicker-free rendering with [Ink](https://github.com/vadimdemedes/ink)
 
 ## Install
 
@@ -27,7 +27,7 @@ bun add effective-progress
 
 ## Usage
 
-This shows the simplest usage: iterate items with a single progress bar.
+Iterate items with a single progress bar.
 
 ```ts
 import { Console, Effect } from "effect";
@@ -50,13 +50,7 @@ Effect.runPromise(program);
 
 ### Nested example
 
-Run:
-
-```bash
-bun examples/nesting.ts
-```
-
-This demonstrates nested multibar behavior where parent tasks each run their own child progress bars.
+Nested progress bars with tree-style rendering that highlights parent tasks and their subtasks
 
 ```ts
 import { Effect } from "effect";
@@ -81,10 +75,15 @@ Effect.runPromise(program);
 
 ### Effect.all modes
 
-We support the `either`/`validate` modes of `Effect.all` and render the amount of sucesses/failures.
+Support for `either`/`validate` modes of `Effect.all` and render the amount of sucesses/failures.
 
 <img alt="Mixed outcomes modes output" src="docs/images/mixedOutcomes.gif" width="600" />
 
+- `Progress.all` in default mode (`mode: "default"`) remains fail-fast.
+- In fail-fast runs, unresolved units remain unprocessed.
+- `mode: "either"` and `mode: "validate"` run all effects and keep mixed outcomes in the task counters.
+- Mixed outcomes can still finalize as `done` when all units are accounted for.
+
 ### Other examples
 
 - `examples/simpleExample.ts` - low-boilerplate real-world flow
@@ -112,13 +111,6 @@ We support the `either`/`validate` modes of `Effect.all` and render the amount o
 - Layout uses a 100-column baseline and grows when content requires more space.
 - On narrow terminals, layout compacts to fit available width and tree prefixes are suppressed when description space is too tight.
 
-### Mixed outcomes and `mode`
-
-- `Progress.all` in default mode (`mode: "default"`) remains fail-fast.
-- In fail-fast runs, unresolved units remain unprocessed.
-- `mode: "either"` and `mode: "validate"` run all effects and keep mixed outcomes in the task counters.
-- Mixed outcomes can still finalize as `done` when all units are accounted for.
-
 ## Manual task control
 
 For manual usage, `task` still provides the current `Task` context, while logs continue through your outer `Console`:
@@ -131,8 +123,8 @@ const program = Progress.task(
     yield* Console.log("This log is handled by the outer Console", { taskId: currentTask });
 
     // Manual determinate updates:
-    yield* progress.advanceTask(currentTask, 3);
-    yield* progress.advanceTaskFailed(currentTask, 1);
+    yield* progress.incrementSucceeded(currentTask, 3);
+    yield* progress.incrementFailed(currentTask, 1);
     yield* Effect.sleep("1 second");
   }),
   { description: "Manual task", total: 10 },

package/dist/index.d.mts

@@ -66,8 +66,8 @@ interface TaskStore {
 interface ProgressService {
   readonly addTask: (options: AddTaskOptions) => Effect.Effect<TaskId>;
   readonly updateTask: (taskId: TaskId, options: UpdateTaskOptions) => Effect.Effect<void>;
-  readonly advanceTask: (taskId: TaskId, amount?: number) => Effect.Effect<void>;
-  readonly advanceTaskFailed: (taskId: TaskId, amount?: number) => Effect.Effect<void>;
+  readonly incrementSucceeded: (taskId: TaskId, amount?: number) => Effect.Effect<void>;
+  readonly incrementFailed: (taskId: TaskId, amount?: number) => Effect.Effect<void>;
   readonly completeTask: (taskId: TaskId) => Effect.Effect<void>;
   readonly failTask: (taskId: TaskId) => Effect.Effect<void>;
   readonly log: (...args: ReadonlyArray<unknown>) => Effect.Effect<void>;

package/dist/index.mjs

@@ -2,7 +2,7 @@ import { Brand, Cause, Clock, Context, Effect, Exit, FiberRef, Layer, Option, Sc
 import { dual } from "effect/Function";
 import { Box, Text, render } from "ink";
 import { useEffect, useState, useSyncExternalStore } from "react";
-import stringWidth from "string-width";
+import stringWidth from "fast-string-width";
 import { Fragment, jsx, jsxs } from "react/jsx-runtime";
 
 //#region src/types.ts
@@ -327,7 +327,7 @@ const makeProgressRenderStore = () => {
 				};
 			});
 		}),
-		addSuccess: (taskId, amount = 1) => Effect.sync(() => {
+		incrementSucceeded: (taskId, amount = 1) => Effect.sync(() => {
 			updateState((current) => {
 				const currentTask = current.tasks.get(taskId);
 				if (!currentTask || currentTask.units._tag !== "DeterminateTaskUnits") return current;
@@ -353,7 +353,7 @@ const makeProgressRenderStore = () => {
 				};
 			});
 		}),
-		addFailure: (taskId, amount = 1) => Effect.sync(() => {
+		incrementFailed: (taskId, amount = 1) => Effect.sync(() => {
 			updateState((current) => {
 				const currentTask = current.tasks.get(taskId);
 				if (!currentTask || currentTask.units._tag !== "DeterminateTaskUnits") return current;
@@ -1466,8 +1466,8 @@ const makeProgressService = Effect.gen(function* () {
 		});
 	});
 	const updateTask = store.updateTask;
-	const advanceTask = store.addSuccess;
-	const advanceTaskFailed = store.addFailure;
+	const incrementSucceeded = store.incrementSucceeded;
+	const incrementFailed = store.incrementFailed;
 	const completeTask = store.completeTask;
 	const failTask = store.failTask;
 	const getTask = store.getTask;
@@ -1485,8 +1485,8 @@ const makeProgressService = Effect.gen(function* () {
 	const service = {
 		addTask,
 		updateTask,
-		advanceTask,
-		advanceTaskFailed,
+		incrementSucceeded,
+		incrementFailed,
 		completeTask,
 		failTask,
 		log,
@@ -1546,11 +1546,11 @@ const allCountDisplay = (mode) => isCollectAllMode(mode) ? "detailed" : "process
 const wrapTrackedEffect = (progress, taskId, effect) => Effect.gen(function* () {
 	const exit = yield* Effect.exit(effect);
 	if (Exit.isSuccess(exit)) {
-		yield* progress.advanceTask(taskId, 1);
+		yield* progress.incrementSucceeded(taskId, 1);
 		return exit.value;
 	}
 	if (Cause.isInterruptedOnly(exit.cause)) return yield* Effect.failCause(exit.cause);
-	yield* progress.advanceTaskFailed(taskId, 1);
+	yield* progress.incrementFailed(taskId, 1);
 	return yield* Effect.failCause(exit.cause);
 });
 const isTaskFullyProcessed = (progress, taskId) => Effect.gen(function* () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "effective-progress",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "Effect-first terminal progress bars with nested multibar support",
   "homepage": "https://github.com/stromseng/effective-progress#readme",
   "bugs": {
@@ -27,9 +27,6 @@
       "default": "./dist/index.mjs"
     }
   },
-  "engines": {
-    "node": ">=20.12.0"
-  },
   "publishConfig": {
     "access": "public"
   },
@@ -43,9 +40,9 @@
     "format:check": "oxfmt --check ."
   },
   "dependencies": {
+    "fast-string-width": "^3.0.2",
     "ink": "^6.8.0",
-    "react": "^19.2.4",
-    "string-width": "^8.2.0"
+    "react": "^19.2.4"
   },
   "devDependencies": {
     "@effect/language-service": "^0.73.1",
@@ -59,5 +56,8 @@
   },
   "peerDependencies": {
     "effect": "^3.19.17"
+  },
+  "engines": {
+    "node": ">=20.12.0"
   }
 }