Add rows and isTTY to Terminal (#5977)

Author: scotttrinh

.changeset/large-cobras-jump.md

@@ -0,0 +1,8 @@
+---
+"@effect/platform-node-shared": patch
+"@effect/platform": patch
+"@effect/platform-bun": patch
+"@effect/platform-node": patch
+---
+
+Added `rows` and `isTTY` properties to `Terminal`

packages/cli/test/services/MockTerminal.ts

@@ -64,6 +64,8 @@ export const make = Effect.gen(function*() {
 
   return MockTerminal.of({
     columns: Effect.succeed(80),
+    rows: Effect.succeed(24),
+    isTTY: Effect.succeed(true),
     display,
     readInput,
     readLine: Effect.succeed(""),

packages/platform-node-shared/src/internal/terminal.ts

@@ -41,6 +41,8 @@ export const make = Effect.fnUntraced(function*(
   })
 
   const columns = Effect.sync(() => stdout.columns ?? 0)
+  const rows = Effect.sync(() => stdout.rows ?? 0)
+  const isTTY = Effect.sync(() => Boolean(stdout.isTTY))
 
   const readInput = Effect.gen(function*() {
     yield* RcRef.get(rlRef)
@@ -90,6 +92,8 @@ export const make = Effect.fnUntraced(function*(
 
   return Terminal.Terminal.of({
     columns,
+    rows,
+    isTTY,
     readInput,
     readLine,
     display

packages/platform-node-shared/test/Terminal.test.ts

@@ -0,0 +1,32 @@
+import * as NodeTerminal from "@effect/platform-node-shared/NodeTerminal"
+import * as Terminal from "@effect/platform/Terminal"
+import { describe, expect, it } from "@effect/vitest"
+import * as Effect from "effect/Effect"
+
+const runPromise = <E, A>(self: Effect.Effect<A, E, Terminal.Terminal>) =>
+  Effect.runPromise(
+    Effect.provide(self, NodeTerminal.layer)
+  )
+
+describe("Terminal", () => {
+  it("columns", () =>
+    runPromise(Effect.gen(function*() {
+      const terminal = yield* Terminal.Terminal
+      const columns = yield* terminal.columns
+      expect(typeof columns).toEqual("number")
+    })))
+
+  it("rows", () =>
+    runPromise(Effect.gen(function*() {
+      const terminal = yield* Terminal.Terminal
+      const rows = yield* terminal.rows
+      expect(typeof rows).toEqual("number")
+    })))
+
+  it("isTTY", () =>
+    runPromise(Effect.gen(function*() {
+      const terminal = yield* Terminal.Terminal
+      const isTTY = yield* terminal.isTTY
+      expect(typeof isTTY).toEqual("boolean")
+    })))
+})

packages/platform/src/Terminal.ts

@@ -22,6 +22,14 @@ export interface Terminal {
    * The number of columns available on the platform's terminal interface.
    */
   readonly columns: Effect<number>
+  /**
+   * The number of rows available on the platform's terminal interface.
+   */
+  readonly rows: Effect<number>
+  /**
+   * Determines if the current terminal interface is interactive.
+   */
+  readonly isTTY: Effect<boolean>
   /**
    * Reads input events from the default standard input.
    */