A2: disk-conflict banner, overwrite question and Local History dialog
- Banner inside the editor pane for a dirty tab whose file changed (Reload (discard mine) / Keep mine / Compare) or was deleted (Keep as unsaved / Close); state in stores/diskConflicts.ts, the old notice is gone. - Save and save all ask Overwrite / Cancel when the engine refuses with disk_changed. - Diff tabs against the disk text (file.readDisk) and a Local History entry (history.read); "Revert to This" in the caption. - Show Local History dialog (history.show: tree context menu, palette, File menu) with Show Diff and an undoable Revert to This. - History failures warn once until a snapshot works again. - Docs: docs/local-history.md, G2 in gaps.md, ui-parity, architecture. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
parent
dfe2f19ca5
commit
d2344bf216
29 changed files with 1999 additions and 52 deletions
|
|
@ -21,7 +21,8 @@
|
|||
* are exclusive modals too. So is the branches popup (M4.5), and so are
|
||||
* "Clone Repository…" and "Manage Remotes…" (M4.10), the merge
|
||||
* dialog (M4.8) and the stash dialog (M4.9), the deployment servers
|
||||
* dialog (G17), the sync preview (C9 D2) and the theme picker (C9 T1).
|
||||
* dialog (G17), the sync preview (C9 D2), the theme picker (C9 T1) and
|
||||
* the Local History dialog (C10 A2).
|
||||
*/
|
||||
import { defineStore } from "pinia";
|
||||
import { ref, watch } from "vue";
|
||||
|
|
@ -43,7 +44,8 @@ export type ModalId =
|
|||
| "deploySync"
|
||||
| "merge"
|
||||
| "stash"
|
||||
| "themes";
|
||||
| "themes"
|
||||
| "localHistory";
|
||||
|
||||
/** Store of the open exclusive modal. */
|
||||
export const useModalsStore = defineStore("modals", () => {
|
||||
|
|
|
|||
|
|
@ -36,6 +36,7 @@ export const UI_COMMANDS: readonly UiCommandSpec[] = [
|
|||
{ id: "editor.complete", labelKey: "command.editor.complete", menuPath: "Edit/Complete Code" },
|
||||
{ id: "editor.quickDocumentation", labelKey: "command.editor.quickDocumentation", menuPath: "Edit/Quick Documentation", defaultShortcut: "Mod+I" },
|
||||
{ id: "editor.parameterInfo", labelKey: "command.editor.parameterInfo", menuPath: "Edit/Parameter Info" },
|
||||
{ id: "history.show", labelKey: "command.history.show", menuPath: "File/Show Local History" },
|
||||
{ id: "find.open", labelKey: "command.find.open", menuPath: "View/Find in Files…", defaultShortcut: "Mod+Alt+F" },
|
||||
{ id: "goto.classOpen", labelKey: "command.goto.classOpen", menuPath: "Go/Class…", defaultShortcut: "Mod+Alt+C" },
|
||||
{ id: "goto.fileOpen", labelKey: "command.goto.fileOpen", menuPath: "Go/File…", defaultShortcut: "Mod+P" },
|
||||
|
|
|
|||
142
ui/src/components/editor/DiskBanner.vue
Normal file
142
ui/src/components/editor/DiskBanner.vue
Normal file
|
|
@ -0,0 +1,142 @@
|
|||
<script setup lang="ts">
|
||||
/**
|
||||
* The banner inside an editor pane for its active tab when that tab's file
|
||||
* changed or disappeared on disk while it had unsaved changes (C10 A2).
|
||||
* The actions and the rules live in the disk-conflict store
|
||||
* (`stores/diskConflicts.ts`); a failed action shows its message in the
|
||||
* pane of the focused tab.
|
||||
*/
|
||||
import { computed } from "vue";
|
||||
import { t } from "../../i18n";
|
||||
import { useDiskConflictsStore } from "../../stores/diskConflicts";
|
||||
import { baseName, useEditorStore } from "../../stores/editor";
|
||||
|
||||
const props = defineProps<{
|
||||
/** Buffer id of the pane's active tab, null if none. */
|
||||
id: number | null;
|
||||
}>();
|
||||
|
||||
const disk = useDiskConflictsStore();
|
||||
const editor = useEditorStore();
|
||||
|
||||
/** The pane's banner, null if none. */
|
||||
const banner = computed(() => disk.bannerOf(props.id));
|
||||
|
||||
/** The banner's text. */
|
||||
const message = computed(() => {
|
||||
const current = banner.value;
|
||||
if (!current) {
|
||||
return "";
|
||||
}
|
||||
const name = baseName(current.path);
|
||||
return current.kind === "removed" ? t("editor.disk.banner.removed", { name }) : t("editor.disk.banner.changed", { name });
|
||||
});
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<div
|
||||
v-if="banner"
|
||||
class="disk-banner"
|
||||
role="alert"
|
||||
data-test="disk-banner"
|
||||
:data-kind="banner.kind"
|
||||
>
|
||||
<span class="disk-banner__text">{{ message }}</span>
|
||||
<template v-if="banner.kind === 'changed'">
|
||||
<button
|
||||
type="button"
|
||||
class="disk-banner__button"
|
||||
:disabled="disk.busy"
|
||||
data-test="disk-reload"
|
||||
@click="disk.reload(banner.id)"
|
||||
>
|
||||
{{ t("editor.disk.reload") }}
|
||||
</button>
|
||||
<button
|
||||
type="button"
|
||||
class="disk-banner__button"
|
||||
data-test="disk-keep"
|
||||
@click="disk.keep(banner.id)"
|
||||
>
|
||||
{{ t("editor.disk.keepMine") }}
|
||||
</button>
|
||||
<button
|
||||
type="button"
|
||||
class="disk-banner__button"
|
||||
data-test="disk-compare"
|
||||
@click="disk.compare(banner.id)"
|
||||
>
|
||||
{{ t("editor.disk.compare") }}
|
||||
</button>
|
||||
</template>
|
||||
<template v-else>
|
||||
<button
|
||||
type="button"
|
||||
class="disk-banner__button"
|
||||
data-test="disk-keep"
|
||||
@click="disk.keep(banner.id)"
|
||||
>
|
||||
{{ t("editor.disk.keepUnsaved") }}
|
||||
</button>
|
||||
<button
|
||||
type="button"
|
||||
class="disk-banner__button"
|
||||
:disabled="disk.busy"
|
||||
data-test="disk-close"
|
||||
@click="disk.closeTab(banner.id)"
|
||||
>
|
||||
{{ t("common.close") }}
|
||||
</button>
|
||||
</template>
|
||||
</div>
|
||||
<div
|
||||
v-if="disk.error && id !== null && id === editor.activeId"
|
||||
class="disk-banner disk-banner--error"
|
||||
role="alert"
|
||||
data-test="disk-error"
|
||||
>
|
||||
<span class="disk-banner__text">{{ disk.error }}</span>
|
||||
<button
|
||||
type="button"
|
||||
class="disk-banner__button"
|
||||
@click="disk.error = null"
|
||||
>
|
||||
{{ t("common.dismiss") }}
|
||||
</button>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<style scoped>
|
||||
.disk-banner {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 8px;
|
||||
padding: 4px 12px;
|
||||
flex-shrink: 0;
|
||||
color: var(--lt-fg);
|
||||
background: color-mix(in srgb, var(--lt-diag-warning) 18%, var(--lt-bg));
|
||||
border-bottom: 1px solid var(--lt-border);
|
||||
}
|
||||
|
||||
.disk-banner--error {
|
||||
background: color-mix(in srgb, var(--lt-error) 15%, var(--lt-bg));
|
||||
}
|
||||
|
||||
.disk-banner__text {
|
||||
flex: 1;
|
||||
min-width: 0;
|
||||
}
|
||||
|
||||
.disk-banner__button {
|
||||
padding: 0 8px;
|
||||
font: inherit;
|
||||
color: var(--lt-fg);
|
||||
background: var(--lt-bg);
|
||||
border: 1px solid var(--lt-border);
|
||||
border-radius: 3px;
|
||||
}
|
||||
|
||||
.disk-banner__button:focus-visible {
|
||||
outline: 1px solid var(--lt-accent);
|
||||
}
|
||||
</style>
|
||||
|
|
@ -11,15 +11,20 @@
|
|||
* (`assist/commands.ts`) and the tab management commands
|
||||
* (`tabs/commands.ts`). Diff tabs (M4.3, `vcs/diff/`) share the first
|
||||
* group's tab bar; while one is active the diff view replaces that group's
|
||||
* editor, and the area supplies the diff commands.
|
||||
* editor, and the area supplies the diff commands. Files changed on disk
|
||||
* (C10 A2): each pane shows its active tab's banner (`DiskBanner.vue`);
|
||||
* the area shows the overwrite question (`OverwritePrompt.vue`), both from
|
||||
* `stores/diskConflicts.ts`.
|
||||
*/
|
||||
import { onBeforeUnmount, onMounted } from "vue";
|
||||
import { useCommandsStore } from "../../commands/store";
|
||||
import { t } from "../../i18n";
|
||||
import { useEditorStore } from "../../stores/editor";
|
||||
import { useDiskConflictsStore } from "../../stores/diskConflicts";
|
||||
import ClosePrompt from "./ClosePrompt.vue";
|
||||
import EditorPane from "./EditorPane.vue";
|
||||
import { provideTabCommands } from "./tabs/commands";
|
||||
import OverwritePrompt from "./OverwritePrompt.vue";
|
||||
import { reveal, REVEAL_COMMAND } from "./reveal";
|
||||
import * as assist from "./assist/commands";
|
||||
import { provideDiffCommands } from "../vcs/diff/commands";
|
||||
|
|
@ -28,12 +33,14 @@ import { useDiffStore } from "../vcs/diff/diff";
|
|||
const editor = useEditorStore();
|
||||
const commands = useCommandsStore();
|
||||
const diff = useDiffStore();
|
||||
const disk = useDiskConflictsStore();
|
||||
|
||||
/** Withdraws the command handlers; filled while mounted. */
|
||||
let withdraw: (() => void)[] = [];
|
||||
|
||||
onMounted(() => {
|
||||
editor.start();
|
||||
disk.start();
|
||||
const hasActive = (): boolean => editor.activeTab !== null;
|
||||
withdraw = [
|
||||
commands.provide("file.save", { run: async () => { await editor.save(); }, enabled: hasActive }),
|
||||
|
|
@ -53,6 +60,7 @@ onBeforeUnmount(() => {
|
|||
fn();
|
||||
}
|
||||
withdraw = [];
|
||||
disk.stop();
|
||||
editor.stop();
|
||||
});
|
||||
</script>
|
||||
|
|
@ -96,6 +104,7 @@ onBeforeUnmount(() => {
|
|||
</button>
|
||||
</div>
|
||||
<ClosePrompt />
|
||||
<OverwritePrompt />
|
||||
</div>
|
||||
</template>
|
||||
|
||||
|
|
|
|||
|
|
@ -4,15 +4,15 @@
|
|||
* tab and its editor. The first group also hosts the diff tabs; while a
|
||||
* diff is active there, the diff view replaces that group's editor.
|
||||
*
|
||||
* Banners about the active tab (C10 A2's conflict banner) belong in this
|
||||
* pane, between the tab bar and the editor, keyed by
|
||||
* {@link activeTab}.
|
||||
* The disk-conflict banner of the active tab (C10 A2, `DiskBanner.vue`)
|
||||
* sits between the tab bar and the editor, keyed by {@link activeTab}.
|
||||
*/
|
||||
import { computed, defineAsyncComponent } from "vue";
|
||||
import { t } from "../../i18n";
|
||||
import { useEditorStore } from "../../stores/editor";
|
||||
import { useDiffStore } from "../vcs/diff/diff";
|
||||
import CodeEditor from "./CodeEditor.vue";
|
||||
import DiskBanner from "./DiskBanner.vue";
|
||||
import EditorTabs from "./EditorTabs.vue";
|
||||
|
||||
/** The diff view, loaded on first use so `@codemirror/merge` stays out of the start bundle. */
|
||||
|
|
@ -45,6 +45,10 @@ const showsDiff = computed(() => props.group === 0 && diff.visible);
|
|||
data-test="editor-pane"
|
||||
>
|
||||
<EditorTabs :group="group" />
|
||||
<DiskBanner
|
||||
v-if="!showsDiff"
|
||||
:id="activeTab?.id ?? null"
|
||||
/>
|
||||
<div
|
||||
v-if="!showsDiff && activeTab?.notice"
|
||||
class="editor-pane__notice"
|
||||
|
|
|
|||
130
ui/src/components/editor/OverwritePrompt.vue
Normal file
130
ui/src/components/editor/OverwritePrompt.vue
Normal file
|
|
@ -0,0 +1,130 @@
|
|||
<script setup lang="ts">
|
||||
/**
|
||||
* The question before a save overwrites a file that another program
|
||||
* changed (C10 A2): Overwrite or Cancel. Escape cancels; Cancel has the
|
||||
* focus, so Enter never overwrites by accident. The questions come from
|
||||
* the disk-conflict store (`stores/diskConflicts.ts`), one at a time.
|
||||
*/
|
||||
import { nextTick, ref, watch } from "vue";
|
||||
import { t } from "../../i18n";
|
||||
import { useDiskConflictsStore } from "../../stores/diskConflicts";
|
||||
|
||||
const disk = useDiskConflictsStore();
|
||||
|
||||
/** The Cancel button, focused when the question appears. */
|
||||
const cancelButton = ref<HTMLButtonElement | null>(null);
|
||||
|
||||
watch(
|
||||
() => disk.prompt,
|
||||
async (prompt) => {
|
||||
if (prompt) {
|
||||
await nextTick();
|
||||
cancelButton.value?.focus();
|
||||
}
|
||||
},
|
||||
{ immediate: true },
|
||||
);
|
||||
|
||||
/**
|
||||
* Cancels on Escape.
|
||||
*
|
||||
* @param event - the key event inside the dialog.
|
||||
*/
|
||||
function onKeydown(event: KeyboardEvent): void {
|
||||
if (event.key === "Escape") {
|
||||
event.preventDefault();
|
||||
void disk.resolveOverwrite(false);
|
||||
}
|
||||
}
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<div
|
||||
v-if="disk.prompt"
|
||||
class="overwrite-prompt"
|
||||
data-test="overwrite-prompt"
|
||||
>
|
||||
<div
|
||||
class="overwrite-prompt__dialog"
|
||||
role="alertdialog"
|
||||
aria-modal="true"
|
||||
aria-labelledby="lt-overwrite-title"
|
||||
@keydown="onKeydown"
|
||||
>
|
||||
<p
|
||||
id="lt-overwrite-title"
|
||||
class="overwrite-prompt__text"
|
||||
>
|
||||
{{ t("editor.disk.overwrite.question", { name: disk.prompt.name }) }}
|
||||
</p>
|
||||
<div class="overwrite-prompt__buttons">
|
||||
<button
|
||||
type="button"
|
||||
class="overwrite-prompt__button overwrite-prompt__button--danger"
|
||||
data-test="overwrite-confirm"
|
||||
@click="disk.resolveOverwrite(true)"
|
||||
>
|
||||
{{ t("editor.disk.overwrite.confirm") }}
|
||||
</button>
|
||||
<button
|
||||
ref="cancelButton"
|
||||
type="button"
|
||||
class="overwrite-prompt__button"
|
||||
data-test="overwrite-cancel"
|
||||
@click="disk.resolveOverwrite(false)"
|
||||
>
|
||||
{{ t("common.cancel") }}
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<style scoped>
|
||||
.overwrite-prompt {
|
||||
position: absolute;
|
||||
inset: 0;
|
||||
display: flex;
|
||||
align-items: flex-start;
|
||||
justify-content: center;
|
||||
padding-top: 15%;
|
||||
background: color-mix(in srgb, var(--lt-bg) 50%, transparent);
|
||||
z-index: 10;
|
||||
}
|
||||
|
||||
.overwrite-prompt__dialog {
|
||||
max-width: 420px;
|
||||
padding: 16px;
|
||||
background: var(--lt-bg);
|
||||
color: var(--lt-fg);
|
||||
border: 1px solid var(--lt-border);
|
||||
border-radius: 6px;
|
||||
}
|
||||
|
||||
.overwrite-prompt__text {
|
||||
margin: 0 0 16px;
|
||||
}
|
||||
|
||||
.overwrite-prompt__buttons {
|
||||
display: flex;
|
||||
justify-content: flex-end;
|
||||
gap: 8px;
|
||||
}
|
||||
|
||||
.overwrite-prompt__button {
|
||||
padding: 4px 12px;
|
||||
font: inherit;
|
||||
color: var(--lt-fg);
|
||||
background: var(--lt-editor-bg);
|
||||
border: 1px solid var(--lt-border);
|
||||
border-radius: 4px;
|
||||
}
|
||||
|
||||
.overwrite-prompt__button--danger {
|
||||
border-color: var(--lt-error);
|
||||
}
|
||||
|
||||
.overwrite-prompt__button:focus-visible {
|
||||
outline: 1px solid var(--lt-accent);
|
||||
}
|
||||
</style>
|
||||
|
|
@ -18,7 +18,8 @@ export type EditorEvent =
|
|||
| { kind: "bufferChanged"; id: number; version: number }
|
||||
| { kind: "dirtyChanged"; id: number; dirty: boolean }
|
||||
| { kind: "bufferClosed"; id: number }
|
||||
| { kind: "fileChangedOnDisk"; path: string; id: number; removed: boolean };
|
||||
| { kind: "fileChangedOnDisk"; path: string; id: number; removed: boolean }
|
||||
| { kind: "diskConflictResolved"; id: number };
|
||||
|
||||
/** Callback receiving editor events. */
|
||||
export type EditorEventHandler = (event: EditorEvent) => void;
|
||||
|
|
@ -58,6 +59,8 @@ export function toEditorEvent(payload: EngineEventPayload): EditorEvent | null {
|
|||
return id !== null && typeof raw.path === "string" && typeof raw.removed === "boolean"
|
||||
? { kind: "fileChangedOnDisk", id, path: raw.path, removed: raw.removed }
|
||||
: null;
|
||||
case "diskConflictResolved":
|
||||
return id !== null ? { kind: "diskConflictResolved", id } : null;
|
||||
default:
|
||||
return null;
|
||||
}
|
||||
|
|
|
|||
413
ui/src/components/history/LocalHistoryDialog.vue
Normal file
413
ui/src/components/history/LocalHistoryDialog.vue
Normal file
|
|
@ -0,0 +1,413 @@
|
|||
<script setup lang="ts">
|
||||
/**
|
||||
* The "Show Local History" dialog (C10 A2), centred over the window: the
|
||||
* snapshots of one file, newest first, with time, reason and size.
|
||||
*
|
||||
* - **List:** Up/Down, Home and End move; Enter or "Show Diff" opens the
|
||||
* entry against the current text in a diff tab and closes the dialog;
|
||||
* "Revert to This" puts the entry's text into the buffer (undoable,
|
||||
* unsaved). A failure shows under the list.
|
||||
* - **Command:** the dialog supplies the UI command `history.show`,
|
||||
* enabled while `history.list` is (an open project).
|
||||
* - **Closing:** Escape, Cancel or a click outside; the focus goes back
|
||||
* where it was. The dialog is an exclusive modal (`commands/modals.ts`).
|
||||
*/
|
||||
import { History } from "@lucide/vue";
|
||||
import { nextTick, onBeforeUnmount, onMounted, ref, watch } from "vue";
|
||||
import { useModalsStore } from "../../commands/modals";
|
||||
import { useCommandsStore } from "../../commands/store";
|
||||
import { formatDateTime, t } from "../../i18n";
|
||||
import { baseName } from "../../stores/editor";
|
||||
import { SHOW_HISTORY_COMMAND, useLocalHistoryStore, type HistoryEntry, type HistoryReason } from "./localHistory";
|
||||
|
||||
const history = useLocalHistoryStore();
|
||||
const modals = useModalsStore();
|
||||
const commands = useCommandsStore();
|
||||
|
||||
/** The list. */
|
||||
const list = ref<HTMLElement | null>(null);
|
||||
/** The dialog box. */
|
||||
const dialogBox = ref<HTMLElement | null>(null);
|
||||
/** The element that had the focus before the dialog opened. */
|
||||
let returnFocus: HTMLElement | null = null;
|
||||
|
||||
/**
|
||||
* The DOM id of an entry's row.
|
||||
*
|
||||
* @param index - its index in the list.
|
||||
*/
|
||||
function rowId(index: number): string {
|
||||
return `lt-history-${String(index)}`;
|
||||
}
|
||||
|
||||
/**
|
||||
* The size of an entry for the list.
|
||||
*
|
||||
* @param entry - the entry.
|
||||
*/
|
||||
function sizeText(entry: HistoryEntry): string {
|
||||
return entry.size < 1024
|
||||
? t("history.sizeBytes", { size: entry.size })
|
||||
: t("history.sizeKib", { size: Math.round(entry.size / 102.4) / 10 });
|
||||
}
|
||||
|
||||
/** The label of each reason. */
|
||||
const REASON_TEXT: Record<HistoryReason, () => string> = {
|
||||
save: () => t("history.reason.save"),
|
||||
beforeSave: () => t("history.reason.beforeSave"),
|
||||
externalChange: () => t("history.reason.externalChange"),
|
||||
beforeReload: () => t("history.reason.beforeReload"),
|
||||
deleted: () => t("history.reason.deleted"),
|
||||
refactoring: () => t("history.reason.refactoring"),
|
||||
git: () => t("history.reason.git"),
|
||||
beforeRevert: () => t("history.reason.beforeRevert"),
|
||||
};
|
||||
|
||||
/**
|
||||
* The text of a reason for the list.
|
||||
*
|
||||
* @param reason - why the snapshot was taken.
|
||||
*/
|
||||
function reasonText(reason: HistoryReason): string {
|
||||
return REASON_TEXT[reason]();
|
||||
}
|
||||
|
||||
/** Closes the dialog. */
|
||||
function close(): void {
|
||||
if (history.open) {
|
||||
history.hide();
|
||||
}
|
||||
}
|
||||
|
||||
watch(
|
||||
() => history.open,
|
||||
(isOpen) => {
|
||||
if (isOpen) {
|
||||
const active = document.activeElement;
|
||||
returnFocus = active instanceof HTMLElement ? active : null;
|
||||
modals.opened("localHistory", close);
|
||||
} else {
|
||||
modals.closed("localHistory");
|
||||
returnFocus?.focus();
|
||||
returnFocus = null;
|
||||
}
|
||||
},
|
||||
);
|
||||
|
||||
watch(
|
||||
() => [history.focusRequest, history.entries] as const,
|
||||
async () => {
|
||||
await nextTick();
|
||||
if ((history.entries?.length ?? 0) > 0) {
|
||||
list.value?.focus();
|
||||
} else {
|
||||
dialogBox.value?.focus();
|
||||
}
|
||||
},
|
||||
);
|
||||
|
||||
/** Keeps the selected row in view. */
|
||||
function scrollSelected(): void {
|
||||
void nextTick(() => {
|
||||
const row = list.value?.querySelector<HTMLElement>(`#${rowId(history.selected)}`);
|
||||
if (row && typeof row.scrollIntoView === "function") {
|
||||
row.scrollIntoView({ block: "nearest" });
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Escape closes the dialog.
|
||||
*
|
||||
* @param event - the key press.
|
||||
*/
|
||||
function onDialogKey(event: KeyboardEvent): void {
|
||||
if (event.key === "Escape") {
|
||||
event.preventDefault();
|
||||
event.stopPropagation();
|
||||
close();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Keyboard handling of the list.
|
||||
*
|
||||
* @param event - the key press.
|
||||
*/
|
||||
function onListKey(event: KeyboardEvent): void {
|
||||
const count = history.entries?.length ?? 0;
|
||||
const moves: Record<string, number> = { ArrowDown: 1, ArrowUp: -1, Home: -count, End: count };
|
||||
const delta = moves[event.key];
|
||||
const entry = history.current;
|
||||
if (delta !== undefined) {
|
||||
history.move(delta);
|
||||
scrollSelected();
|
||||
} else if (event.key === "Enter" && entry) {
|
||||
void history.showDiff(entry);
|
||||
} else {
|
||||
return;
|
||||
}
|
||||
event.preventDefault();
|
||||
event.stopPropagation();
|
||||
}
|
||||
|
||||
/** Withdraws the command handler; set while mounted. */
|
||||
let withdraw: (() => void) | null = null;
|
||||
|
||||
onMounted(() => {
|
||||
withdraw = commands.provide(SHOW_HISTORY_COMMAND, {
|
||||
run: (params) => history.showCommand(params),
|
||||
enabled: () => commands.isEnabled("history.list"),
|
||||
});
|
||||
});
|
||||
|
||||
onBeforeUnmount(() => {
|
||||
withdraw?.();
|
||||
withdraw = null;
|
||||
});
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<div
|
||||
v-if="history.open"
|
||||
class="local-history"
|
||||
data-test="local-history"
|
||||
@mousedown.self.prevent="close()"
|
||||
>
|
||||
<div
|
||||
ref="dialogBox"
|
||||
class="local-history__dialog"
|
||||
tabindex="-1"
|
||||
role="dialog"
|
||||
aria-modal="true"
|
||||
aria-labelledby="lt-history-title"
|
||||
@keydown="onDialogKey"
|
||||
>
|
||||
<div class="local-history__header">
|
||||
<History
|
||||
:size="14"
|
||||
aria-hidden="true"
|
||||
/>
|
||||
<h2
|
||||
id="lt-history-title"
|
||||
class="local-history__title"
|
||||
>
|
||||
{{ t("history.title", { name: baseName(history.path) }) }}
|
||||
</h2>
|
||||
<span class="local-history__path">{{ history.path }}</span>
|
||||
</div>
|
||||
<p
|
||||
v-if="history.entries === null || history.entries.length === 0"
|
||||
class="local-history__hint"
|
||||
role="status"
|
||||
data-test="history-hint"
|
||||
>
|
||||
{{ history.entries === null ? (history.loading ? t("history.loading") : "") : t("history.empty") }}
|
||||
</p>
|
||||
<ul
|
||||
v-show="(history.entries?.length ?? 0) > 0"
|
||||
ref="list"
|
||||
class="local-history__list"
|
||||
role="listbox"
|
||||
tabindex="0"
|
||||
:aria-label="t('history.listLabel')"
|
||||
:aria-activedescendant="rowId(history.selected)"
|
||||
data-test="history-list"
|
||||
@keydown="onListKey"
|
||||
>
|
||||
<li
|
||||
v-for="(entry, i) in history.entries"
|
||||
:id="rowId(i)"
|
||||
:key="entry.id"
|
||||
class="local-history__row"
|
||||
:class="{ 'local-history__row--selected': history.selected === i }"
|
||||
role="option"
|
||||
:aria-selected="history.selected === i"
|
||||
:data-id="entry.id"
|
||||
data-test="history-row"
|
||||
@click="history.selected = i"
|
||||
@dblclick="history.showDiff(entry)"
|
||||
>
|
||||
<span class="local-history__time">{{ formatDateTime(entry.time) }}</span>
|
||||
<span class="local-history__reason">{{ reasonText(entry.reason) }}</span>
|
||||
<span class="local-history__size">{{ sizeText(entry) }}</span>
|
||||
</li>
|
||||
</ul>
|
||||
<p
|
||||
v-if="history.error !== null"
|
||||
class="local-history__error"
|
||||
role="alert"
|
||||
data-test="history-error"
|
||||
>
|
||||
{{ history.error }}
|
||||
</p>
|
||||
<div class="local-history__buttons">
|
||||
<button
|
||||
type="button"
|
||||
class="local-history__button"
|
||||
data-test="history-cancel"
|
||||
@click="close()"
|
||||
>
|
||||
{{ t("common.cancel") }}
|
||||
</button>
|
||||
<button
|
||||
type="button"
|
||||
class="local-history__button"
|
||||
:disabled="history.busy || history.current === null"
|
||||
data-test="history-revert"
|
||||
@click="history.current && history.revert(history.path, history.current.id)"
|
||||
>
|
||||
{{ t("history.revert") }}
|
||||
</button>
|
||||
<button
|
||||
type="button"
|
||||
class="local-history__button local-history__button--primary"
|
||||
:disabled="history.current === null"
|
||||
data-test="history-diff"
|
||||
@click="history.current && history.showDiff(history.current)"
|
||||
>
|
||||
{{ t("history.showDiff") }}
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<style scoped>
|
||||
.local-history {
|
||||
position: fixed;
|
||||
inset: 0;
|
||||
display: flex;
|
||||
align-items: flex-start;
|
||||
justify-content: center;
|
||||
padding-top: 12vh;
|
||||
z-index: 30;
|
||||
}
|
||||
|
||||
.local-history__dialog {
|
||||
width: min(560px, 92vw);
|
||||
max-height: 70vh;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 6px;
|
||||
padding: 10px;
|
||||
background: var(--lt-bg);
|
||||
color: var(--lt-fg);
|
||||
border: 1px solid var(--lt-border);
|
||||
border-radius: 6px;
|
||||
outline: none;
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
.local-history__header {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 6px;
|
||||
min-width: 0;
|
||||
color: var(--lt-fg-muted);
|
||||
}
|
||||
|
||||
.local-history__title {
|
||||
margin: 0;
|
||||
font-size: 1em;
|
||||
font-weight: 600;
|
||||
color: var(--lt-fg);
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
.local-history__path {
|
||||
min-width: 0;
|
||||
overflow: hidden;
|
||||
text-overflow: ellipsis;
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
.local-history__hint {
|
||||
margin: 0;
|
||||
color: var(--lt-fg-muted);
|
||||
}
|
||||
|
||||
.local-history__error {
|
||||
margin: 0;
|
||||
white-space: pre-wrap;
|
||||
color: var(--lt-error);
|
||||
}
|
||||
|
||||
.local-history__list {
|
||||
flex: 1;
|
||||
min-height: 0;
|
||||
margin: 0;
|
||||
padding: 2px 0;
|
||||
list-style: none;
|
||||
overflow-y: auto;
|
||||
border: 1px solid var(--lt-border);
|
||||
border-radius: var(--lt-radius, 4px);
|
||||
outline: none;
|
||||
}
|
||||
|
||||
.local-history__list:focus-visible {
|
||||
box-shadow: inset 0 0 0 1px var(--lt-accent);
|
||||
}
|
||||
|
||||
.local-history__row {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 12px;
|
||||
padding: 3px 8px;
|
||||
white-space: nowrap;
|
||||
cursor: default;
|
||||
}
|
||||
|
||||
.local-history__row:hover {
|
||||
background: color-mix(in srgb, var(--lt-fg) 6%, transparent);
|
||||
}
|
||||
|
||||
.local-history__row--selected,
|
||||
.local-history__row--selected:hover {
|
||||
background: var(--lt-editor-selection-bg);
|
||||
}
|
||||
|
||||
.local-history__time {
|
||||
flex: none;
|
||||
font-family: var(--lt-font-mono);
|
||||
}
|
||||
|
||||
.local-history__reason {
|
||||
flex: 1;
|
||||
min-width: 0;
|
||||
overflow: hidden;
|
||||
text-overflow: ellipsis;
|
||||
}
|
||||
|
||||
.local-history__size {
|
||||
flex: none;
|
||||
color: var(--lt-fg-muted);
|
||||
}
|
||||
|
||||
.local-history__buttons {
|
||||
display: flex;
|
||||
justify-content: flex-end;
|
||||
gap: 8px;
|
||||
}
|
||||
|
||||
.local-history__button {
|
||||
padding: 4px 12px;
|
||||
font: inherit;
|
||||
color: var(--lt-fg);
|
||||
background: var(--lt-editor-bg);
|
||||
border: 1px solid var(--lt-border);
|
||||
border-radius: 4px;
|
||||
}
|
||||
|
||||
.local-history__button--primary {
|
||||
border-color: var(--lt-accent);
|
||||
}
|
||||
|
||||
.local-history__button:focus-visible {
|
||||
outline: 1px solid var(--lt-accent);
|
||||
}
|
||||
|
||||
.local-history__button:disabled {
|
||||
opacity: 0.5;
|
||||
}
|
||||
</style>
|
||||
260
ui/src/components/history/localHistory.ts
Normal file
260
ui/src/components/history/localHistory.ts
Normal file
|
|
@ -0,0 +1,260 @@
|
|||
/**
|
||||
* Local History (C10 A2): the "Show Local History" dialog's state and the
|
||||
* revert action. The engine takes the snapshots (`crates/engine/src/
|
||||
* history.rs`); this store lists and applies them.
|
||||
*
|
||||
* - **Opening:** the UI command `history.show {path?}` (project tree and
|
||||
* tab context menus with the file's path, the palette with the active
|
||||
* tab's file). It lists `history.list {path}`, newest first, with time
|
||||
* and reason.
|
||||
* - **Show Diff:** opens a diff tab of the entry (left) against the
|
||||
* current buffer (right), see `vcs/diff/diff.ts` › `openHistory`, and
|
||||
* closes the dialog. The diff tab's caption has "Revert to This" too.
|
||||
* - **Revert to This:** `history.revert {path, id}` replaces the buffer's
|
||||
* text through the engine (an ordinary unsaved edit). For a file open in
|
||||
* a tab, the change enters the editor's undo history
|
||||
* (`BufferSync.beginUndoableRemote`), so Undo brings the text back.
|
||||
* - **Untrusted input:** list entries are checked field by field.
|
||||
*/
|
||||
import { defineStore } from "pinia";
|
||||
import { computed, ref } from "vue";
|
||||
import { t } from "../../i18n";
|
||||
import { run, type JsonValue } from "../../ipc";
|
||||
import { useEditorStore } from "../../stores/editor";
|
||||
import { useDiffStore } from "../vcs/diff/diff";
|
||||
|
||||
/** Command id that opens the dialog. */
|
||||
export const SHOW_HISTORY_COMMAND = "history.show";
|
||||
|
||||
/** Why a snapshot was taken, as the engine names it. */
|
||||
export type HistoryReason =
|
||||
| "save"
|
||||
| "beforeSave"
|
||||
| "externalChange"
|
||||
| "beforeReload"
|
||||
| "deleted"
|
||||
| "refactoring"
|
||||
| "git"
|
||||
| "beforeRevert";
|
||||
|
||||
/** Every reason, for checking untrusted input. */
|
||||
const REASONS: readonly HistoryReason[] = [
|
||||
"save",
|
||||
"beforeSave",
|
||||
"externalChange",
|
||||
"beforeReload",
|
||||
"deleted",
|
||||
"refactoring",
|
||||
"git",
|
||||
"beforeRevert",
|
||||
];
|
||||
|
||||
/** One entry of `history.list`. */
|
||||
export interface HistoryEntry {
|
||||
/** The entry's id. */
|
||||
id: number;
|
||||
/** When it was taken, ms since the Unix epoch. */
|
||||
time: number;
|
||||
/** Why it was taken. */
|
||||
reason: HistoryReason;
|
||||
/** Size of the text in bytes. */
|
||||
size: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads the entries of a `history.list` result; malformed entries are
|
||||
* skipped, a malformed result gives null.
|
||||
*
|
||||
* @param raw - untrusted.
|
||||
*/
|
||||
export function toEntries(raw: unknown): HistoryEntry[] | null {
|
||||
if (typeof raw !== "object" || raw === null || !Array.isArray((raw as { entries?: unknown }).entries)) {
|
||||
return null;
|
||||
}
|
||||
const out: HistoryEntry[] = [];
|
||||
for (const item of (raw as { entries: unknown[] }).entries) {
|
||||
if (typeof item !== "object" || item === null) {
|
||||
continue;
|
||||
}
|
||||
const e = item as Record<string, unknown>;
|
||||
const reason = REASONS.find((r) => r === e.reason);
|
||||
if (typeof e.id === "number" && typeof e.time === "number" && typeof e.size === "number" && reason) {
|
||||
out.push({ id: e.id, time: e.time, reason, size: e.size });
|
||||
}
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads the params of `history.show`; null when malformed.
|
||||
*
|
||||
* @param params - untrusted (`{}` from the palette and the keyboard).
|
||||
* @returns the path, or `""` for the active tab's file.
|
||||
*/
|
||||
export function parseShowParams(params: unknown): string | null {
|
||||
if (params === null || params === undefined) {
|
||||
return "";
|
||||
}
|
||||
if (typeof params !== "object" || Array.isArray(params)) {
|
||||
return null;
|
||||
}
|
||||
const path = (params as Record<string, unknown>).path;
|
||||
if (path === undefined || path === null) {
|
||||
return "";
|
||||
}
|
||||
return typeof path === "string" && path !== "" ? path : null;
|
||||
}
|
||||
|
||||
/** The Local History store. */
|
||||
export const useLocalHistoryStore = defineStore("localHistory", () => {
|
||||
const editor = useEditorStore();
|
||||
|
||||
/** Whether the dialog is open. */
|
||||
const open = ref(false);
|
||||
/** The file whose history is shown. */
|
||||
const path = ref("");
|
||||
/** The entries, newest first; null while loading or after a failure. */
|
||||
const entries = ref<HistoryEntry[] | null>(null);
|
||||
/** Index of the selected entry. */
|
||||
const selected = ref(0);
|
||||
/** Whether the list is loading. */
|
||||
const loading = ref(false);
|
||||
/** Whether a revert runs. */
|
||||
const busy = ref(false);
|
||||
/** Last failure, null if none. */
|
||||
const error = ref<string | null>(null);
|
||||
/** Bumped when the dialog wants the focus. */
|
||||
const focusRequest = ref(0);
|
||||
/** Load generation, so only the newest load lands. */
|
||||
let generation = 0;
|
||||
|
||||
/** The selected entry, or null. */
|
||||
const current = computed(() => entries.value?.[selected.value] ?? null);
|
||||
|
||||
/**
|
||||
* Opens the dialog for a file and lists its entries.
|
||||
*
|
||||
* @param file - project-relative path.
|
||||
*/
|
||||
async function show(file: string): Promise<void> {
|
||||
path.value = file;
|
||||
open.value = true;
|
||||
entries.value = null;
|
||||
selected.value = 0;
|
||||
error.value = null;
|
||||
loading.value = true;
|
||||
focusRequest.value += 1;
|
||||
const mine = ++generation;
|
||||
const result = await run<unknown>("history.list", { path: file });
|
||||
if (mine !== generation) {
|
||||
return;
|
||||
}
|
||||
loading.value = false;
|
||||
if (!result.ok) {
|
||||
error.value = result.error.message;
|
||||
return;
|
||||
}
|
||||
const list = toEntries(result.value);
|
||||
if (list === null) {
|
||||
error.value = t("common.error.unexpectedResult", { command: "history.list" });
|
||||
return;
|
||||
}
|
||||
entries.value = list;
|
||||
}
|
||||
|
||||
/** Closes the dialog. */
|
||||
function hide(): void {
|
||||
open.value = false;
|
||||
generation += 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Moves the selection.
|
||||
*
|
||||
* @param delta - rows to move; clamped to the list.
|
||||
*/
|
||||
function move(delta: number): void {
|
||||
const count = entries.value?.length ?? 0;
|
||||
if (count > 0) {
|
||||
selected.value = Math.max(0, Math.min(count - 1, selected.value + delta));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Shows an entry against the current text in the diff viewer.
|
||||
*
|
||||
* @param entry - the entry.
|
||||
*/
|
||||
async function showDiff(entry: HistoryEntry): Promise<void> {
|
||||
const file = path.value;
|
||||
hide();
|
||||
await useDiffStore().openHistory(file, entry.id, entry.time);
|
||||
}
|
||||
|
||||
/**
|
||||
* Puts an entry's text into the file's buffer, undoably when the file is
|
||||
* open in a tab, and closes the dialog.
|
||||
*
|
||||
* @param file - project-relative path.
|
||||
* @param id - the entry's id.
|
||||
* @returns whether it worked ({@link error} says why not).
|
||||
*/
|
||||
async function revert(file: string, id: number): Promise<boolean> {
|
||||
busy.value = true;
|
||||
const tab = editor.tabOfPath(file);
|
||||
const sync = tab ? editor.syncOf(tab.id) : undefined;
|
||||
if (tab) {
|
||||
await editor.settleAll();
|
||||
}
|
||||
sync?.beginUndoableRemote();
|
||||
const result = await run<{ version?: unknown }>("history.revert", { path: file, id });
|
||||
busy.value = false;
|
||||
if (!result.ok) {
|
||||
sync?.endUndoableRemote(null);
|
||||
error.value = result.error.message;
|
||||
return false;
|
||||
}
|
||||
sync?.endUndoableRemote(typeof result.value.version === "number" ? result.value.version : null);
|
||||
error.value = null;
|
||||
hide();
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Runs `history.show`: the given file, else the active diff's or editor
|
||||
* tab's file.
|
||||
*
|
||||
* @param params - untrusted params.
|
||||
* @throws Error with a catalog message when the params are malformed or
|
||||
* there is no file.
|
||||
*/
|
||||
async function showCommand(params: JsonValue): Promise<void> {
|
||||
const parsed = parseShowParams(params);
|
||||
if (parsed === null) {
|
||||
throw new Error(t("history.invalidParams"));
|
||||
}
|
||||
const file = parsed !== "" ? parsed : (useDiffStore().activeTab?.path ?? editor.activeTab?.path ?? "");
|
||||
if (file === "") {
|
||||
throw new Error(t("history.noFile"));
|
||||
}
|
||||
await show(file);
|
||||
}
|
||||
|
||||
return {
|
||||
open,
|
||||
path,
|
||||
entries,
|
||||
selected,
|
||||
loading,
|
||||
busy,
|
||||
error,
|
||||
focusRequest,
|
||||
current,
|
||||
show,
|
||||
hide,
|
||||
move,
|
||||
showDiff,
|
||||
revert,
|
||||
showCommand,
|
||||
};
|
||||
});
|
||||
|
|
@ -62,6 +62,7 @@ import { useChangesStore } from "../vcs/changes/changes";
|
|||
import LogToolWindow from "../vcs/log/LogToolWindow.vue";
|
||||
import { SHOW_HISTORY_COMMAND, SHOW_LOG_COMMAND, useLogStore } from "../vcs/log/log";
|
||||
import StashDialog from "../vcs/stash/StashDialog.vue";
|
||||
import LocalHistoryDialog from "../history/LocalHistoryDialog.vue";
|
||||
import DeploymentLogToolWindow from "../deploy/DeploymentLogToolWindow.vue";
|
||||
import RemoteBrowserToolWindow from "../deploy/RemoteBrowserToolWindow.vue";
|
||||
import { useRemoteBrowserStore } from "../deploy/remoteBrowser";
|
||||
|
|
@ -417,6 +418,7 @@ onBeforeUnmount(() => {
|
|||
</BottomPanel>
|
||||
<StatusBar />
|
||||
<StashDialog />
|
||||
<LocalHistoryDialog />
|
||||
</div>
|
||||
</template>
|
||||
|
||||
|
|
|
|||
|
|
@ -46,6 +46,7 @@ const ITEM_ORDER = [
|
|||
"project.openDialog",
|
||||
"file.save",
|
||||
"file.saveAll",
|
||||
"history.show",
|
||||
"buffer.close",
|
||||
"project.close",
|
||||
"app.quit",
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
/**
|
||||
* The project tree's context menu (M4.3). For a file: Open, Show Diff
|
||||
* (`vcs.showDiff {path}`) and Show History (`vcs.showHistory {path}`,
|
||||
* M4.6), the Git items dimmed while their command is disabled. For a file
|
||||
* M4.6) and Show Local History (`history.show {path}`, C10 A2), the Git items dimmed while their command is disabled. For a file
|
||||
* and a folder: Upload to Server, Compare with Server (a diff for a file,
|
||||
* the sync preview for a folder, C9 D2) and Download from Server
|
||||
* (`deployment.upload` / `deployment.compare` / `deployment.download
|
||||
|
|
@ -20,6 +20,7 @@ import { t } from "../../i18n";
|
|||
import { useEditorStore } from "../../stores/editor";
|
||||
import { SHOW_DIFF_COMMAND } from "../vcs/diff/diff";
|
||||
import { SHOW_HISTORY_COMMAND } from "../vcs/log/log";
|
||||
import { SHOW_HISTORY_COMMAND as SHOW_LOCAL_HISTORY_COMMAND } from "../history/localHistory";
|
||||
|
||||
const props = defineProps<{
|
||||
/** Project-relative path of the file. */
|
||||
|
|
@ -103,6 +104,12 @@ const fileItems = computed<MenuItem[]>(() => [
|
|||
enabled: commands.isEnabled(SHOW_HISTORY_COMMAND),
|
||||
run: () => commands.execute(SHOW_HISTORY_COMMAND, { path: props.path }),
|
||||
},
|
||||
{
|
||||
id: "showLocalHistory",
|
||||
label: t("project.tree.menu.showLocalHistory"),
|
||||
enabled: commands.isEnabled(SHOW_LOCAL_HISTORY_COMMAND),
|
||||
run: () => commands.execute(SHOW_LOCAL_HISTORY_COMMAND, { path: props.path }),
|
||||
},
|
||||
]);
|
||||
|
||||
/** The items, in order. */
|
||||
|
|
|
|||
|
|
@ -22,6 +22,9 @@
|
|||
* buffer, so its Git gutter shows unstaged and staged markers; a click
|
||||
* opens the chunk popup with Stage, Unstage and Revert. A hint line says
|
||||
* so.
|
||||
* - **Local tabs (C10 A2):** the disk text or a Local History entry on the
|
||||
* left; a history tab's caption has "Revert to This"
|
||||
* (`history.revert`, an undoable buffer edit).
|
||||
* - **Navigation:** a navigator over the merge view is registered for
|
||||
* `vcs.nextChange` / `vcs.previousChange` (`navigation.ts`): the focused
|
||||
* side, else the working copy, moves to the next or previous chunk.
|
||||
|
|
@ -31,7 +34,8 @@ import { Annotation, EditorState, Transaction, type Extension } from "@codemirro
|
|||
import { EditorView } from "@codemirror/view";
|
||||
import { basicSetup } from "codemirror";
|
||||
import { computed, onBeforeUnmount, onMounted, ref, watch } from "vue";
|
||||
import { t } from "../../../i18n";
|
||||
import { formatDateTime, t } from "../../../i18n";
|
||||
import { useLocalHistoryStore } from "../../history/localHistory";
|
||||
import { onEngineEvent } from "../../../ipc";
|
||||
import { useEditorStore } from "../../../stores/editor";
|
||||
import type { BufferSync } from "../../editor/bufferSync";
|
||||
|
|
@ -44,6 +48,7 @@ import { setNavigator } from "./navigation";
|
|||
|
||||
const diff = useDiffStore();
|
||||
const editor = useEditorStore();
|
||||
const history = useLocalHistoryStore();
|
||||
|
||||
/** Element the merge view is mounted in. */
|
||||
const host = ref<HTMLElement | null>(null);
|
||||
|
|
@ -102,6 +107,12 @@ const caption = computed(() => {
|
|||
if (tab.remote) {
|
||||
return t("vcs.diff.captionRemote", { path: tab.path, server: tab.remote.server });
|
||||
}
|
||||
if (tab.local?.kind === "disk") {
|
||||
return t("history.diff.captionDisk", { path: tab.path });
|
||||
}
|
||||
if (tab.local?.kind === "history") {
|
||||
return t("history.diff.captionEntry", { path: tab.path, time: formatDateTime(tab.local.time) });
|
||||
}
|
||||
return refFor(tab.staged) === "HEAD"
|
||||
? t("vcs.diff.captionHead", { path: tab.path })
|
||||
: t("vcs.diff.captionIndex", { path: tab.path });
|
||||
|
|
@ -276,9 +287,19 @@ onBeforeUnmount(() => {
|
|||
data-test="diff-caption"
|
||||
>
|
||||
{{ caption }}
|
||||
<button
|
||||
v-if="diff.activeTab?.local?.kind === 'history'"
|
||||
type="button"
|
||||
class="diff-view__action"
|
||||
:disabled="history.busy"
|
||||
data-test="diff-history-revert"
|
||||
@click="diff.activeTab?.local?.kind === 'history' && history.revert(diff.activeTab.path, diff.activeTab.local.id)"
|
||||
>
|
||||
{{ t("history.revert") }}
|
||||
</button>
|
||||
</div>
|
||||
<div
|
||||
v-if="diff.activeTab && !diff.activeTab.commit && !diff.activeTab.remote && diff.activeContent?.phase === 'ready' && diff.activeContent.bufferId !== null"
|
||||
v-if="diff.activeTab && !diff.activeTab.commit && !diff.activeTab.remote && !diff.activeTab.local && diff.activeContent?.phase === 'ready' && diff.activeContent.bufferId !== null"
|
||||
class="diff-view__hint"
|
||||
data-test="diff-chunk-hint"
|
||||
>
|
||||
|
|
@ -318,6 +339,9 @@ onBeforeUnmount(() => {
|
|||
}
|
||||
|
||||
.diff-view__caption {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 12px;
|
||||
flex-shrink: 0;
|
||||
padding: 3px 12px;
|
||||
color: var(--lt-fg-muted);
|
||||
|
|
@ -328,6 +352,16 @@ onBeforeUnmount(() => {
|
|||
text-overflow: ellipsis;
|
||||
}
|
||||
|
||||
.diff-view__action {
|
||||
margin-left: auto;
|
||||
padding: 0 8px;
|
||||
font: inherit;
|
||||
color: var(--lt-fg);
|
||||
background: transparent;
|
||||
border: 1px solid var(--lt-border);
|
||||
border-radius: 3px;
|
||||
}
|
||||
|
||||
.diff-view__hint {
|
||||
flex-shrink: 0;
|
||||
padding: 2px 12px;
|
||||
|
|
|
|||
|
|
@ -36,12 +36,17 @@
|
|||
* which answers like `git.show`) with the working copy (right, the
|
||||
* ordinary buffer). Nothing is re-read on `gitChanged`; reopening the
|
||||
* tab reads the server again.
|
||||
* - **Local tabs (C10 A2):** {@link openDisk} compares the file on disk
|
||||
* (left, read-only, `file.readDisk {path}`) with the buffer: "Compare" in
|
||||
* the disk-conflict banner. {@link openHistory} compares a Local History
|
||||
* entry (left, `history.read {path, id}`) with the buffer. Both answer
|
||||
* like `git.show`; nothing is re-read on `gitChanged`.
|
||||
* - **Untrusted input:** `git.show` results are checked field by field.
|
||||
*/
|
||||
import { defineStore } from "pinia";
|
||||
import { computed, ref, shallowRef, watch } from "vue";
|
||||
import { t } from "../../../i18n";
|
||||
import { onEngineEvent, runWaiting, type EngineEventPayload, type JsonValue } from "../../../ipc";
|
||||
import { onEngineEvent, run, runWaiting, type EngineEventPayload, type JsonValue } from "../../../ipc";
|
||||
import { baseName, useEditorStore } from "../../../stores/editor";
|
||||
|
||||
/** Command id that opens a diff. */
|
||||
|
|
@ -90,6 +95,33 @@ export interface DiffTab {
|
|||
commit?: DiffCommit;
|
||||
/** For a server tab: the deployment server compared with. */
|
||||
remote?: DiffRemote;
|
||||
/** For a local tab: the disk text or a Local History entry. */
|
||||
local?: DiffLocal;
|
||||
}
|
||||
|
||||
/** What a local tab compares the buffer with (C10 A2). */
|
||||
export type DiffLocal =
|
||||
| {
|
||||
/** The file as it is on disk now. */
|
||||
kind: "disk";
|
||||
}
|
||||
| {
|
||||
/** A Local History entry. */
|
||||
kind: "history";
|
||||
/** The entry's id from `history.list`. */
|
||||
id: number;
|
||||
/** When it was taken, ms since the Unix epoch. */
|
||||
time: number;
|
||||
};
|
||||
|
||||
/**
|
||||
* The key of a local tab.
|
||||
*
|
||||
* @param path - project-relative path.
|
||||
* @param local - what it compares with.
|
||||
*/
|
||||
export function localDiffKey(path: string, local: DiffLocal): string {
|
||||
return local.kind === "disk" ? `disk:${path}` : `history:${String(local.id)}:${path}`;
|
||||
}
|
||||
|
||||
/** The server a server tab compares the working copy with. */
|
||||
|
|
@ -307,6 +339,15 @@ export const useDiffStore = defineStore("diff", () => {
|
|||
* @returns the checked result, or the error text.
|
||||
*/
|
||||
async function readLeft(tab: DiffTab): Promise<ShowResult | string> {
|
||||
if (tab.local) {
|
||||
const command = tab.local.kind === "disk" ? "file.readDisk" : "history.read";
|
||||
const params: Record<string, JsonValue> = tab.local.kind === "disk" ? { path: tab.path } : { path: tab.path, id: tab.local.id };
|
||||
const local = await run(command, params);
|
||||
if (!local.ok) {
|
||||
return local.error.message;
|
||||
}
|
||||
return toShowResult(local.value) ?? t("common.error.unexpectedResult", { command });
|
||||
}
|
||||
if (tab.remote) {
|
||||
const params: Record<string, JsonValue> = { path: tab.path };
|
||||
if (tab.remote.serverId !== null) {
|
||||
|
|
@ -502,6 +543,44 @@ export const useDiffStore = defineStore("diff", () => {
|
|||
await load(tab);
|
||||
}
|
||||
|
||||
/**
|
||||
* Opens (or activates and reloads) the comparison of a file's buffer
|
||||
* with the file on disk, or with a Local History entry.
|
||||
*
|
||||
* @param path - project-relative path.
|
||||
* @param local - what to compare with.
|
||||
*/
|
||||
async function openLocal(path: string, local: DiffLocal): Promise<void> {
|
||||
const key = localDiffKey(path, local);
|
||||
let tab = tabs.value.find((t) => t.key === key);
|
||||
if (!tab) {
|
||||
tab = { key, path, staged: false, name: baseName(path), local };
|
||||
tabs.value.push(tab);
|
||||
}
|
||||
activate(key);
|
||||
await load(tab);
|
||||
}
|
||||
|
||||
/**
|
||||
* Opens the comparison of a file's buffer with the file on disk.
|
||||
*
|
||||
* @param path - project-relative path.
|
||||
*/
|
||||
async function openDisk(path: string): Promise<void> {
|
||||
await openLocal(path, { kind: "disk" });
|
||||
}
|
||||
|
||||
/**
|
||||
* Opens the comparison of a file's buffer with a Local History entry.
|
||||
*
|
||||
* @param path - project-relative path.
|
||||
* @param id - the entry's id.
|
||||
* @param time - when it was taken, ms since the Unix epoch.
|
||||
*/
|
||||
async function openHistory(path: string, id: number, time: number): Promise<void> {
|
||||
await openLocal(path, { kind: "history", id, time });
|
||||
}
|
||||
|
||||
/**
|
||||
* Re-reads the left side of every loaded text tab; a changed text
|
||||
* replaces the left document (`gitChanged`).
|
||||
|
|
@ -510,7 +589,7 @@ export const useDiffStore = defineStore("diff", () => {
|
|||
await Promise.all(
|
||||
tabs.value.map(async (tab) => {
|
||||
const before = contents.value[tab.key];
|
||||
if (before?.phase !== "ready" || tab.commit || tab.remote) {
|
||||
if (before?.phase !== "ready" || tab.commit || tab.remote || tab.local) {
|
||||
return;
|
||||
}
|
||||
const generation = generations.get(tab.key);
|
||||
|
|
@ -624,6 +703,8 @@ export const useDiffStore = defineStore("diff", () => {
|
|||
open,
|
||||
openAtCommit,
|
||||
openRemote,
|
||||
openDisk,
|
||||
openHistory,
|
||||
showDiff,
|
||||
refreshLeft,
|
||||
close,
|
||||
|
|
|
|||
|
|
@ -17,6 +17,7 @@
|
|||
"command.goto.classOpen": "Go to Class…",
|
||||
"command.goto.fileOpen": "Go to File…",
|
||||
"command.goto.symbolOpen": "Go to Symbol…",
|
||||
"command.history.show": "Show Local History",
|
||||
"command.key.alt": "Alt",
|
||||
"command.key.cmd": "Cmd",
|
||||
"command.key.ctrl": "Ctrl",
|
||||
|
|
@ -227,12 +228,18 @@
|
|||
"editor.chunk.unstaged": "Not staged",
|
||||
"editor.closePrompt.question": "Save changes to {name} before closing?",
|
||||
"editor.closePrompt.questionMany": "Save changes to these {count} files before closing?",
|
||||
"editor.disk.banner.changed": "{name} was changed by another program. You have unsaved changes.",
|
||||
"editor.disk.banner.removed": "{name} was deleted on disk. Your text is still open.",
|
||||
"editor.disk.compare": "Compare",
|
||||
"editor.disk.keepMine": "Keep mine",
|
||||
"editor.disk.keepUnsaved": "Keep as unsaved",
|
||||
"editor.disk.overwrite.confirm": "Overwrite",
|
||||
"editor.disk.overwrite.question": "{name} was changed by another program since you opened it. Overwrite it with your text?",
|
||||
"editor.disk.reload": "Reload (discard mine)",
|
||||
"editor.gitGutter.added": "Added since the staged version",
|
||||
"editor.gitGutter.deleted": "Lines deleted here since the staged version",
|
||||
"editor.gitGutter.modified": "Changed since the staged version",
|
||||
"editor.gitGutter.staged": "Staged change (click for the chunk)",
|
||||
"editor.notice.changedOnDisk": "{name} changed on disk. Your unsaved changes are kept; saving overwrites the file.",
|
||||
"editor.notice.removedOnDisk": "{name} was deleted on disk. Your text is kept; saving writes it again.",
|
||||
"editor.reveal.invalidParams": "editor.reveal needs a path (string), line and column (numbers)",
|
||||
"editor.reveal.openFailed": "could not open {path}",
|
||||
"editor.saveFailed": "save failed",
|
||||
|
|
@ -282,6 +289,26 @@
|
|||
"goto.placeholder.file": "File name or path",
|
||||
"goto.placeholder.symbol": "Function, method, property or constant; Class::member",
|
||||
"goto.switchHint": "Tab switches",
|
||||
"history.diff.captionDisk": "{path}: on disk (left) and your unsaved text (right)",
|
||||
"history.diff.captionEntry": "{path}: Local History of {time} (left) and the current text (right)",
|
||||
"history.empty": "No Local History for this file yet. Lutra keeps a copy on every save and before reloads, refactorings and git operations.",
|
||||
"history.invalidParams": "Show Local History takes { path?: string }.",
|
||||
"history.listLabel": "Local History entries",
|
||||
"history.loading": "Loading…",
|
||||
"history.noFile": "Open or select a file to show its Local History.",
|
||||
"history.reason.beforeReload": "Before reload from disk",
|
||||
"history.reason.beforeRevert": "Before revert",
|
||||
"history.reason.beforeSave": "Before first save",
|
||||
"history.reason.deleted": "Deleted on disk",
|
||||
"history.reason.externalChange": "Changed by another program",
|
||||
"history.reason.git": "Before git operation",
|
||||
"history.reason.refactoring": "Before refactoring",
|
||||
"history.reason.save": "Saved",
|
||||
"history.revert": "Revert to This",
|
||||
"history.showDiff": "Show Diff",
|
||||
"history.sizeBytes": "{size} B",
|
||||
"history.sizeKib": "{size} KiB",
|
||||
"history.title": "Local History of {name}",
|
||||
"menu.button": "Main menu",
|
||||
"menu.group.edit": "Edit",
|
||||
"menu.group.file": "File",
|
||||
|
|
@ -319,6 +346,7 @@
|
|||
"notification.deploy.uploadFailed": "Upload failed: {reason}",
|
||||
"notification.deploy.uploadOnSaveFailed": "Upload on save to {server} failed: {error}",
|
||||
"notification.deploy.uploaded": "Uploaded {files} to {server}.",
|
||||
"notification.history.failed": "Local History: {reason}",
|
||||
"notification.lsp.failed": "The PHP language server stopped: {reason}. Run Restart PHP Language Server to try again.",
|
||||
"notification.lsp.message": "PHP language server: {message}",
|
||||
"notification.lsp.renamed": "Renamed to {name}: {edits} changes in {files} files ({written} closed files saved)",
|
||||
|
|
@ -408,6 +436,7 @@
|
|||
"project.tree.menu.open": "Open",
|
||||
"project.tree.menu.showDiff": "Show Diff",
|
||||
"project.tree.menu.showHistory": "Show History",
|
||||
"project.tree.menu.showLocalHistory": "Show Local History",
|
||||
"project.tree.menu.upload": "Upload to Server",
|
||||
"project.tree.truncated": "Listing truncated: more entries than can be shown",
|
||||
"recovery.dialog.changedOnDisk": "The file changed on disk since then",
|
||||
|
|
|
|||
|
|
@ -26,6 +26,7 @@ export type EngineEventPayload =
|
|||
| { kind: "dirtyChanged"; id: number; dirty: boolean }
|
||||
| { kind: "bufferClosed"; id: number }
|
||||
| { kind: "fileChangedOnDisk"; path: string; id: number; removed: boolean }
|
||||
| { kind: "diskConflictResolved"; id: number }
|
||||
| { kind: "watchFailed"; message: string }
|
||||
| { kind: "themeChanged"; id: string; dark: boolean; tokens: Record<string, string> }
|
||||
| {
|
||||
|
|
|
|||
271
ui/src/stores/diskConflicts.ts
Normal file
271
ui/src/stores/diskConflicts.ts
Normal file
|
|
@ -0,0 +1,271 @@
|
|||
/**
|
||||
* Files changed on disk (C10 A2): the banner of an editor tab whose file
|
||||
* another program changed or deleted while the buffer had unsaved changes,
|
||||
* and the question before a save overwrites a newer file.
|
||||
*
|
||||
* - **Banner, changed:** "Reload (discard mine)" runs `file.reload` (the
|
||||
* engine keeps the discarded text in the Local History); "Keep mine"
|
||||
* hides the banner, and the next save asks once more because the engine
|
||||
* refuses it with `disk_changed`; "Compare" opens the diff viewer with
|
||||
* the disk text on the left and the buffer on the right.
|
||||
* - **Banner, removed:** "Keep as unsaved" hides the banner (the engine
|
||||
* already made the buffer dirty, so closing asks and saving writes the
|
||||
* file again); "Close" closes the tab without saving.
|
||||
* - **Clean buffers** never get a banner: the engine reloads them silently.
|
||||
* - **Overwrite question:** {@link askOverwrite} queues it, from a save or
|
||||
* save-all the engine refused with `disk_changed`. "Overwrite" repeats the
|
||||
* save with `overwrite: true`; "Cancel" leaves the file alone.
|
||||
* - **Events:** `fileChangedOnDisk` sets a tab's banner (again, if the file
|
||||
* changes once more after "Keep mine"); `diskConflictResolved` and
|
||||
* `bufferClosed` drop it; a project open or close drops everything.
|
||||
*
|
||||
* Command failures are stored in {@link error} and shown, never thrown.
|
||||
* Tabs are reached only through the editor store's public API (`tabOf`,
|
||||
* `reloadBuffer`, C10 A1); each editor pane shows the banner of its own
|
||||
* active tab ({@link bannerOf}).
|
||||
*/
|
||||
import { defineStore } from "pinia";
|
||||
import { computed, ref } from "vue";
|
||||
import { run } from "../ipc";
|
||||
import { onEditorEvent, type EditorEvent } from "../components/editor/engineEvents";
|
||||
import { useDiffStore } from "../components/vcs/diff/diff";
|
||||
import { baseName, useEditorStore } from "./editor";
|
||||
|
||||
/** What happened to a tab's file. */
|
||||
export type DiskConflictKind = "changed" | "removed";
|
||||
|
||||
/** The disk conflict of one buffer. */
|
||||
export interface DiskConflict {
|
||||
/** Buffer id. */
|
||||
id: number;
|
||||
/** Project-relative path. */
|
||||
path: string;
|
||||
/** Changed by another program, or gone. */
|
||||
kind: DiskConflictKind;
|
||||
/** The user chose "Keep mine" / "Keep as unsaved": no banner. */
|
||||
kept: boolean;
|
||||
}
|
||||
|
||||
/** A pending overwrite question. */
|
||||
export interface OverwritePrompt {
|
||||
/** Buffer id. */
|
||||
id: number;
|
||||
/** File name, for the question. */
|
||||
name: string;
|
||||
}
|
||||
|
||||
/** Store of disk conflicts and overwrite questions. */
|
||||
export const useDiskConflictsStore = defineStore("diskConflicts", () => {
|
||||
const editor = useEditorStore();
|
||||
|
||||
/** Conflicts by buffer id; replaced as a whole on every change. */
|
||||
const conflicts = ref<Record<number, DiskConflict>>({});
|
||||
/** Overwrite questions, oldest first; the first one is shown. */
|
||||
const prompts = ref<OverwritePrompt[]>([]);
|
||||
/** Last failed action, null if none. */
|
||||
const error = ref<string | null>(null);
|
||||
/** Whether an action is running. */
|
||||
const busy = ref(false);
|
||||
/** Ends the event subscription; set while started. */
|
||||
let unsubscribe: (() => void) | null = null;
|
||||
|
||||
/** The overwrite question shown now, or null. */
|
||||
const prompt = computed(() => prompts.value[0] ?? null);
|
||||
|
||||
/** The banner of the active editor tab, or null. */
|
||||
const activeBanner = computed(() => bannerOf(editor.activeId));
|
||||
|
||||
/**
|
||||
* Replaces or removes one conflict.
|
||||
*
|
||||
* @param id - buffer id.
|
||||
* @param next - the new conflict, or null to drop it.
|
||||
*/
|
||||
function put(id: number, next: DiskConflict | null): void {
|
||||
const rest = Object.fromEntries(Object.entries(conflicts.value).filter(([key]) => Number(key) !== id));
|
||||
conflicts.value = next ? { ...rest, [id]: next } : rest;
|
||||
}
|
||||
|
||||
/**
|
||||
* The banner of a buffer: its conflict unless the user kept the text.
|
||||
*
|
||||
* @param id - buffer id, or null.
|
||||
*/
|
||||
function bannerOf(id: number | null): DiskConflict | null {
|
||||
const conflict = id === null ? undefined : conflicts.value[id];
|
||||
return conflict && !conflict.kept ? conflict : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* The conflict of a buffer.
|
||||
*
|
||||
* @param id - buffer id.
|
||||
*/
|
||||
function conflictOf(id: number): DiskConflict | null {
|
||||
return conflicts.value[id] ?? null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Hides a buffer's banner ("Keep mine", "Keep as unsaved").
|
||||
*
|
||||
* @param id - buffer id.
|
||||
*/
|
||||
function keep(id: number): void {
|
||||
const conflict = conflicts.value[id];
|
||||
if (conflict) {
|
||||
put(id, { ...conflict, kept: true });
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* "Reload (discard mine)": the buffer takes the file's text.
|
||||
*
|
||||
* @param id - buffer id.
|
||||
*/
|
||||
async function reload(id: number): Promise<void> {
|
||||
busy.value = true;
|
||||
await editor.settleAll();
|
||||
const result = await run<unknown>("file.reload", { id });
|
||||
busy.value = false;
|
||||
if (result.ok) {
|
||||
error.value = null;
|
||||
put(id, null);
|
||||
editor.reloadBuffer(id);
|
||||
} else {
|
||||
error.value = result.error.message;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* "Compare": the disk text against the buffer in the diff viewer.
|
||||
*
|
||||
* @param id - buffer id.
|
||||
*/
|
||||
async function compare(id: number): Promise<void> {
|
||||
const conflict = conflicts.value[id];
|
||||
if (conflict) {
|
||||
await useDiffStore().openDisk(conflict.path);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* "Close": closes the tab without saving (the engine keeps the text in
|
||||
* the Local History).
|
||||
*
|
||||
* @param id - buffer id.
|
||||
*/
|
||||
async function closeTab(id: number): Promise<void> {
|
||||
const result = await run<unknown>("buffer.close", { id, force: true });
|
||||
if (result.ok) {
|
||||
error.value = null;
|
||||
put(id, null);
|
||||
} else {
|
||||
error.value = result.error.message;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Queues the question whether to overwrite a newer file.
|
||||
*
|
||||
* @param id - buffer id whose save the engine refused with `disk_changed`.
|
||||
*/
|
||||
function askOverwrite(id: number): void {
|
||||
if (prompts.value.some((p) => p.id === id)) {
|
||||
return;
|
||||
}
|
||||
const tab = editor.tabOf(id);
|
||||
const name = tab?.name ?? baseName(conflicts.value[id]?.path ?? String(id));
|
||||
prompts.value = [...prompts.value, { id, name }];
|
||||
}
|
||||
|
||||
/**
|
||||
* Answers the shown overwrite question.
|
||||
*
|
||||
* @param overwrite - write the buffer over the newer file, or leave it.
|
||||
*/
|
||||
async function resolveOverwrite(overwrite: boolean): Promise<void> {
|
||||
const current = prompts.value[0];
|
||||
if (!current) {
|
||||
return;
|
||||
}
|
||||
prompts.value = prompts.value.slice(1);
|
||||
if (!overwrite) {
|
||||
return;
|
||||
}
|
||||
busy.value = true;
|
||||
await editor.settleAll();
|
||||
const result = await run<unknown>("file.save", { id: current.id, overwrite: true });
|
||||
busy.value = false;
|
||||
if (result.ok) {
|
||||
error.value = null;
|
||||
put(current.id, null);
|
||||
} else {
|
||||
error.value = result.error.message;
|
||||
}
|
||||
}
|
||||
|
||||
/** Drops every conflict and question. */
|
||||
function clear(): void {
|
||||
conflicts.value = {};
|
||||
prompts.value = [];
|
||||
error.value = null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Applies one editor event.
|
||||
*
|
||||
* @param event - the event.
|
||||
*/
|
||||
function handleEvent(event: EditorEvent): void {
|
||||
switch (event.kind) {
|
||||
case "projectOpened":
|
||||
case "projectClosed":
|
||||
clear();
|
||||
break;
|
||||
case "fileChangedOnDisk":
|
||||
put(event.id, { id: event.id, path: event.path, kind: event.removed ? "removed" : "changed", kept: false });
|
||||
break;
|
||||
case "diskConflictResolved":
|
||||
put(event.id, null);
|
||||
break;
|
||||
case "bufferClosed":
|
||||
put(event.id, null);
|
||||
prompts.value = prompts.value.filter((p) => p.id !== event.id);
|
||||
break;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
/** Subscribes to engine events; calling it again has no effect. */
|
||||
function start(): void {
|
||||
unsubscribe ??= onEditorEvent(handleEvent);
|
||||
}
|
||||
|
||||
/** Ends the subscription. */
|
||||
function stop(): void {
|
||||
unsubscribe?.();
|
||||
unsubscribe = null;
|
||||
}
|
||||
|
||||
return {
|
||||
conflicts,
|
||||
prompts,
|
||||
prompt,
|
||||
error,
|
||||
busy,
|
||||
activeBanner,
|
||||
bannerOf,
|
||||
conflictOf,
|
||||
keep,
|
||||
reload,
|
||||
compare,
|
||||
closeTab,
|
||||
askOverwrite,
|
||||
resolveOverwrite,
|
||||
clear,
|
||||
handleEvent,
|
||||
start,
|
||||
stop,
|
||||
};
|
||||
});
|
||||
|
|
@ -5,8 +5,10 @@
|
|||
* Cancel question when tabs with unsaved changes close.
|
||||
*
|
||||
* Fed by engine events (`bufferOpened`, `bufferFocused`, `bufferChanged`, `dirtyChanged`,
|
||||
* `bufferClosed`, `fileChangedOnDisk`, project open/close) and by command
|
||||
* results. Text lives in the engine and in one {@link BufferSync} per
|
||||
* `bufferClosed`, project open/close) and by command results. Files changed
|
||||
* on disk are the disk-conflict store's (`diskConflicts.ts`, C10 A2): a save
|
||||
* the engine refuses with `disk_changed` hands over to its overwrite
|
||||
* question. Text lives in the engine and in one {@link BufferSync} per
|
||||
* buffer, kept outside reactive state; a buffer shown in both groups has
|
||||
* one sync, so both share the text and the undo history. Command failures
|
||||
* are stored and shown, never thrown.
|
||||
|
|
@ -29,6 +31,7 @@ import { run, type EngineError, type RunResult } from "../ipc";
|
|||
import { BufferSync, isBufferInfo, engineTransport, type BufferInfo, type SyncTransport } from "../components/editor/bufferSync";
|
||||
import { onEditorEvent, type EditorEvent } from "../components/editor/engineEvents";
|
||||
import { editorExtensions } from "../components/editor/extensions";
|
||||
import { useDiskConflictsStore } from "./diskConflicts";
|
||||
import type { AssistBuffer } from "../components/editor/assist";
|
||||
import * as model from "../components/editor/tabs/model";
|
||||
import type { CloseAction, ClosedTab, SplitOrientation, TabLayout } from "../components/editor/tabs/model";
|
||||
|
|
@ -761,6 +764,11 @@ export const useEditorStore = defineStore("editor", () => {
|
|||
}
|
||||
await settled(id);
|
||||
const result = await run<unknown>(EDITOR_COMMANDS.save, { id });
|
||||
if (!result.ok && result.error.code === "disk_changed") {
|
||||
lastError.value = null;
|
||||
useDiskConflictsStore().askOverwrite(id);
|
||||
return false;
|
||||
}
|
||||
lastError.value = result.ok ? null : result.error;
|
||||
if (result.ok) {
|
||||
const tab = tabOf(id);
|
||||
|
|
@ -777,13 +785,19 @@ export const useEditorStore = defineStore("editor", () => {
|
|||
/** Saves every buffer after all local edits reached the engine. */
|
||||
async function saveAll(): Promise<void> {
|
||||
await Promise.all(records.value.map((t) => settled(t.id)));
|
||||
const result = await run<{ failed?: { id?: unknown; message?: unknown }[] }>(
|
||||
const result = await run<{ failed?: { id?: unknown; message?: unknown }[]; diskChanged?: unknown }>(
|
||||
EDITOR_COMMANDS.saveAll,
|
||||
);
|
||||
if (!result.ok) {
|
||||
lastError.value = result.error;
|
||||
return;
|
||||
}
|
||||
const diskChanged = Array.isArray(result.value.diskChanged) ? result.value.diskChanged : [];
|
||||
for (const id of diskChanged) {
|
||||
if (typeof id === "number") {
|
||||
useDiskConflictsStore().askOverwrite(id);
|
||||
}
|
||||
}
|
||||
const failed = Array.isArray(result.value.failed) ? result.value.failed : [];
|
||||
lastError.value =
|
||||
failed.length > 0
|
||||
|
|
@ -1099,24 +1113,9 @@ export const useEditorStore = defineStore("editor", () => {
|
|||
removeTab(event.id);
|
||||
}
|
||||
break;
|
||||
case "fileChangedOnDisk": {
|
||||
const tab = tabOf(event.id);
|
||||
if (!tab) {
|
||||
break;
|
||||
}
|
||||
if (event.removed) {
|
||||
tab.notice = {
|
||||
kind: "removedOnDisk",
|
||||
message: t("editor.notice.removedOnDisk", { name: tab.name }),
|
||||
};
|
||||
} else {
|
||||
tab.notice = {
|
||||
kind: "changedOnDisk",
|
||||
message: t("editor.notice.changedOnDisk", { name: tab.name }),
|
||||
};
|
||||
}
|
||||
case "fileChangedOnDisk":
|
||||
case "diskConflictResolved":
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
* `buffer.edit`, the dirty marker, closing (middle click, shortcut, the
|
||||
* Save / Don't Save / Cancel question), saving through the global keymap
|
||||
* (`commands/store.ts`) with shortcuts loaded from the engine's command
|
||||
* list, the notice for files changed on disk, and the UI command
|
||||
* list, the banner for files changed on disk, and the UI command
|
||||
* `editor.reveal` (open and closed files, CRLF text, bad params).
|
||||
* The engine is a fake behind the mocked Tauri `invoke`.
|
||||
*/
|
||||
|
|
@ -482,16 +482,16 @@ describe("EditorArea", () => {
|
|||
expect(editor.activeId).toBe(1);
|
||||
});
|
||||
|
||||
it("shows a notice when a dirty file changes on disk, and an open error", async () => {
|
||||
it("shows the disk banner when a dirty file changes on disk, and an open error", async () => {
|
||||
const area = await mountArea();
|
||||
const editor = useEditorStore(pinia);
|
||||
await editor.openFile("a.php");
|
||||
await flushPromises();
|
||||
emitEditorEvent({ kind: "fileChangedOnDisk", id: 1, path: "a.php", removed: false });
|
||||
await flushPromises();
|
||||
expect(area.find("[data-test=editor-notice]").text()).toContain("changed on disk");
|
||||
await area.find("[data-test=notice-dismiss]").trigger("click");
|
||||
expect(area.find("[data-test=editor-notice]").exists()).toBe(false);
|
||||
expect(area.find("[data-test=disk-banner]").text()).toContain("changed by another program");
|
||||
await area.find("[data-test=disk-keep]").trigger("click");
|
||||
expect(area.find("[data-test=disk-banner]").exists()).toBe(false);
|
||||
|
||||
await editor.openFile("missing.php");
|
||||
await flushPromises();
|
||||
|
|
|
|||
225
ui/tests/editor/diskConflicts.test.ts
Normal file
225
ui/tests/editor/diskConflicts.test.ts
Normal file
|
|
@ -0,0 +1,225 @@
|
|||
/**
|
||||
* Tests for files changed on disk (C10 A2) in the editor area: the banner
|
||||
* for a changed and a deleted file and its actions (Reload, Keep mine,
|
||||
* Compare, Keep as unsaved, Close), the overwrite question after the
|
||||
* engine refuses a save with `disk_changed`, and the diff tab against the
|
||||
* disk. The engine is a fake behind the mocked Tauri `invoke`.
|
||||
*/
|
||||
import { flushPromises, mount, type VueWrapper } from "@vue/test-utils";
|
||||
import { createPinia, setActivePinia, type Pinia } from "pinia";
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||
|
||||
const invoke = vi.hoisted(() => vi.fn());
|
||||
vi.mock("@tauri-apps/api/core", () => ({ invoke }));
|
||||
|
||||
import { useCommandsStore } from "../../src/commands/store";
|
||||
import EditorArea from "../../src/components/editor/EditorArea.vue";
|
||||
import { emitEditorEvent } from "../../src/components/editor/engineEvents";
|
||||
import { useDiffStore } from "../../src/components/vcs/diff/diff";
|
||||
import { useDiskConflictsStore } from "../../src/stores/diskConflicts";
|
||||
import { useEditorStore } from "../../src/stores/editor";
|
||||
|
||||
/** Every `engine_execute` call, in order. */
|
||||
let calls: { command: string; params: Record<string, unknown> }[];
|
||||
/** The text the fake buffer holds. */
|
||||
let bufferText: string;
|
||||
/** The text on the fake disk. */
|
||||
let diskText: string;
|
||||
/** Whether the next plain `file.save` is refused with `disk_changed`. */
|
||||
let newerOnDisk: boolean;
|
||||
/** Pinia of the current test. */
|
||||
let pinia: Pinia;
|
||||
/** Mounted components. */
|
||||
let mounted: VueWrapper[] = [];
|
||||
|
||||
/** The buffer as `file.open` and `buffer.get` describe it. */
|
||||
function info(): unknown {
|
||||
return { id: 1, path: "src/a.php", text: bufferText, version: 1, dirty: true, lineEnding: "lf" };
|
||||
}
|
||||
|
||||
/**
|
||||
* Rejects like the shell does with an engine error.
|
||||
*
|
||||
* @param code - error code.
|
||||
*/
|
||||
function fail(code: string): Promise<never> {
|
||||
return Promise.reject(Object.assign(new Error(code), { code, message: `${code} message` }));
|
||||
}
|
||||
|
||||
/**
|
||||
* The fake engine.
|
||||
*
|
||||
* @param command - command id.
|
||||
* @param p - params.
|
||||
*/
|
||||
function execute(command: string, p: Record<string, unknown>): Promise<unknown> {
|
||||
switch (command) {
|
||||
case "file.open":
|
||||
case "buffer.get":
|
||||
return Promise.resolve(info());
|
||||
case "file.save":
|
||||
if (newerOnDisk && p.overwrite !== true) {
|
||||
return fail("disk_changed");
|
||||
}
|
||||
diskText = bufferText;
|
||||
return Promise.resolve({ id: 1, version: 1 });
|
||||
case "file.saveAll":
|
||||
return Promise.resolve({ saved: [], failed: [], skipped: [], diskChanged: newerOnDisk ? [1] : [] });
|
||||
case "file.reload":
|
||||
bufferText = diskText;
|
||||
emitEditorEvent({ kind: "diskConflictResolved", id: 1 });
|
||||
return Promise.resolve({ id: 1, version: 2, dirty: false });
|
||||
case "file.readDisk":
|
||||
return Promise.resolve({ text: diskText, binary: false, tooLarge: false });
|
||||
case "buffer.close":
|
||||
emitEditorEvent({ kind: "bufferClosed", id: 1 });
|
||||
return Promise.resolve(null);
|
||||
default:
|
||||
return Promise.resolve(null);
|
||||
}
|
||||
}
|
||||
|
||||
/** Mounts the editor area with `src/a.php` open. */
|
||||
async function mountWithFile(): Promise<VueWrapper> {
|
||||
await useCommandsStore(pinia).start();
|
||||
const wrapper = mount(EditorArea, { attachTo: document.body, global: { plugins: [pinia] } });
|
||||
mounted.push(wrapper);
|
||||
await useEditorStore(pinia).openFile("src/a.php");
|
||||
await flushPromises();
|
||||
return wrapper;
|
||||
}
|
||||
|
||||
/**
|
||||
* The commands the fake engine received, without reads.
|
||||
*/
|
||||
function commandsRun(): string[] {
|
||||
return calls.map((c) => c.command).filter((c) => c !== "buffer.get" && c !== "file.open");
|
||||
}
|
||||
|
||||
beforeEach(() => {
|
||||
pinia = createPinia();
|
||||
setActivePinia(pinia);
|
||||
calls = [];
|
||||
bufferText = "mine";
|
||||
diskText = "theirs";
|
||||
newerOnDisk = false;
|
||||
invoke.mockReset();
|
||||
invoke.mockImplementation((cmd: string, args?: { command: string; params: Record<string, unknown> }) => {
|
||||
if (cmd === "engine_list_commands") {
|
||||
return Promise.resolve([]);
|
||||
}
|
||||
if ((cmd === "engine_execute" || cmd === "engine_execute_waiting") && args) {
|
||||
calls.push({ command: args.command, params: args.params });
|
||||
return execute(args.command, args.params);
|
||||
}
|
||||
return Promise.reject(new Error(`unexpected ${cmd}`));
|
||||
});
|
||||
});
|
||||
|
||||
afterEach(async () => {
|
||||
await flushPromises();
|
||||
useCommandsStore(pinia).stop();
|
||||
for (const wrapper of mounted) {
|
||||
wrapper.unmount();
|
||||
}
|
||||
mounted = [];
|
||||
});
|
||||
|
||||
describe("files changed on disk", () => {
|
||||
it("offers Reload, Keep mine and Compare for a changed file", async () => {
|
||||
const area = await mountWithFile();
|
||||
emitEditorEvent({ kind: "fileChangedOnDisk", id: 1, path: "src/a.php", removed: false });
|
||||
await flushPromises();
|
||||
const banner = area.find("[data-test=disk-banner]");
|
||||
expect(banner.attributes("data-kind")).toBe("changed");
|
||||
expect(banner.text()).toContain("a.php was changed by another program");
|
||||
expect(banner.findAll("button").map((b) => b.text())).toEqual(["Reload (discard mine)", "Keep mine", "Compare"]);
|
||||
|
||||
await area.find("[data-test=disk-reload]").trigger("click");
|
||||
await flushPromises();
|
||||
expect(commandsRun()).toContain("file.reload");
|
||||
expect(area.find("[data-test=disk-banner]").exists()).toBe(false);
|
||||
});
|
||||
|
||||
it("compares the disk text with the buffer in a diff tab", async () => {
|
||||
const area = await mountWithFile();
|
||||
emitEditorEvent({ kind: "fileChangedOnDisk", id: 1, path: "src/a.php", removed: false });
|
||||
await flushPromises();
|
||||
await area.find("[data-test=disk-compare]").trigger("click");
|
||||
await flushPromises();
|
||||
const diff = useDiffStore(pinia);
|
||||
expect(diff.activeTab?.key).toBe("disk:src/a.php");
|
||||
expect(diff.activeContent?.phase).toBe("ready");
|
||||
expect(diff.activeContent?.left).toBe("theirs");
|
||||
expect(diff.activeContent?.bufferId).toBe(1);
|
||||
expect(calls.find((c) => c.command === "file.readDisk")?.params).toEqual({ path: "src/a.php" });
|
||||
});
|
||||
|
||||
it("asks once more when a kept buffer is saved over the newer file", async () => {
|
||||
const area = await mountWithFile();
|
||||
const editor = useEditorStore(pinia);
|
||||
emitEditorEvent({ kind: "fileChangedOnDisk", id: 1, path: "src/a.php", removed: false });
|
||||
await flushPromises();
|
||||
await area.find("[data-test=disk-keep]").trigger("click");
|
||||
expect(area.find("[data-test=disk-banner]").exists()).toBe(false);
|
||||
|
||||
newerOnDisk = true;
|
||||
expect(await editor.save(1)).toBe(false);
|
||||
await flushPromises();
|
||||
expect(editor.lastError).toBeNull();
|
||||
const prompt = area.find("[data-test=overwrite-prompt]");
|
||||
expect(prompt.text()).toContain("a.php was changed by another program");
|
||||
expect(document.activeElement?.getAttribute("data-test")).toBe("overwrite-cancel");
|
||||
|
||||
await area.find("[data-test=overwrite-cancel]").trigger("click");
|
||||
await flushPromises();
|
||||
expect(diskText).toBe("theirs");
|
||||
expect(area.find("[data-test=overwrite-prompt]").exists()).toBe(false);
|
||||
|
||||
await editor.save(1);
|
||||
await flushPromises();
|
||||
await area.find("[data-test=overwrite-confirm]").trigger("click");
|
||||
await flushPromises();
|
||||
expect(calls.filter((c) => c.command === "file.save").map((c) => c.params)).toEqual([
|
||||
{ id: 1 },
|
||||
{ id: 1 },
|
||||
{ id: 1, overwrite: true },
|
||||
]);
|
||||
expect(diskText).toBe("mine");
|
||||
});
|
||||
|
||||
it("asks for buffers that save all left unsaved because their file is newer", async () => {
|
||||
const area = await mountWithFile();
|
||||
newerOnDisk = true;
|
||||
await useEditorStore(pinia).saveAll();
|
||||
await flushPromises();
|
||||
expect(area.find("[data-test=overwrite-prompt]").exists()).toBe(true);
|
||||
expect(useDiskConflictsStore(pinia).prompts).toHaveLength(1);
|
||||
});
|
||||
|
||||
it("offers Keep as unsaved and Close for a deleted file", async () => {
|
||||
const area = await mountWithFile();
|
||||
emitEditorEvent({ kind: "fileChangedOnDisk", id: 1, path: "src/a.php", removed: true });
|
||||
await flushPromises();
|
||||
const banner = area.find("[data-test=disk-banner]");
|
||||
expect(banner.attributes("data-kind")).toBe("removed");
|
||||
expect(banner.findAll("button").map((b) => b.text())).toEqual(["Keep as unsaved", "Close"]);
|
||||
await area.find("[data-test=disk-close]").trigger("click");
|
||||
await flushPromises();
|
||||
expect(calls.find((c) => c.command === "buffer.close")?.params).toEqual({ id: 1, force: true });
|
||||
expect(useEditorStore(pinia).tabs).toEqual([]);
|
||||
});
|
||||
|
||||
it("drops the banner when the engine settles the conflict", async () => {
|
||||
const area = await mountWithFile();
|
||||
emitEditorEvent({ kind: "fileChangedOnDisk", id: 1, path: "src/a.php", removed: true });
|
||||
await flushPromises();
|
||||
await area.find("[data-test=disk-keep]").trigger("click");
|
||||
emitEditorEvent({ kind: "fileChangedOnDisk", id: 1, path: "src/a.php", removed: false });
|
||||
await flushPromises();
|
||||
expect(area.find("[data-test=disk-banner]").attributes("data-kind")).toBe("changed");
|
||||
emitEditorEvent({ kind: "diskConflictResolved", id: 1 });
|
||||
await flushPromises();
|
||||
expect(area.find("[data-test=disk-banner]").exists()).toBe(false);
|
||||
});
|
||||
});
|
||||
220
ui/tests/history/LocalHistory.test.ts
Normal file
220
ui/tests/history/LocalHistory.test.ts
Normal file
|
|
@ -0,0 +1,220 @@
|
|||
/**
|
||||
* Tests for the Local History dialog (C10 A2): `history.show` from the
|
||||
* palette (active tab) and with a path, the list with time and reason,
|
||||
* keyboard selection, Show Diff (a diff tab of the entry against the
|
||||
* buffer), Revert to This (`history.revert`, undoable in the editor), the
|
||||
* empty and failed states, and the checks of untrusted input. The engine
|
||||
* is a fake behind the mocked Tauri `invoke`.
|
||||
*/
|
||||
import { flushPromises, mount, type VueWrapper } from "@vue/test-utils";
|
||||
import { EditorView } from "@codemirror/view";
|
||||
import { createPinia, setActivePinia, type Pinia } from "pinia";
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||
|
||||
const invoke = vi.hoisted(() => vi.fn());
|
||||
vi.mock("@tauri-apps/api/core", () => ({ invoke }));
|
||||
|
||||
import { useCommandsStore } from "../../src/commands/store";
|
||||
import EditorArea from "../../src/components/editor/EditorArea.vue";
|
||||
import { emitEditorEvent } from "../../src/components/editor/engineEvents";
|
||||
import LocalHistoryDialog from "../../src/components/history/LocalHistoryDialog.vue";
|
||||
import { parseShowParams, toEntries, useLocalHistoryStore } from "../../src/components/history/localHistory";
|
||||
import { useDiffStore } from "../../src/components/vcs/diff/diff";
|
||||
import { useEditorStore } from "../../src/stores/editor";
|
||||
|
||||
/** Every `engine_execute` call, in order. */
|
||||
let calls: { command: string; params: Record<string, unknown> }[];
|
||||
/** The fake buffer. */
|
||||
let buffer: { text: string; version: number };
|
||||
/** Entries `history.list` returns. */
|
||||
let listed: unknown;
|
||||
/** Pinia of the current test. */
|
||||
let pinia: Pinia;
|
||||
/** Mounted components. */
|
||||
let mounted: VueWrapper[] = [];
|
||||
|
||||
/** Snapshot texts by id. */
|
||||
const TEXTS: Record<number, string> = { 2: "second", 1: "first" };
|
||||
|
||||
/** 2026-11-08 10:15 and 09:00 local time. */
|
||||
const T2 = new Date(2026, 10, 8, 10, 15).getTime();
|
||||
const T1 = new Date(2026, 10, 8, 9, 0).getTime();
|
||||
|
||||
/**
|
||||
* The fake engine.
|
||||
*
|
||||
* @param command - command id.
|
||||
* @param p - params.
|
||||
*/
|
||||
function execute(command: string, p: Record<string, unknown>): Promise<unknown> {
|
||||
const describe = { id: 1, path: "src/a.php", text: buffer.text, version: buffer.version, dirty: false, lineEnding: "lf" };
|
||||
switch (command) {
|
||||
case "file.open":
|
||||
case "buffer.get":
|
||||
return Promise.resolve(describe);
|
||||
case "buffer.edit": {
|
||||
let out = "";
|
||||
let pos = 0;
|
||||
for (const e of p.edits as { from: number; to: number; insert: string }[]) {
|
||||
out += buffer.text.slice(pos, e.from) + e.insert;
|
||||
pos = e.to;
|
||||
}
|
||||
buffer.text = out + buffer.text.slice(pos);
|
||||
buffer.version += 1;
|
||||
return Promise.resolve({ id: 1, version: buffer.version, dirty: true });
|
||||
}
|
||||
case "history.list":
|
||||
return Promise.resolve(listed);
|
||||
case "history.read":
|
||||
return Promise.resolve({ text: TEXTS[Number(p.id)] ?? "", binary: false, tooLarge: false });
|
||||
case "history.revert":
|
||||
buffer.text = TEXTS[Number(p.id)] ?? "";
|
||||
buffer.version += 1;
|
||||
emitEditorEvent({ kind: "bufferChanged", id: 1, version: buffer.version });
|
||||
return Promise.resolve({ id: 1, version: buffer.version, dirty: true });
|
||||
default:
|
||||
return Promise.resolve(null);
|
||||
}
|
||||
}
|
||||
|
||||
/** Mounts the editor area (with `src/a.php` open) and the dialog. */
|
||||
async function mountAll(): Promise<{ area: VueWrapper; dialog: VueWrapper }> {
|
||||
await useCommandsStore(pinia).start();
|
||||
const area = mount(EditorArea, { attachTo: document.body, global: { plugins: [pinia] } });
|
||||
const dialog = mount(LocalHistoryDialog, { attachTo: document.body, global: { plugins: [pinia] } });
|
||||
mounted.push(area, dialog);
|
||||
await useEditorStore(pinia).openFile("src/a.php");
|
||||
await flushPromises();
|
||||
return { area, dialog };
|
||||
}
|
||||
|
||||
beforeEach(() => {
|
||||
pinia = createPinia();
|
||||
setActivePinia(pinia);
|
||||
calls = [];
|
||||
buffer = { text: "current", version: 1 };
|
||||
listed = {
|
||||
path: "src/a.php",
|
||||
entries: [
|
||||
{ id: 2, time: T2, reason: "save", size: 6 },
|
||||
{ id: 1, time: T1, reason: "externalChange", size: 2048 },
|
||||
],
|
||||
};
|
||||
invoke.mockReset();
|
||||
invoke.mockImplementation((cmd: string, args?: { command: string; params: Record<string, unknown> }) => {
|
||||
if (cmd === "engine_list_commands") {
|
||||
return Promise.resolve([
|
||||
{ id: "history.list", label: "List", menuPath: null, defaultShortcut: null, params: "", enabled: true },
|
||||
]);
|
||||
}
|
||||
if ((cmd === "engine_execute" || cmd === "engine_execute_waiting") && args) {
|
||||
calls.push({ command: args.command, params: args.params });
|
||||
return execute(args.command, args.params);
|
||||
}
|
||||
return Promise.reject(new Error(`unexpected ${cmd}`));
|
||||
});
|
||||
});
|
||||
|
||||
afterEach(async () => {
|
||||
await flushPromises();
|
||||
useCommandsStore(pinia).stop();
|
||||
for (const wrapper of mounted) {
|
||||
wrapper.unmount();
|
||||
}
|
||||
mounted = [];
|
||||
});
|
||||
|
||||
describe("Local History dialog", () => {
|
||||
it("lists the active tab's entries with time, reason and size", async () => {
|
||||
const { dialog } = await mountAll();
|
||||
await useCommandsStore(pinia).execute("history.show", {});
|
||||
await flushPromises();
|
||||
expect(calls.find((c) => c.command === "history.list")?.params).toEqual({ path: "src/a.php" });
|
||||
expect(dialog.find("#lt-history-title").text()).toBe("Local History of a.php");
|
||||
const rows = dialog.findAll("[data-test=history-row]");
|
||||
expect(rows.map((r) => r.text())).toEqual([
|
||||
"2026-11-08 10:15Saved6 B",
|
||||
"2026-11-08 09:00Changed by another program2 KiB",
|
||||
]);
|
||||
expect(document.activeElement?.getAttribute("data-test")).toBe("history-list");
|
||||
await dialog.find("[data-test=history-list]").trigger("keydown", { key: "ArrowDown" });
|
||||
expect(useLocalHistoryStore(pinia).current?.id).toBe(1);
|
||||
});
|
||||
|
||||
it("opens an entry against the buffer in a diff tab", async () => {
|
||||
const { dialog } = await mountAll();
|
||||
await useCommandsStore(pinia).execute("history.show", { path: "src/a.php" });
|
||||
await flushPromises();
|
||||
await dialog.find("[data-test=history-list]").trigger("keydown", { key: "Enter" });
|
||||
await flushPromises();
|
||||
expect(dialog.find("[data-test=local-history]").exists()).toBe(false);
|
||||
const diff = useDiffStore(pinia);
|
||||
expect(diff.activeTab?.key).toBe("history:2:src/a.php");
|
||||
expect(diff.activeContent?.left).toBe("second");
|
||||
expect(calls.find((c) => c.command === "history.read")?.params).toEqual({ path: "src/a.php", id: 2 });
|
||||
});
|
||||
|
||||
it("reverts through the engine, undoably in the editor", async () => {
|
||||
const { area, dialog } = await mountAll();
|
||||
await useCommandsStore(pinia).execute("history.show", {});
|
||||
await flushPromises();
|
||||
await dialog.findAll("[data-test=history-row]")[1]?.trigger("click");
|
||||
await dialog.find("[data-test=history-revert]").trigger("click");
|
||||
await flushPromises();
|
||||
expect(calls.find((c) => c.command === "history.revert")?.params).toEqual({ path: "src/a.php", id: 1 });
|
||||
expect(dialog.find("[data-test=local-history]").exists()).toBe(false);
|
||||
const view = EditorView.findFromDOM(area.find(".cm-editor").element as HTMLElement);
|
||||
expect(view?.state.doc.toString()).toBe("first");
|
||||
view?.contentDOM.dispatchEvent(new KeyboardEvent("keydown", { key: "z", ctrlKey: true, bubbles: true, cancelable: true }));
|
||||
await flushPromises();
|
||||
expect(view?.state.doc.toString()).toBe("current");
|
||||
});
|
||||
|
||||
it("says when there are no entries or the list failed", async () => {
|
||||
const { dialog } = await mountAll();
|
||||
listed = { path: "src/a.php", entries: [] };
|
||||
await useLocalHistoryStore(pinia).show("src/a.php");
|
||||
await flushPromises();
|
||||
expect(dialog.find("[data-test=history-hint]").text()).toContain("No Local History");
|
||||
expect(dialog.find("[data-test=history-diff]").attributes("disabled")).toBeDefined();
|
||||
listed = { nope: true };
|
||||
await useLocalHistoryStore(pinia).show("src/a.php");
|
||||
await flushPromises();
|
||||
expect(dialog.find("[data-test=history-error]").text()).toContain("history.list");
|
||||
await dialog.find("[data-test=history-cancel]").trigger("click");
|
||||
expect(dialog.find("[data-test=local-history]").exists()).toBe(false);
|
||||
});
|
||||
|
||||
it("refuses bad params and runs without a file", async () => {
|
||||
await mountAll();
|
||||
const history = useLocalHistoryStore(pinia);
|
||||
await expect(history.showCommand({ path: 3 })).rejects.toThrow("Show Local History takes");
|
||||
useEditorStore(pinia).activeId = null;
|
||||
await expect(history.showCommand({})).rejects.toThrow("Open or select a file");
|
||||
});
|
||||
});
|
||||
|
||||
describe("untrusted input", () => {
|
||||
it("checks list entries field by field", () => {
|
||||
expect(toEntries(null)).toBeNull();
|
||||
expect(toEntries({ entries: "x" })).toBeNull();
|
||||
expect(
|
||||
toEntries({
|
||||
entries: [
|
||||
{ id: 1, time: 2, reason: "save", size: 3 },
|
||||
{ id: "1", time: 2, reason: "save", size: 3 },
|
||||
{ id: 2, time: 2, reason: "unknown", size: 3 },
|
||||
null,
|
||||
],
|
||||
}),
|
||||
).toEqual([{ id: 1, time: 2, reason: "save", size: 3 }]);
|
||||
});
|
||||
|
||||
it("reads the params of history.show", () => {
|
||||
expect(parseShowParams(null)).toBe("");
|
||||
expect(parseShowParams({})).toBe("");
|
||||
expect(parseShowParams({ path: "a.php" })).toBe("a.php");
|
||||
expect(parseShowParams({ path: "" })).toBeNull();
|
||||
expect(parseShowParams([])).toBeNull();
|
||||
});
|
||||
});
|
||||
|
|
@ -178,7 +178,7 @@ describe("en.json", () => {
|
|||
it("uses flat dotted keys of known areas with string values", () => {
|
||||
for (const [key, value] of Object.entries(en)) {
|
||||
expect(key).toMatch(
|
||||
/^(app|command|project|editor|common|palette|theme|recovery|notification|settings|find|goto|structure|menu|terminal|problems|nav|vcs|deploy)\.[A-Za-z0-9]+(\.[A-Za-z0-9]+)*$/,
|
||||
/^(app|command|project|editor|common|palette|theme|recovery|notification|settings|find|goto|structure|menu|terminal|problems|nav|vcs|deploy|history)\.[A-Za-z0-9]+(\.[A-Za-z0-9]+)*$/,
|
||||
);
|
||||
expect(typeof value).toBe("string");
|
||||
expect(value.trim()).not.toBe("");
|
||||
|
|
|
|||
|
|
@ -272,6 +272,7 @@ describe("AppMenu", () => {
|
|||
"project.openDialog",
|
||||
"file.save",
|
||||
"file.saveAll",
|
||||
"history.show",
|
||||
"buffer.close",
|
||||
"project.close",
|
||||
"app.quit",
|
||||
|
|
|
|||
|
|
@ -475,7 +475,7 @@ describe("project tree context menu", () => {
|
|||
await tree.find("[data-path='a.php']").trigger("contextmenu", { clientX: 40, clientY: 50 });
|
||||
const menu = document.querySelector("[data-test=tree-menu]");
|
||||
expect(menu).not.toBeNull();
|
||||
expect([...document.querySelectorAll("[data-test=tree-menu-item]")].map((item) => item.textContent.trim())).toEqual(["Open", "Show Diff", "Show History", "Upload to Server", "Compare with Server", "Download from Server"]);
|
||||
expect([...document.querySelectorAll("[data-test=tree-menu-item]")].map((item) => item.textContent.trim())).toEqual(["Open", "Show Diff", "Show History", "Show Local History", "Upload to Server", "Compare with Server", "Download from Server"]);
|
||||
(document.querySelector("[data-item=showDiff]") as HTMLElement).click();
|
||||
await flushPromises();
|
||||
await flushPromises();
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue