Add Monaco diff-view, the saga ...
I set out to use Monaco to support the diff view. diff2html is lovely,
but there were a ton of usability improvements I wanted to make (line
numbers not making things double spaced, choosing which diff, editing
the right-hand side), and it seemed a dead end. Furthermore, Phabricator
and Gerrit's experience is that diffs should be shown file by file,
because you'll inevitably see a diff with a file that's too large, and
the GitHub PR view often breaks on big changes... so I wanted to show
files diff-by-diff, with "infinite" context when unchanged sections are
expanded. So...
Ultimately, all of this was sketch-coded over maybe 30 Sketch sessions.
I threw away a lot of branches. My git reflog is a superfund site.
Prompting whole-hog didn't work. Or, rather, it made significant
progress, but something very serious wouldn't work, and I couldn't
figure out what, and nor could Sketch.
Instead, I started by adding a new webcomponent that was just a
placeholder. Then, using https://rodydavis.com/posts/lit-monaco-editor,
I nudged Sketch into adding Monaco to it. Sketch pulled out:
You're right, I should properly read the blog post before implementing the
solution. Let me check the referenced blog post.
I worked heavily in the demo environment at first, but here I ran into
the issue that we have two different esbuild systems: one is vite and
one is esbuild.go, and they're configured differently enough.
Monaco is unusable and confusingly so when its CSS isn't loaded. The right
way to load it, I've found, is via
@import url('./static/monaco/min/vs/editor/editor.main.css');
I spent more time than I care to admit noticing that originally
this wasn't relative, and when we use a skaband setting, the
paths need to be relative-aware.
The paths to the various workers need to be similarly correctly placed.
Getting Sketch to build demo data but not put testing code into production
code was tricky. (I threw away a lot of efforts and factories and singletons...)
When I set out to do the git commit selection, I wanted to do a bunch of
backend /git/* handlers. These were easy enough to code in sketch. I had
to convince Sketch to put them in git_tools.go and not in the agent.
It doesn't really matter: these functions to parse git are pretty stateless,
but it's less work to have them separate. Sketch was mediocre at writing
tests for them. Did you know that our container has an older version
of git that doesn't have the same options to decorate ref names? Yeah, nor did
I.
Handling unstaged changes was fun. git diff --raw shows unstaged files
as having identity 0000. Ideally we'd be using jj and there'd be
a synthetic commit, but instead uncommitted-possible files are read
by content.
A real big challenge was getting the Monaco view to use the right vertical and
horizontal space. I did this many, many times. I don't claim to understand flex
and the virtual dom, and :host, and all the interactions. It would fix one
thing and break another. The chat window would shrink. The terminal would
shrink.
Screenshot support was excellent. I eventually added paste support just so
that I could expedite my workflow, and Sketch coded that easily on the first
pass with minor feedback.
I learned the hard way that Safari's support for WebComponents/shadow
dom in its web inspector is rough. See https://fediverse.zachleat.com/@zachleat/114518629612122858
I also learned the hard way that Chrome doesn't use fonts loaded in CSS
in a shadow dom. That's why the codicon font had to be in the global
style sheet.
Kudos to John Reese who kindly allowed me, a long time ago, to adapt a
shell script he had at work to look over diffs into https://github.com/philz/git-vimdiff.
That's the inspiration for having the "new code" be editable when you're
reviewing it; why shouldn't it be!?!
There are a handful of follow up tasks:
* We lose state when we switch to the Chat view and back.
* Need URL-based support for where we are.
* Maybe need shortcut keys to move between diffs and changes.
* Maybe need caching or look-ahead for downloading the next or previous
file.
* We spend too much vertical real estate on all the diff selections;
could we scroll it out of the way, collapse it, tighten it, etc.
* The workers sometimes throw errors into the console. I think they're
harmless and merely need to be caught and suppressed.
* Needing to commit changes when things are saved is weird. Should we
commit automatically? Amend the previous commit? Have a button for
that? Show the git dirty state?
* Our JS bundle is big. We could maybe delay loading the monaco bundle
to help.
Thanks for coming to my TED talk.
diff --git a/webui/src/web-components/sketch-app-shell.ts b/webui/src/web-components/sketch-app-shell.ts
index 7436671..aebabd9 100644
--- a/webui/src/web-components/sketch-app-shell.ts
+++ b/webui/src/web-components/sketch-app-shell.ts
@@ -1,13 +1,17 @@
import { css, html, LitElement } from "lit";
import { customElement, property, state } from "lit/decorators.js";
import { ConnectionStatus, DataManager } from "../data";
-import { AgentMessage, GitCommit, State } from "../types";
+import { AgentMessage, GitLogEntry, State } from "../types";
import { aggregateAgentMessages } from "./aggregateAgentMessages";
import "./sketch-chat-input";
import "./sketch-container-status";
import "./sketch-diff-view";
import { SketchDiffView } from "./sketch-diff-view";
+import "./sketch-diff2-view";
+import { SketchDiff2View } from "./sketch-diff2-view";
+import { DefaultGitDataService } from "./git-data-service";
+import "./sketch-monaco-view";
import "./sketch-network-status";
import "./sketch-call-status";
import "./sketch-terminal";
@@ -18,13 +22,13 @@
import { createRef, ref } from "lit/directives/ref.js";
import { SketchChatInput } from "./sketch-chat-input";
-type ViewMode = "chat" | "diff" | "terminal";
+type ViewMode = "chat" | "diff" | "diff2" | "terminal";
@customElement("sketch-app-shell")
export class SketchAppShell extends LitElement {
// Current view mode (chat, diff, terminal)
@state()
- viewMode: "chat" | "diff" | "terminal" = "chat";
+ viewMode: ViewMode = "chat";
// Current commit hash for diff view
@state()
@@ -119,14 +123,21 @@
align-self: stretch;
overflow-y: auto;
flex: 1;
+ display: flex;
+ flex-direction: column;
+ min-height: 0; /* Critical for proper flex child behavior */
}
#view-container-inner {
max-width: 1200px;
+ width: calc(100% - 40px);
margin: 0 auto;
position: relative;
padding-bottom: 10px;
padding-top: 10px;
+ display: flex;
+ flex-direction: column;
+ height: 100%; /* Ensure it takes full height of parent */
}
#chat-input {
@@ -157,18 +168,44 @@
text-overflow: ellipsis;
}
- /* Allow the container to expand to full width in diff mode */
- #view-container-inner.diff-active {
+ /* Allow the container to expand to full width and height in diff mode */
+ #view-container-inner.diff-active,
+ #view-container-inner.diff2-active {
max-width: 100%;
width: 100%;
+ height: 100%;
+ padding: 0; /* Remove padding for more space */
+ display: flex;
+ flex-direction: column;
+ flex: 1;
+ min-height: 0; /* Critical for flex behavior */
}
/* Individual view styles */
.chat-view,
.diff-view,
+ .diff2-view,
.terminal-view {
display: none; /* Hidden by default */
width: 100%;
+ height: 100%;
+ }
+
+ /* Make chat view take full width available */
+ .chat-view.view-active {
+ display: flex;
+ flex-direction: column;
+ width: 100%;
+ }
+
+ /* Monaco diff2 view needs to take all available space */
+ .diff2-view.view-active {
+ flex: 1;
+ overflow: hidden;
+ min-height: 0; /* Required for proper flex child behavior */
+ display: flex;
+ flex-direction: column;
+ height: 100%;
}
/* Active view styles - these will be applied via JavaScript */
@@ -472,7 +509,7 @@
}
}
- updateUrlForViewMode(mode: "chat" | "diff" | "terminal"): void {
+ updateUrlForViewMode(mode: ViewMode): void {
// Get the current URL without search parameters
const url = new URL(window.location.href);
@@ -508,7 +545,7 @@
* Handle view mode selection event
*/
private _handleViewModeSelect(event: CustomEvent) {
- const mode = event.detail.mode as "chat" | "diff" | "terminal";
+ const mode = event.detail.mode as "chat" | "diff" | "diff2" | "terminal";
this.toggleViewMode(mode, true);
}
@@ -526,6 +563,11 @@
window.console.log("_handleMultipleChoice", event);
this._sendChat;
}
+
+ private _handleDiffComment(event: CustomEvent) {
+ // Empty stub required by the event binding in the template
+ // Actual handling occurs at global level in sketch-chat-input component
+ }
/**
* Listen for commit diff event
* @param commitHash The commit hash to show diff for
@@ -534,16 +576,12 @@
// Store the commit hash
this.currentCommitHash = commitHash;
- // Switch to diff view
- this.toggleViewMode("diff", true);
+ this.toggleViewMode("diff2", true);
- // Wait for DOM update to complete
this.updateComplete.then(() => {
- // Get the diff view component
- const diffView = this.shadowRoot?.querySelector("sketch-diff-view");
- if (diffView) {
- // Call the showCommitDiff method
- (diffView as any).showCommitDiff(commitHash);
+ const diff2View = this.shadowRoot?.querySelector("sketch-diff2-view");
+ if (diff2View) {
+ (diff2View as SketchDiff2View).refreshDiffView();
}
});
}
@@ -571,19 +609,25 @@
);
const chatView = this.shadowRoot?.querySelector(".chat-view");
const diffView = this.shadowRoot?.querySelector(".diff-view");
-
+ const diff2View = this.shadowRoot?.querySelector(".diff2-view");
const terminalView = this.shadowRoot?.querySelector(".terminal-view");
// Remove active class from all views
chatView?.classList.remove("view-active");
diffView?.classList.remove("view-active");
+ diff2View?.classList.remove("view-active");
terminalView?.classList.remove("view-active");
// Add/remove diff-active class on view container
if (mode === "diff") {
viewContainerInner?.classList.add("diff-active");
+ viewContainerInner?.classList.remove("diff2-active");
+ } else if (mode === "diff2") {
+ viewContainerInner?.classList.add("diff2-active");
+ viewContainerInner?.classList.remove("diff-active");
} else {
viewContainerInner?.classList.remove("diff-active");
+ viewContainerInner?.classList.remove("diff2-active");
}
// Add active class to the selected view
@@ -602,6 +646,16 @@
(diffViewComp as any).loadDiffContent();
}
break;
+
+ case "diff2":
+ diff2View?.classList.add("view-active");
+ // Refresh git/recentlog when Monaco diff view is opened
+ // This ensures branch information is always up-to-date, as branches can change frequently
+ const diff2ViewComp = this.shadowRoot?.querySelector("sketch-diff2-view");
+ if (diff2ViewComp) {
+ (diff2ViewComp as SketchDiff2View).refreshDiffView();
+ }
+ break;
case "terminal":
terminalView?.classList.add("view-active");
@@ -997,6 +1051,16 @@
.commitHash=${this.currentCommitHash}
></sketch-diff-view>
</div>
+
+ <div
+ class="diff2-view ${this.viewMode === "diff2" ? "view-active" : ""}"
+ >
+ <sketch-diff2-view
+ .commit=${this.currentCommitHash}
+ .gitService=${new DefaultGitDataService()}
+ @diff-comment="${this._handleDiffComment}"
+ ></sketch-diff2-view>
+ </div>
<div
class="terminal-view ${this.viewMode === "terminal"
@@ -1005,6 +1069,7 @@
>
<sketch-terminal></sketch-terminal>
</div>
+
</div>
</div>