The IDE you know, rebuilt in Rust. IntelliJ IDEA–style keymap, tool windows and search-everywhere in a fast native app: editor, code insight, debugger, Git, terminal, database and HTTP clients for 60+ languages.
TypeScript code-editorcross-platformdapdatabase-clientdebuggerdesktop-appdeveloper-toolsgithttp-clientideintellijlsprusttauriterminal
/**
* Back / Forward navigation history (⌘[ / ⌘]), like IDEA's:
* `entries[index]` is the current place, kept up to
* date while the caret moves. Only a navigation (a file switch, a mouse click,
* a jump to a declaration / usage / search result / line …) that changes the
* caret line leaves the previous place behind as a back entry and drops the
* forward stack; typing, arrows and paging don't. A back entry within
* `MERGE_LINES` of the one before it replaces it.
*/
import type { Transaction } from "@codemirror/state";
import type { NavigationLocation } from "@/editor/api";
export const MERGE_LINES = 4;
/** userEvent of in-file navigation commands (method up / down, code block start / end…). */
export const NAVIGATE_EVENT = "select.navigate";
/** Caret moves that count as navigation: mouse clicks, find, reveals, stripe / sticky-line clicks, navigate commands. */
export function isNavigation(tr: Transaction): boolean {
return ["select.pointer", "select.reveal", "select.search", "select.overview", "select.sticky", NAVIGATE_EVENT].some(
(e) => tr.isUserEvent(e),
);
}
const MAX_ENTRIES = 100;
const samePlace = (a: Omit<NavigationLocation, "time">, b: Omit<NavigationLocation, "time">) =>
a.path === b.path && Math.abs(a.line - b.line) < MERGE_LINES;
export class NavigationHistory {
entries: NavigationLocation[] = [];
index = -1;
private listeners = new Set<() => void>();
constructor(private now: () => number = Date.now) {}
get current(): NavigationLocation | null {
return this.entries[this.index] ?? null;
}
canGoBack() {
return this.index > 0;
}
canGoForward() {
return this.index < this.entries.length - 1;
}
/**
* Records the caret position. `navigation`: the move came from a navigation
* command; a file switch always counts as one.
*/
update(loc: Omit<NavigationLocation, "time">, navigation = false) {
const entry = { ...loc, time: this.now() };
const cur = this.current;
if (!cur) {
this.entries = [entry];
this.index = 0;
this.emit();
return;
}
const switched = cur.path !== loc.path;
if (!switched && (!navigation || cur.line === loc.line)) {
this.entries[this.index] = entry;
return;
}
// The place we leave becomes a back entry, merged with a close one before it.
this.entries = this.entries.slice(0, this.index + 1);
const prev = this.entries[this.index - 1];
if (prev && samePlace(prev, cur)) this.entries.splice(this.index - 1, 1);
this.entries.push(entry);
if (this.entries.length > MAX_ENTRIES) this.entries.splice(0, this.entries.length - MAX_ENTRIES);
this.index = this.entries.length - 1;
this.emit();
}
/** Moves back; returns the location to navigate to. */
back(): NavigationLocation | null {
if (!this.canGoBack()) return null;
this.index--;
this.emit();
return this.current;
}
forward(): NavigationLocation | null {
if (!this.canGoForward()) return null;
this.index++;
this.emit();
return this.current;
}
/** Drops entries of a deleted file. */
removePath(path: string) {
const before = this.entries.length;
const cur = this.current;
this.entries = this.entries.filter((e) => e.path !== path);
if (this.entries.length === before) return;
this.index = cur && cur.path !== path ? this.entries.indexOf(cur) : this.entries.length - 1;
this.emit();
}
clear() {
this.entries = [];
this.index = -1;
this.emit();
}
snapshot() {
return { entries: this.entries.map((e) => ({ ...e })), index: this.index };
}
subscribe(fn: () => void) {
this.listeners.add(fn);
return () => this.listeners.delete(fn);
}
private emit() {
this.listeners.forEach((l) => l());
}
}