vt100.js 0.2.0 → 0.2.2

package/README.md

@@ -2,10 +2,12 @@
 
 Pure TypeScript VT100 terminal emulator. Zero dependencies, headless, fast.
 
+Part of the [vterm](https://github.com/beorn/vterm) monorepo.
+
 ## Features
 
 - Full VT100/ANSI escape sequence parsing
-- SGR attributes (bold, italic, underline, colors, etc.)
+- SGR attributes (bold, italic, underline styles, colors, strikethrough, etc.)
 - 16-color, 256-color, and 24-bit truecolor support
 - Cursor movement, save/restore (DECSC/DECRC)
 - Screen modes (alternate screen, auto-wrap, origin mode, etc.)
@@ -13,18 +15,7 @@ Pure TypeScript VT100 terminal emulator. Zero dependencies, headless, fast.
 - Scrollback buffer with configurable limit
 - Insert/delete characters and lines
 - Wide character support (CJK, emoji)
-- Zero dependencies -- works in Bun, Node.js, and browsers
-
-## Comparison
-
-| Package                   | Screen State | SGR Colors  | Scrollback | Wide Chars | Zero Deps |     Size     |
-| ------------------------- | :----------: | :---------: | :--------: | :--------: | :-------: | :----------: |
-| **vt100.js**              |     yes      | 16/256/true |    yes     |    yes     |    yes    |    ~30KB     |
-| `@xterm/headless`         |     yes      | 16/256/true |    yes     |    yes     |    no     |    ~500KB    |
-| `node-pty` + xterm        |     yes      | 16/256/true |    yes     |    yes     |    no     | native build |
-| `ansi-parser`             |      no      | parse only  |     no     |     no     |    yes    |     ~5KB     |
-| `terminal-kit`            |     yes      | 16/256/true |     no     |  partial   |    no     |     ~2MB     |
-| `blessed` / `neo-blessed` |     yes      |   16/256    |     no     |     no     |    no     |     ~1MB     |
+- Zero dependencies — works in Bun, Node.js, and browsers
 
 ## Install
 
@@ -40,91 +31,63 @@ import { createVt100Screen } from "vt100.js"
 const screen = createVt100Screen({ cols: 80, rows: 24 })
 screen.process(new TextEncoder().encode("Hello, \x1b[1mBold\x1b[0m World!"))
 
-// Read cell state
-const cell = screen.getCell(0, 0)
-console.log(cell.char) // "H"
-
-// Read text
 console.log(screen.getText()) // "Hello, Bold World!"
-
-// Check cursor position
-const pos = screen.getCursorPosition()
-console.log(pos) // { x: 18, y: 0 }
+console.log(screen.getCell(0, 7).bold) // true
+console.log(screen.getCursorPosition()) // { x: 18, y: 0 }
 ```
 
 ## API
 
 ### `createVt100Screen(options)`
 
-Create a new screen instance.
-
-```typescript
-const screen = createVt100Screen({
-  cols: 80, // terminal width
-  rows: 24, // terminal height
-  scrollbackLimit: 1000, // max scrollback lines (default: 1000)
-})
-```
+| Option            | Type     | Default  | Description          |
+| ----------------- | -------- | -------- | -------------------- |
+| `cols`            | `number` | required | Terminal width       |
+| `rows`            | `number` | required | Terminal height      |
+| `scrollbackLimit` | `number` | `1000`   | Max scrollback lines |
 
 ### Screen methods
 
-| Method                                             | Description                                               |
-| -------------------------------------------------- | --------------------------------------------------------- |
-| `process(data: Uint8Array)`                        | Feed raw terminal data                                    |
-| `getText()`                                        | Get all text (scrollback + screen)                        |
-| `getTextRange(startRow, startCol, endRow, endCol)` | Get text in a range                                       |
-| `getLine(row)`                                     | Get cells for a row                                       |
-| `getCell(row, col)`                                | Get a single cell (char, fg, bg, bold, etc.)              |
-| `getCursorPosition()`                              | Get cursor `{ x, y }`                                     |
-| `getCursorVisible()`                               | Check cursor visibility                                   |
-| `getMode(mode)`                                    | Check terminal mode (`altScreen`, `bracketedPaste`, etc.) |
-| `getTitle()`                                       | Get window title (set via OSC 0/2)                        |
-| `getScrollbackLength()`                            | Number of scrollback lines                                |
-| `getViewportOffset()`                              | Current viewport scroll offset                            |
-| `scrollViewport(delta)`                            | Scroll viewport by delta lines                            |
-| `resize(cols, rows)`                               | Resize the terminal                                       |
-| `reset()`                                          | Reset to initial state                                    |
+| Method                         | Description                        |
+| ------------------------------ | ---------------------------------- |
+| `process(data: Uint8Array)`    | Feed raw terminal data             |
+| `getText()`                    | Get all text (scrollback + screen) |
+| `getTextRange(sr, sc, er, ec)` | Get text in a range                |
+| `getLine(row)`                 | Get cells for a row                |
+| `getCell(row, col)`            | Get a single cell                  |
+| `getCursorPosition()`          | Get cursor `{ x, y }`              |
+| `getCursorVisible()`           | Check cursor visibility            |
+| `getMode(mode)`                | Check terminal mode                |
+| `getTitle()`                   | Get window title                   |
+| `getScrollbackLength()`        | Number of scrollback lines         |
+| `getViewportOffset()`          | Current viewport scroll offset     |
+| `scrollViewport(delta)`        | Scroll viewport                    |
+| `resize(cols, rows)`           | Resize terminal                    |
+| `reset()`                      | Reset to initial state             |
 
 ### Cell properties
 
 ```typescript
 interface ScreenCell {
-  char: string // character content
-  fg: CellColor | null // foreground color { r, g, b }
-  bg: CellColor | null // background color { r, g, b }
+  char: string
+  fg: CellColor | null // { r, g, b }
+  bg: CellColor | null
   bold: boolean
   faint: boolean
   italic: boolean
-  underline: UnderlineStyle // "none" | "single" | "double" | "curly" | "dotted" | "dashed"
+  underline: "none" | "single" | "double" | "curly" | "dotted" | "dashed"
   strikethrough: boolean
   inverse: boolean
   hidden: boolean
-  wide: boolean // true for CJK/emoji double-width chars
+  wide: boolean
 }
 ```
 
-### Terminal modes
-
-Queryable via `screen.getMode(mode)`:
-
-- `altScreen` -- alternate screen buffer
-- `bracketedPaste` -- bracketed paste mode
-- `mouseTracking` -- mouse tracking
-- `autoWrap` -- auto-wrap at right margin (default: on)
-- `applicationCursor` -- application cursor keys
-- `applicationKeypad` -- application keypad mode
-- `originMode` -- origin mode
-- `insertMode` -- insert mode
-- `reverseVideo` -- reverse video
-- `focusTracking` -- focus tracking
-- `cursorVisible` -- cursor visibility
-
-## Ecosystem
+## See also
 
-- [Termless](https://termless.dev) -- headless terminal testing (uses vt100.js as its default backend)
-- [Terminfo.dev](https://terminfo.dev) -- terminal feature support tables
-- [Silvery](https://silvery.dev) -- React TUI framework
-- [@termless/vt100](https://github.com/beorn/termless) -- Termless backend wrapper for vt100.js
+- [vterm.js](../vterm/) — full-featured modern emulator (100% terminfo.dev coverage)
+- [Termless](https://termless.dev) — headless terminal testing
+- [Terminfo.dev](https://terminfo.dev) — terminal feature support tables
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vt100.js",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Pure TypeScript VT100 terminal emulator. Zero dependencies, headless, fast.",
   "keywords": [
     "ansi",
@@ -11,26 +11,25 @@
     "vt100",
     "zero-dependency"
   ],
-  "homepage": "https://github.com/beorn/vt100",
-  "bugs": "https://github.com/beorn/vt100/issues",
+  "homepage": "https://github.com/beorn/vterm/tree/main/packages/vt100",
+  "bugs": "https://github.com/beorn/vterm/issues",
   "license": "MIT",
   "author": "Beorn",
-  "repository": "github:beorn/vt100",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/beorn/vterm.git",
+    "directory": "packages/vt100"
+  },
+  "files": [
+    "src"
+  ],
   "type": "module",
   "exports": {
     ".": "./src/index.ts"
   },
-  "files": ["src"],
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {
-    "test": "vitest run",
-    "typecheck": "tsc --noEmit"
-  },
-  "devDependencies": {
-    "vitest": "^4.0.0"
-  },
   "engines": {
     "node": ">=23.6.0"
   }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2026 Beorn
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.