Files
openidea/src/features/services/dockerGutter.ts
T
l0ng-ai e598936529 fix(editor): gutter icons move with their line's text on Enter (#3726)
Line-start gutter icons were mapped with the default association, so Enter at the start of their line left them on the new empty line until each source placed them again. They now move with their line's text at once (mapLineStart), and HTTP endpoint markers are mapped through edits instead of cleared. Sibling of #3722.
2026-11-16 17:40:40 +08:00

156 lines
5.1 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
/**
* Gutter ▶ icons in Dockerfiles (`FROM` → run / build the image) and Compose
* files (`services:` → up all, each service → up it). As in IDEA they start
* temporary Dockerfile / Docker Compose run configurations through `run.runConfig`.
*/
import { RangeSet, StateEffect, StateField, type EditorState, type Extension } from "@codemirror/state";
import { EditorView, GutterMarker, ViewPlugin, type ViewUpdate } from "@codemirror/view";
import { iconAreaSource, mapLineStart, type EditorDocContext } from "@/editor/api";
import { executeAction } from "@/platform/actions";
import { editorPrefs } from "@/platform/editorSettings";
import { useProject } from "@/platform/project";
import { gutterIconMarkup, showContextMenu, type MenuItem } from "@/ui";
import {
fileTargets,
COMPOSE_SCAN_LIMIT,
isComposeFile,
isDockerfile,
isYamlFile,
noteComposeContent,
targetTitle,
useComposeFiles,
type DockerTarget,
} from "./compose";
import { gutterActions } from "./runTypes";
import styles from "./Services.module.css";
interface Placed {
target: DockerTarget;
pos: number;
}
const setTargets = StateEffect.define<Placed[]>();
const targetsField = StateField.define<Placed[]>({
create: () => [],
update(value, tr) {
for (const e of tr.effects) if (e.is(setTargets)) return e.value;
if (!tr.docChanged) return value;
return value.map((p) => ({ ...p, pos: mapLineStart(tr, p.pos) }));
},
});
function place(state: EditorState, path: string): Placed[] {
const prefix = state.doc.sliceString(0, Math.min(state.doc.length, COMPOSE_SCAN_LIMIT));
noteComposeContent(path, prefix);
if (!isDockerfile(path) && !isComposeFile(path, prefix)) return [];
const text = state.doc.toString();
return fileTargets(path, text)
.filter((t) => t.line < state.doc.lines)
.map((target) => ({ target, pos: state.doc.line(target.line + 1).from }));
}
function menu(target: DockerTarget, path: string): MenuItem[] {
const root = useProject.getState().project?.root ?? null;
const actions = gutterActions(target, path, root);
const items: MenuItem[] = actions.map(({ title, config }, i) => ({
label: title,
icon: i === 0 ? "run" : "build-project",
run: () => void executeAction("run.runConfig", { config, temporary: true }),
}));
if (actions[0]) {
items.push(
{ kind: "separator" },
{
label: "Modify Run Configuration…",
icon: "edit",
run: () => void executeAction("run.createConfig", actions[0]!.config),
},
);
}
return items;
}
class Marker extends GutterMarker {
constructor(
readonly target: DockerTarget,
readonly path: string,
) {
super();
}
override eq(other: GutterMarker): boolean {
return (
other instanceof Marker &&
other.path === this.path &&
targetTitle(other.target, other.path) === targetTitle(this.target, this.path)
);
}
override toDOM(): Node {
const el = document.createElement("button");
el.type = "button";
el.className = styles.marker ?? "";
el.title = targetTitle(this.target, this.path);
el.setAttribute("aria-label", el.title);
el.innerHTML = gutterIconMarkup(this.target.kind === "composeAll" ? "gutter-run-all" : "gutter-run") ?? "";
el.onclick = (event) => {
event.preventDefault();
event.stopPropagation();
const rect = el.getBoundingClientRect();
showContextMenu({ x: rect.left, y: rect.bottom + 2 }, menu(this.target, this.path));
};
return el;
}
}
/** Settings › Editor › General › Gutter Icons › Run icons (on with the gutter icons). */
function runIconsShown(): boolean {
const prefs = editorPrefs();
return prefs.showGutterIcons && !prefs.gutterIconsDisabled.includes("run");
}
export function dockerGutter(ctx: EditorDocContext): Extension {
const path = ctx.path;
if (ctx.virtual || !(isDockerfile(path) || isYamlFile(path))) return [];
const detector = ViewPlugin.fromClass(
class {
timer: ReturnType<typeof setTimeout> | undefined;
unsubscribe: () => void;
constructor(readonly view: EditorView) {
this.schedule(0);
this.unsubscribe = useComposeFiles.subscribe((s, prev) => {
if (s.overrides[path] !== prev.overrides[path]) this.schedule(0);
});
}
update(u: ViewUpdate) {
if (u.docChanged) this.schedule(300);
}
schedule(delay: number) {
clearTimeout(this.timer);
this.timer = setTimeout(() => {
this.view.dispatch({ effects: setTargets.of(place(this.view.state, path)) });
}, delay);
}
destroy() {
clearTimeout(this.timer);
this.unsubscribe();
}
},
);
return [
targetsField,
detector,
// In the shared icon area with the other run icons; hidden with them.
iconAreaSource.of({
order: 10,
markers: (view) =>
runIconsShown()
? RangeSet.of(
view.state.field(targetsField).map((p) => new Marker(p.target, path).range(p.pos)),
true,
)
: RangeSet.empty,
reserve: (state) => runIconsShown() && state.field(targetsField).length > 0,
}),
];
}