effective-progress 0.5.4 → 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

@@ -37,8 +37,6 @@ declare const DeterminateTaskUnits_base: Schema.TaggedClass<DeterminateTaskUnits
 declare class DeterminateTaskUnits extends DeterminateTaskUnits_base {}
 declare const IndeterminateTaskUnits_base: Schema.TaggedClass<IndeterminateTaskUnits, "IndeterminateTaskUnits", {
   readonly _tag: Schema.tag<"IndeterminateTaskUnits">;
-} & {
-  spinnerFrame: typeof Schema.Number;
 }>;
 declare class IndeterminateTaskUnits extends IndeterminateTaskUnits_base {}
 declare const TaskUnitsSchema: Schema.Union<[typeof DeterminateTaskUnits, typeof IndeterminateTaskUnits]>;
@@ -68,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>;
@@ -140,7 +138,7 @@ declare const ProgressTaskEventSchema: Schema.Union<[typeof TaskAddedEvent, type
 type ProgressTaskEvent = typeof ProgressTaskEventSchema.Type;
 declare const decodeProgressTaskEvent: (u: unknown, overrideOptions?: effect_SchemaAST0.ParseOptions) => TaskAddedEvent | TaskUpdatedEvent | TaskAdvancedEvent | TaskCompletedEvent | TaskFailedEvent | TaskRemovedEvent;
 //#endregion
-//#region src/runtime.d.ts
+//#region src/services/progress.d.ts
 declare const Progress_base: Context.TagClass<Progress, "stromseng.dev/effective-progress/Progress", ProgressService>;
 declare class Progress extends Progress_base {
   static readonly Default: Layer.Layer<Progress, never, never>;
@@ -177,7 +175,7 @@ declare const forEach: {
   <A, B, E, R>(f: (item: A, index: number) => Effect.Effect<B, E, R>, options: ForEachOptions): (iterable: Iterable<A>) => Effect.Effect<ReadonlyArray<B>, E, Exclude<R, Progress | Task>>;
 };
 //#endregion
-//#region src/stdio.d.ts
+//#region src/services/stdio.d.ts
 interface ProgressStdioService {
   readonly stdout: NodeJS.WriteStream;
   readonly stderr: NodeJS.WriteStream;