diff --git a/.changeset/terminal-size.md b/.changeset/terminal-size.md new file mode 100644 index 00000000000..f0883a1d124 --- /dev/null +++ b/.changeset/terminal-size.md @@ -0,0 +1,6 @@ +--- +"effect": minor +"@effect/platform-node-shared": minor +--- + +Add `Terminal.size`, a scoped queue that starts with the current terminal dimensions and receives each resize. Custom terminals passed to `Terminal.make` must now supply `size`. diff --git a/packages/effect/src/Terminal.ts b/packages/effect/src/Terminal.ts index 3c5f5f24cce..5dd0f34f07b 100644 --- a/packages/effect/src/Terminal.ts +++ b/packages/effect/src/Terminal.ts @@ -42,6 +42,12 @@ export interface Terminal { */ readonly rows: Effect.Effect + /** + * Subscribes to terminal size changes. The queue starts with the current + * dimensions, receives each resize until the scope closes, and keeps only the + * latest size. + */ + readonly size: Effect.Effect, never, Scope.Scope> /** * Reads input events from the default standard input. */ @@ -56,6 +62,18 @@ export interface Terminal { readonly display: (text: string) => Effect.Effect } +/** + * Terminal dimensions measured in character cells. + * + * @stability unstable + * @category models + * @since 4.0.0 + */ +export interface Size { + readonly columns: number + readonly rows: number +} + /** * Keyboard key metadata for terminal input, including the key name and * modifier state. @@ -183,7 +201,7 @@ export const Terminal: Context.Service = Context.Service("ef * * **Details** * - * The implementation object supplies `columns`, `rows`, `readInput`, + * The implementation object supplies `columns`, `rows`, `size`, `readInput`, * `readLine`, and `display`; `make` attaches the `Terminal` service marker so * the result can be provided through the `Terminal` context service. * diff --git a/packages/effect/src/cli/Argument.ts b/packages/effect/src/cli/Argument.ts index 1d46bbd4c18..7facb5d9f98 100644 --- a/packages/effect/src/cli/Argument.ts +++ b/packages/effect/src/cli/Argument.ts @@ -501,6 +501,7 @@ export const map: { * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -564,6 +565,7 @@ export const mapEffect: { * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void diff --git a/packages/effect/src/cli/Command.ts b/packages/effect/src/cli/Command.ts index 2a5c9c01b14..e262ccee3cb 100644 --- a/packages/effect/src/cli/Command.ts +++ b/packages/effect/src/cli/Command.ts @@ -71,6 +71,7 @@ import * as Prompt from "./Prompt.ts" * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -460,6 +461,7 @@ export type Services = C extends Command< * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -572,6 +574,7 @@ export const isCommand = (u: unknown): u is Command.Any => Predicate.hasProperty * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -684,6 +687,7 @@ export const make: { * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -809,6 +813,7 @@ const normalizeSubcommandEntries = ( * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -1146,6 +1151,7 @@ type ExtractSubcommandContext> * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -1433,6 +1439,7 @@ const mapHandler = ( * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -1630,6 +1637,7 @@ export const provideEffectDiscard: { * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -1755,6 +1763,7 @@ const showUserError = (error: CliError.UserError): Effect.Effect => * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -1843,6 +1852,7 @@ export const run: { * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void diff --git a/packages/effect/src/cli/Flag.ts b/packages/effect/src/cli/Flag.ts index 1d7f619f5bd..f69a586e777 100644 --- a/packages/effect/src/cli/Flag.ts +++ b/packages/effect/src/cli/Flag.ts @@ -290,6 +290,7 @@ export const Directory = (name: string, options?: { * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -630,6 +631,7 @@ export const withHidden = (self: Flag): Flag => Param.withHidden(self) * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -781,6 +783,7 @@ export const map: { * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -838,6 +841,7 @@ export const mapEffect: { * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -1097,6 +1101,7 @@ export const orElse: { * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void diff --git a/packages/effect/src/cli/Param.ts b/packages/effect/src/cli/Param.ts index 5fcc31e2f47..78e37d7c31f 100644 --- a/packages/effect/src/cli/Param.ts +++ b/packages/effect/src/cli/Param.ts @@ -1139,6 +1139,7 @@ const transform = ( * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -1216,6 +1217,7 @@ export const mapEffect: { * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void diff --git a/packages/effect/src/cli/Primitive.ts b/packages/effect/src/cli/Primitive.ts index 5f8a8903361..651b1bc70b3 100644 --- a/packages/effect/src/cli/Primitive.ts +++ b/packages/effect/src/cli/Primitive.ts @@ -45,6 +45,7 @@ const TypeId = "~effect/cli/Primitive" * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -157,6 +158,7 @@ const makeSchemaPrimitive = ( * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -203,6 +205,7 @@ export const Boolean: Primitive = makeSchemaPrimitive( * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -248,6 +251,7 @@ export const Finite: Primitive = makeSchemaPrimitive( * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -293,6 +297,7 @@ export const Int: Primitive = makeSchemaPrimitive( * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -337,6 +342,7 @@ export const Date: Primitive = makeSchemaPrimitive( * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -379,6 +385,7 @@ export const String: Primitive = makePrimitive("String", (value) => Effe * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -470,6 +477,7 @@ export type PathType = "file" | "directory" | "either" * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -560,6 +568,7 @@ export const Path = ( * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -608,6 +617,7 @@ export const Redacted: Primitive> = makePrimitive( * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -718,6 +728,7 @@ const fileParsers: Record unknown> = { * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -795,6 +806,7 @@ export type FileSchemaOptions = Struct.Simplify< * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -862,6 +874,7 @@ export const FileSchema = ( * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void @@ -923,6 +936,7 @@ export const KeyValuePair: Primitive> = makePrimitive( * Layer.succeed(Terminal.Terminal, Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.die("unused"), * readLine: Effect.die("unused"), * display: () => Effect.void diff --git a/packages/effect/src/cli/Prompt.ts b/packages/effect/src/cli/Prompt.ts index 79b18a4c464..f9fcd6c802f 100644 --- a/packages/effect/src/cli/Prompt.ts +++ b/packages/effect/src/cli/Prompt.ts @@ -791,6 +791,7 @@ export declare namespace All { * const terminal = Terminal.make({ * columns: Effect.succeed(80), * rows: Effect.succeed(24), + * size: Effect.die("unused"), * readInput: Effect.succeed({} as never), * readLine: Effect.die("unused"), * display: () => Effect.void diff --git a/packages/effect/test/cli/services/MockTerminal.ts b/packages/effect/test/cli/services/MockTerminal.ts index 32c190de541..c16e2ccf9cf 100644 --- a/packages/effect/test/cli/services/MockTerminal.ts +++ b/packages/effect/test/cli/services/MockTerminal.ts @@ -65,9 +65,16 @@ export const make = Effect.gen(function*() { const readInput: MockTerminal["readInput"] = Effect.succeed(Queue.asDequeue(queue)) + const size: MockTerminal["size"] = Effect.gen(function*() { + const queue = yield* Queue.make() + yield* Queue.offer(queue, { columns: 80, rows: 24 }) + return queue + }) + const terminal = Terminal.make({ columns: Effect.succeed(80), rows: Effect.succeed(24), + size, display, readInput, readLine: Effect.succeed("") diff --git a/packages/platform/node-shared/src/NodeTerminal.ts b/packages/platform/node-shared/src/NodeTerminal.ts index 6a8e21b146a..abfd20a534f 100644 --- a/packages/platform/node-shared/src/NodeTerminal.ts +++ b/packages/platform/node-shared/src/NodeTerminal.ts @@ -90,6 +90,19 @@ export const make: ( const columns = Effect.sync(() => stdout.columns ?? 0) const rows = Effect.sync(() => stdout.rows ?? 0) + const size = Effect.gen(function*() { + const queue = yield* Queue.sliding(1) + const onResize = () => Queue.offerUnsafe(queue, { columns: stdout.columns ?? 0, rows: stdout.rows ?? 0 }) + yield* Effect.addFinalizer(() => + Effect.sync(() => { + stdout.off("resize", onResize) + Queue.endUnsafe(queue) + }) + ) + stdout.on("resize", onResize) + onResize() + return queue + }) const readInput = Effect.gen(function*() { const queue = yield* Queue.make() @@ -159,6 +172,7 @@ export const make: ( return Terminal.make({ columns, rows, + size, readInput, readLine, display diff --git a/packages/platform/node-shared/test/NodeTerminal.test.ts b/packages/platform/node-shared/test/NodeTerminal.test.ts index d4f7c8b2e20..f0794e68d3b 100644 --- a/packages/platform/node-shared/test/NodeTerminal.test.ts +++ b/packages/platform/node-shared/test/NodeTerminal.test.ts @@ -1,8 +1,26 @@ +import * as NodeTerminal from "@effect/platform-node-shared/NodeTerminal" import { assert, describe, it } from "@effect/vitest" import * as Effect from "effect/Effect" +import * as Queue from "effect/Queue" import { spawn, spawnSync } from "node:child_process" import { join } from "node:path" +const resize = (columns: number, rows: number) => + Effect.sync(() => { + Object.assign(process.stdout, { columns, rows }) + process.stdout.emit("resize") + }) + +const mockSize = (columns: number, rows: number) => + Effect.acquireRelease( + Effect.sync(() => { + const original = { columns: process.stdout.columns, rows: process.stdout.rows } + Object.assign(process.stdout, { columns, rows }) + return original + }), + (original) => Effect.sync(() => Object.assign(process.stdout, original)) + ) + const fixture = join(__dirname, "fixtures", "node-terminal.ts") const runFixture = (mode: string, input: string) => @@ -126,4 +144,26 @@ describe("NodeTerminal", { concurrent: false, timeout: 15_000 }, () => { "line\n", "{\"line\":\"line\",\"duringTtl\":1,\"dataListeners\":0}" )) + + it.effect("size offers the current size, then only the latest resize", () => + Effect.gen(function*() { + yield* mockSize(80, 24) + const terminal = yield* NodeTerminal.make() + const sizes = yield* terminal.size + assert.deepStrictEqual(yield* Queue.take(sizes), { columns: 80, rows: 24 }) + yield* resize(100, 30) + yield* resize(120, 50) + assert.deepStrictEqual(yield* Queue.takeAll(sizes), [{ columns: 120, rows: 50 }]) + })) + + it.effect("size removes its resize listener when the scope closes", () => + Effect.gen(function*() { + const terminal = yield* NodeTerminal.make() + const listeners = process.stdout.listenerCount("resize") + yield* terminal.size.pipe( + Effect.tap(() => Effect.sync(() => assert.strictEqual(process.stdout.listenerCount("resize"), listeners + 1))), + Effect.scoped + ) + assert.strictEqual(process.stdout.listenerCount("resize"), listeners) + })) })