Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/terminal-size.md
Original file line number Diff line number Diff line change
@@ -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`.
20 changes: 19 additions & 1 deletion packages/effect/src/Terminal.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@ export interface Terminal {
*/

readonly rows: Effect.Effect<number>
/**
* 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<Queue.Dequeue<Size, Cause.Done>, never, Scope.Scope>
/**
* Reads input events from the default standard input.
*/
Expand All @@ -56,6 +62,18 @@ export interface Terminal {
readonly display: (text: string) => Effect.Effect<void, PlatformError>
}

/**
* 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.
Expand Down Expand Up @@ -183,7 +201,7 @@ export const Terminal: Context.Service<Terminal, Terminal> = 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.
*
Expand Down
2 changes: 2 additions & 0 deletions packages/effect/src/cli/Argument.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
10 changes: 10 additions & 0 deletions packages/effect/src/cli/Command.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -460,6 +461,7 @@ export type Services<C> = 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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -1146,6 +1151,7 @@ type ExtractSubcommandContext<T extends ReadonlyArray<Command.SubcommandEntry>>
* 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
Expand Down Expand Up @@ -1433,6 +1439,7 @@ const mapHandler = <Name extends string, Input, E, R, ContextInput, E2, R2>(
* 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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -1755,6 +1763,7 @@ const showUserError = (error: CliError.UserError): Effect.Effect<void> =>
* 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
Expand Down Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions packages/effect/src/cli/Flag.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -630,6 +631,7 @@ export const withHidden = <A>(self: Flag<A>): Flag<A> => 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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions packages/effect/src/cli/Param.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1139,6 +1139,7 @@ const transform = <Kind extends ParamKind, A, B>(
* 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
Expand Down Expand Up @@ -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
Expand Down
14 changes: 14 additions & 0 deletions packages/effect/src/cli/Primitive.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -157,6 +158,7 @@ const makeSchemaPrimitive = <T>(
* 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
Expand Down Expand Up @@ -203,6 +205,7 @@ export const Boolean: Primitive<boolean> = 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
Expand Down Expand Up @@ -248,6 +251,7 @@ export const Finite: Primitive<number> = 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
Expand Down Expand Up @@ -293,6 +297,7 @@ export const Int: Primitive<number> = 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
Expand Down Expand Up @@ -337,6 +342,7 @@ export const Date: Primitive<globalThis.Date> = 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
Expand Down Expand Up @@ -379,6 +385,7 @@ export const String: Primitive<string> = 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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -608,6 +617,7 @@ export const Redacted: Primitive<Redacted_.Redacted<string>> = 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
Expand Down Expand Up @@ -718,6 +728,7 @@ const fileParsers: Record<string, (content: string) => 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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -862,6 +874,7 @@ export const FileSchema = <A>(
* 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
Expand Down Expand Up @@ -923,6 +936,7 @@ export const KeyValuePair: Primitive<Record<string, string>> = 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
Expand Down
1 change: 1 addition & 0 deletions packages/effect/src/cli/Prompt.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 7 additions & 0 deletions packages/effect/test/cli/services/MockTerminal.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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<Terminal.Size, Cause.Done>()
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("")
Expand Down
14 changes: 14 additions & 0 deletions packages/platform/node-shared/src/NodeTerminal.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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<Terminal.Size, Cause.Done>(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<Terminal.UserInput, Cause.Done>()
Expand Down Expand Up @@ -159,6 +172,7 @@ export const make: (
return Terminal.make({
columns,
rows,
size,
readInput,
readLine,
display
Expand Down
Loading
Loading