05: Update documentation for Bun 1.4 migration - #164
Merged
shouze merged 2 commits intoAug 23, 2026
Conversation
|
Coverage after merging feat/bun14-terminal/05-docs into feat/bun14-terminal/04-sigwinch will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
🔦 Lighthouse Report
|
shouze
force-pushed
the
feat/bun14-terminal/05-docs
branch
from
August 23, 2026 15:45
bc1ef49 to
d6ceda7
Compare
|
Coverage after merging feat/bun14-terminal/05-docs into feat/bun14-terminal/04-sigwinch will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
1 similar comment
|
Coverage after merging feat/bun14-terminal/05-docs into feat/bun14-terminal/04-sigwinch will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Contributor
There was a problem hiding this comment.
Pull request overview
Updates project documentation to reflect the Bun 1.4 migration and to document terminal/TTY behaviors and the new terminal API wrapper module in the architecture docs.
Changes:
- Add explicit runtime/token requirements to the README.
- Expand architecture documentation with SIGWINCH-based resize handling details.
- Update architecture/component and agent docs to include the
src/render/terminal.tswrapper and Bun ≥ 1.4 requirement.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Adds a “Requirements” section describing Bun version and GitHub token scope expectations. |
| docs/architecture/containers.md | Documents live terminal resize handling via SIGWINCH in the TUI flow description. |
| docs/architecture/components.md | Adds src/render/terminal.ts to the render-layer component diagram and table. |
| AGENTS.md | Updates Bun minimum version and documents render/terminal.ts as the sole Bun ANSI API call site. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| ## Requirements | ||
|
|
||
| - **Bun** ≥ 1.4 (runtime and package manager) | ||
| - **GitHub Token** with `repo` and `read:org` scopes |
| 4. If dimensions have changed, the handler calls `redraw()` to re-render with the new layout. | ||
| 5. The user sees an immediate, flicker-free refresh without needing to press any key. | ||
|
|
||
| When the **TUI** exits (via Ctrl+C, `q`, `Enter`, or `Esc`), the handler is unregistered via `process.off("SIGWINCH", onResize)` to ensure clean cleanup. The **Terminal API wrapper** (`src/render/terminal.ts`) uses `Bun.stringWidth()`, `Bun.stripANSI()`, and `Bun.sliceAnsi()` to measure and truncate text accurately, accounting for emoji, CJK characters, and multi-code-point grapheme clusters. |
|
Coverage after merging feat/bun14-terminal/05-docs into feat/bun14-terminal/04-sigwinch will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- Update AGENTS.md: Bun >= 1.4 requirement, add terminal.ts module description - Add architectural rule: terminal.ts is sole Bun API call site - Update README.md: Add Requirements section with Bun >= 1.4 and GitHub Token scopes - Update docs/architecture/components.md: Add Terminal API wrapper component - Update docs/architecture/containers.md: Add Terminal resizing section documenting SIGWINCH handler, live redraw, and Bun.Terminal clarification - Document Unicode handling: emoji, CJK, grapheme clusters Fixes: #145
shouze
force-pushed
the
feat/bun14-terminal/05-docs
branch
from
August 23, 2026 16:05
142f124 to
0a6f035
Compare
|
Coverage after merging feat/bun14-terminal/05-docs into feat/bun14-terminal/04-sigwinch will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
1 similar comment
|
Coverage after merging feat/bun14-terminal/05-docs into feat/bun14-terminal/04-sigwinch will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
How did you verify your code works?