Herb: Introduce Herb Dev Server and @herb-tools/client#1662
Merged
Conversation
commit: |
🌿 Interactive Playground and Documentation PreviewA preview deployment has been built for this pull request. Try out the changes live in the interactive playground: 🌱 Grown from commit ✅ Preview deployment has been cleaned up. |
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.
This pull request introduces the Herb Dev Server and the
@herb-tools/clientpackage, a WebSocket-based file watching system that enables real-time template hot-reloading during development, heavily inspired by webpack-dev-server and Vite.Warning
The dev server is experimental and may not work correctly in all cases.
How It Works
The
herb devcommand starts a WebSocket server that watches template files for changes. When a template is saved, it diffs the old and new Syntax Tree using the Herb diff engine and either:The client connects automatically when
herb-debug-modeis enabled in the page and applies patches by matching text content or attribute values within the template's root element ([data-herb-debug-file-relative-path]).Architecture
Server (
lib/herb/dev/server.rb):~/.herb/dev-servers/{pid}.jsonfor multi-server coordinationClient (
javascript/packages/client/):HerbClientmessage handling, connection lifecycleConnectionWebSocket management with exponential backoff reconnectionpatch.tsDOM patching via content-based element matchingConnectionDotvisual connection status indicatorToast/MismatchAlertuser feedback componentsProtocol messages:
welcomehandshake with project path validationpatchincremental text/attribute updatesreloadstructural changes requiring page reloaderror/fixedparse error notificationsUsage
The CLI shows whether each change was patched in place (
✓ green) or triggered a reload (↻ amber), along with the operation details.Demo
Tropical.on.Rails.2026.mov
Tropical.on.Rails.20262.mov