Add design doc for dirview, a lightweight local directory viewer server - #2
Open
talkasab wants to merge 5 commits into
Open
Add design doc for dirview, a lightweight local directory viewer server#2talkasab wants to merge 5 commits into
talkasab wants to merge 5 commits into
Conversation
Research and design (no implementation) for a single-file web server that serves a two-pane directory browser with GitHub-flavored markdown, Shiki code highlighting, git status/diff integration, live file watching, and Catppuccin Latte/Mocha theming. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DJieA2dNDXVv7P3Q6HpCNB
…repo - Switch server from Python/Starlette to Node (Hono + chokidar), since all rendering deps are npm-native and npx is the natural distribution channel - Replace whole-page diff view with in-place per-hunk expansion panels - Restructure as a standalone repository layout Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DJieA2dNDXVv7P3Q6HpCNB
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DJieA2dNDXVv7P3Q6HpCNB
Bun.serve replaces Hono, bun build replaces esbuild, and bun build --compile adds standalone per-platform binaries; chokidar remains the sole server dependency due to Bun native watcher reliability gaps. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DJieA2dNDXVv7P3Q6HpCNB
There was a problem hiding this comment.
Pull request overview
Adds a design-only document describing “peruse”, a lightweight local directory viewer web server concept (two-pane tree + rendered file view) intended to live in a separate repository later.
Changes:
- Introduces a requirements list and surveys existing tools that partially cover the desired UX.
- Proposes a Bun-based architecture with client-side rendering (markdown-it + Shiki + diff2html) and server-side git/file/SSE APIs.
- Documents endpoint shapes, hunk metadata format, and interaction model for inline per-hunk diffs.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+1
to
+5
| # peruse — Design for a Lightweight Local Directory Viewer | ||
|
|
||
| **Status:** Design only — not yet implemented. Will live in its own repository; | ||
| this copy is parked here while the design is being discussed. | ||
|
|
Comment on lines
+226
to
+228
| - **Code files:** a 3px vertical bar in the gutter beside each hunk's | ||
| `newStart..newStart+newLines` — Catppuccin green for added, yellow for | ||
| modified — plus a small red triangle marker where lines were deleted. |
Comment on lines
+65
to
+67
| An earlier draft proposed a Python/Starlette single-file server (anchored on | ||
| the host repo's uv tooling — see §7), then Node. Bun is the better fit for | ||
| the "as little code as possible" constraint: |
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DJieA2dNDXVv7P3Q6HpCNB
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.
Research and design (no implementation) for a single-file web server that
serves a two-pane directory browser with GitHub-flavored markdown, Shiki
code highlighting, git status/diff integration, live file watching, and
Catppuccin Latte/Mocha theming.
Co-Authored-By: Claude Fable 5 noreply@anthropic.com
Claude-Session: https://claude.ai/code/session_01DJieA2dNDXVv7P3Q6HpCNB