effective-progress 0.1.0 → 0.1.3

package/src/types.ts

@@ -1,39 +1,55 @@
 import { Brand, Context, Effect, Option, Schema } from "effect";
+import type { PartialDeep } from "type-fest";
+import { defaultProgressBarColors, ProgressBarColorsSchema } from "./colors";
 
-export const SPINNER_FRAMES = ["-", "\\", "|", "/"] as const;
-export const DEFAULT_PROGRESS_BAR_WIDTH = 30;
-
-export const ProgressBarConfigSchema = Schema.Struct({
+export const RendererConfigSchema = Schema.Struct({
   isTTY: Schema.Boolean,
   disableUserInput: Schema.Boolean,
+  renderIntervalMillis: Schema.Number,
+  maxLogLines: Schema.optional(Schema.Number),
+  nonTtyUpdateStep: Schema.Number,
+});
+export type RendererConfigShape = typeof RendererConfigSchema.Type;
+export const decodeRendererConfigSync = Schema.decodeUnknownSync(RendererConfigSchema);
+
+export const ProgressBarConfigSchema = Schema.Struct({
   spinnerFrames: Schema.NonEmptyArray(Schema.String),
   barWidth: Schema.Number,
   fillChar: Schema.String,
   emptyChar: Schema.String,
   leftBracket: Schema.String,
   rightBracket: Schema.String,
-  maxLogLines: Schema.Number,
-  nonTtyUpdateStep: Schema.Number,
+  colors: ProgressBarColorsSchema,
 });
-
 export type ProgressBarConfigShape = typeof ProgressBarConfigSchema.Type;
+export const decodeProgressBarConfigSync = Schema.decodeUnknownSync(ProgressBarConfigSchema);
 
-export const defaultProgressBarConfig: ProgressBarConfigShape = {
+export const defaultRendererConfig: RendererConfigShape = {
   isTTY: Boolean(process.stderr.isTTY),
   disableUserInput: true,
-  spinnerFrames: SPINNER_FRAMES,
-  barWidth: DEFAULT_PROGRESS_BAR_WIDTH,
+  renderIntervalMillis: 50, // 20 FPS
+  maxLogLines: 0,
+  nonTtyUpdateStep: 5,
+};
+
+export const defaultProgressBarConfig: ProgressBarConfigShape = {
+  spinnerFrames: ["-", "\\", "|", "/"],
+  barWidth: 30,
   fillChar: "━",
   emptyChar: "─",
   leftBracket: "",
   rightBracket: "",
-  maxLogLines: 0,
-  nonTtyUpdateStep: 5,
+  colors: defaultProgressBarColors,
 };
 
+export class RendererConfig extends Context.Tag("stromseng.dev/RendererConfig")<
+  RendererConfig,
+  PartialDeep<RendererConfigShape>
+>() {}
+
 export class ProgressBarConfig extends Context.Tag("stromseng.dev/ProgressBarConfig")<
   ProgressBarConfig,
-  ProgressBarConfigShape
+  PartialDeep<ProgressBarConfigShape>
 >() {}
 
 const TaskIdSchema = Schema.Number.pipe(Schema.brand("TaskId"));
@@ -50,6 +66,7 @@ export interface AddTaskOptions {
   readonly total?: number;
   readonly transient?: boolean;
   readonly parentId?: TaskId;
+  readonly progressbar?: PartialDeep<ProgressBarConfigShape>;
 }
 
 export interface UpdateTaskOptions {
@@ -59,11 +76,7 @@ export interface UpdateTaskOptions {
   readonly transient?: boolean;
 }
 
-export interface TrackOptions {
-  readonly description: string;
-  readonly total?: number;
-  readonly transient?: boolean;
-}
+export type TrackOptions = Exclude<AddTaskOptions, "parentId">;
 
 export class DeterminateTaskUnits extends Schema.TaggedClass<DeterminateTaskUnits>()(
   "DeterminateTaskUnits",
@@ -91,6 +104,7 @@ export class TaskSnapshot extends Schema.TaggedClass<TaskSnapshot>()("TaskSnapsh
   status: TaskStatusSchema,
   transient: Schema.Boolean,
   units: TaskUnitsSchema,
+  progressbar: ProgressBarConfigSchema,
 }) {}
 
 export interface ProgressService {
@@ -100,6 +114,7 @@ export interface ProgressService {
   readonly completeTask: (taskId: TaskId) => Effect.Effect<void>;
   readonly failTask: (taskId: TaskId) => Effect.Effect<void>;
   readonly log: (...args: ReadonlyArray<unknown>) => Effect.Effect<void>;
+  readonly withCapturedLogs: <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>;
   readonly getTask: (taskId: TaskId) => Effect.Effect<Option.Option<TaskSnapshot>>;
   readonly listTasks: Effect.Effect<ReadonlyArray<TaskSnapshot>>;
   readonly withTask: <A, E, R>(
@@ -160,8 +175,3 @@ export const ProgressTaskEventSchema = Schema.Union(
 export type ProgressTaskEvent = typeof ProgressTaskEventSchema.Type;
 
 export const decodeProgressTaskEvent = Schema.decodeUnknownSync(ProgressTaskEventSchema);
-
-export const isIndeterminateTask = (snapshot: TaskSnapshot) =>
-  snapshot.units._tag === "IndeterminateTaskUnits";
-
-export const nextSpinnerFrame = (index: number) => (index + 1) % SPINNER_FRAMES.length;

package/src/utils.ts

@@ -0,0 +1,20 @@
+export const inferTotal = (iterable: Iterable<unknown>): number | undefined => {
+  if (Array.isArray(iterable)) {
+    return iterable.length;
+  }
+
+  if (typeof iterable === "string") {
+    return iterable.length;
+  }
+
+  const candidate = iterable as { length?: unknown; size?: unknown };
+  if (typeof candidate.length === "number") {
+    return candidate.length;
+  }
+
+  if (typeof candidate.size === "number") {
+    return candidate.size;
+  }
+
+  return undefined;
+};