feat(editor): restore SQL pasted from source code
This commit is contained in:
25 files changed
+889
-1
No files matched your search
@@ -697,6 +697,7 @@ const editDdlOpenMode = ref<EditorSettings["ddlOpenMode"]>(settingsStore.editorS
|
||||
const editVimModeEnabled = ref(settingsStore.editorSettings.vimModeEnabled);
|
||||
const editDoubleClickStringSelectionMode = ref<EditorSettings["doubleClickStringSelectionMode"]>(settingsStore.editorSettings.doubleClickStringSelectionMode);
|
||||
const editAutoCloseBrackets = ref(settingsStore.editorSettings.autoCloseBrackets);
|
||||
const editRestoreSqlFromSourcePasteEnabled = ref(settingsStore.editorSettings.restoreSqlFromSourcePasteEnabled);
|
||||
const editSqlSemanticDiagnosticsMode = ref<SqlSemanticDiagnosticsMode>(settingsStore.editorSettings.sqlSemanticDiagnosticsMode);
|
||||
const editSqlSemanticDiagnosticsEnabled = ref(settingsStore.editorSettings.sqlSemanticDiagnosticsEnabled);
|
||||
const editConfirmDangerousSqlExecution = ref(settingsStore.editorSettings.confirmDangerousSqlExecution);
|
||||
@@ -1062,6 +1063,7 @@ function currentEditorSettingsDraft(): EditorSettingsDraft {
|
||||
vimModeEnabled: editVimModeEnabled.value,
|
||||
doubleClickStringSelectionMode: editDoubleClickStringSelectionMode.value,
|
||||
autoCloseBrackets: editAutoCloseBrackets.value,
|
||||
restoreSqlFromSourcePasteEnabled: editRestoreSqlFromSourcePasteEnabled.value,
|
||||
sqlSemanticDiagnosticsMode: editSqlSemanticDiagnosticsMode.value,
|
||||
confirmDangerousSqlExecution: editConfirmDangerousSqlExecution.value,
|
||||
continueOnErrorOnBatch: editContinueOnErrorOnBatch.value,
|
||||
@@ -1726,6 +1728,7 @@ function syncEditorSettingsDraftFromStore() {
|
||||
editVimModeEnabled.value = settingsStore.editorSettings.vimModeEnabled;
|
||||
editDoubleClickStringSelectionMode.value = settingsStore.editorSettings.doubleClickStringSelectionMode;
|
||||
editAutoCloseBrackets.value = settingsStore.editorSettings.autoCloseBrackets;
|
||||
editRestoreSqlFromSourcePasteEnabled.value = settingsStore.editorSettings.restoreSqlFromSourcePasteEnabled;
|
||||
editSqlSemanticDiagnosticsMode.value = settingsStore.editorSettings.sqlSemanticDiagnosticsMode;
|
||||
editSqlSemanticDiagnosticsEnabled.value = settingsStore.editorSettings.sqlSemanticDiagnosticsEnabled;
|
||||
editConfirmDangerousSqlExecution.value = settingsStore.editorSettings.confirmDangerousSqlExecution;
|
||||
@@ -1868,6 +1871,7 @@ const editorSettingsDraftRefs: EditorSettingsDraftRefMap = {
|
||||
vimModeEnabled: editVimModeEnabled,
|
||||
doubleClickStringSelectionMode: editDoubleClickStringSelectionMode,
|
||||
autoCloseBrackets: editAutoCloseBrackets,
|
||||
restoreSqlFromSourcePasteEnabled: editRestoreSqlFromSourcePasteEnabled,
|
||||
sqlSemanticDiagnosticsMode: editSqlSemanticDiagnosticsMode,
|
||||
confirmDangerousSqlExecution: editConfirmDangerousSqlExecution,
|
||||
confirmUnsavedSqlClose: editConfirmUnsavedSqlClose,
|
||||
@@ -2362,6 +2366,7 @@ function resetDefaultsForTab(tab: SettingsCategory) {
|
||||
editVimModeEnabled.value = DEFAULT_EDITOR_SETTINGS.vimModeEnabled;
|
||||
editDoubleClickStringSelectionMode.value = DEFAULT_EDITOR_SETTINGS.doubleClickStringSelectionMode;
|
||||
editAutoCloseBrackets.value = DEFAULT_EDITOR_SETTINGS.autoCloseBrackets;
|
||||
editRestoreSqlFromSourcePasteEnabled.value = DEFAULT_EDITOR_SETTINGS.restoreSqlFromSourcePasteEnabled;
|
||||
editSqlSemanticDiagnosticsMode.value = DEFAULT_EDITOR_SETTINGS.sqlSemanticDiagnosticsMode;
|
||||
editSqlSemanticDiagnosticsEnabled.value = DEFAULT_EDITOR_SETTINGS.sqlSemanticDiagnosticsEnabled;
|
||||
editConfirmDangerousSqlExecution.value = DEFAULT_EDITOR_SETTINGS.confirmDangerousSqlExecution;
|
||||
@@ -2524,6 +2529,7 @@ function resetAllDefaults() {
|
||||
editVimModeEnabled.value = DEFAULT_EDITOR_SETTINGS.vimModeEnabled;
|
||||
editDoubleClickStringSelectionMode.value = DEFAULT_EDITOR_SETTINGS.doubleClickStringSelectionMode;
|
||||
editAutoCloseBrackets.value = DEFAULT_EDITOR_SETTINGS.autoCloseBrackets;
|
||||
editRestoreSqlFromSourcePasteEnabled.value = DEFAULT_EDITOR_SETTINGS.restoreSqlFromSourcePasteEnabled;
|
||||
editSqlSemanticDiagnosticsMode.value = DEFAULT_EDITOR_SETTINGS.sqlSemanticDiagnosticsMode;
|
||||
editSqlSemanticDiagnosticsEnabled.value = DEFAULT_EDITOR_SETTINGS.sqlSemanticDiagnosticsEnabled;
|
||||
editConfirmDangerousSqlExecution.value = DEFAULT_EDITOR_SETTINGS.confirmDangerousSqlExecution;
|
||||
@@ -6714,6 +6720,16 @@ onUnmounted(() => {
|
||||
<Switch id="editor-auto-close-brackets" v-model="editAutoCloseBrackets" class="mt-0.5" />
|
||||
</div>
|
||||
|
||||
<div class="settings-item flex items-center justify-between gap-4 rounded-md border bg-muted/20 px-3 py-2">
|
||||
<div class="space-y-1">
|
||||
<Label for="editor-restore-sql-from-source-paste">{{ t("settings.restoreSqlFromSourcePaste") }}</Label>
|
||||
<p class="text-xs text-muted-foreground">
|
||||
{{ t("settings.restoreSqlFromSourcePasteDescription") }}
|
||||
</p>
|
||||
</div>
|
||||
<Switch id="editor-restore-sql-from-source-paste" v-model="editRestoreSqlFromSourcePasteEnabled" class="mt-0.5" />
|
||||
</div>
|
||||
|
||||
<div class="settings-item flex items-center justify-between gap-4 rounded-md border bg-muted/20 px-3 py-2">
|
||||
<div class="space-y-1">
|
||||
<Label for="editor-insert-space-after-completion">{{ t("settings.insertSpaceAfterCompletion") }}</Label>
|
||||
|
||||
@@ -69,6 +69,7 @@ import { looksLikeDmlStatement } from "@/lib/sql/dmlChangePreview";
|
||||
|
||||
import { canFormatSqlForDatabaseType, formatSqlForEditing, compressSqlText } from "@/lib/sql/sqlFormatter";
|
||||
import { detectAndFormatStructured } from "@/lib/sql/autoFormat";
|
||||
import { restoreSqlFromSourcePaste } from "@/lib/sql/sqlSourcePaste";
|
||||
import { enabledSqlParameterSyntaxes, resolveSqlVariableSyntaxToggles } from "@/lib/sql/sqlVariableSyntax";
|
||||
|
||||
import { createQueryEditorExecutionViewportOwnership, isQueryEditorPositionVisible } from "@/lib/editor/queryEditorExecutionViewport";
|
||||
@@ -281,6 +282,7 @@ const {
|
||||
copySelectedSqlAsRichTextFromContextMenu,
|
||||
cutSelectedSqlFromContextMenu,
|
||||
pasteClipboardSqlFromContextMenu,
|
||||
pasteClipboardSqlRestoringSource,
|
||||
toggleCommentFromContextMenu,
|
||||
toggleBlockCommentFromContextMenu,
|
||||
selectAllSqlFromContextMenu,
|
||||
@@ -1038,6 +1040,34 @@ function resyncCaretAfterPaste(view: EditorViewType) {
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* 粘贴时尝试把「源码里的字符串拼接 SQL」(Java/JS/Python 等)还原为普通 SQL。
|
||||
* 命中后自行插入并阻止默认粘贴;未命中返回 false,交给原有粘贴流程处理。
|
||||
*/
|
||||
function tryRestoreSqlFromSourcePaste(event: ClipboardEvent, currentView: EditorViewType): boolean {
|
||||
if (props.readOnly || !settingsStore.editorSettings.restoreSqlFromSourcePasteEnabled) return false;
|
||||
if (currentView.state.selection.ranges.length !== 1) return false;
|
||||
const eventText = event.clipboardData?.getData("text/plain") ?? "";
|
||||
if (!eventText) return false;
|
||||
// Tauri 下超长文本会被 WebView 截断、之后异步补写后半段,这里不参与还原以免破坏片段边界
|
||||
if (shouldRecoverLargeTauriPaste(eventText, isTauriRuntime())) return false;
|
||||
|
||||
const restored = restoreSqlFromSourcePaste(eventText);
|
||||
if (!restored.changed) return false;
|
||||
|
||||
event.preventDefault();
|
||||
const selection = currentView.state.selection.main;
|
||||
const insertedText = normalizeQueryEditorPasteText(restored.sql);
|
||||
currentView.dispatch({
|
||||
changes: { from: selection.from, to: selection.to, insert: insertedText },
|
||||
selection: { anchor: selection.from + insertedText.length },
|
||||
scrollIntoView: true,
|
||||
userEvent: "input.paste",
|
||||
});
|
||||
toast(t("editor.sqlSourcePasteRestored"), 2000);
|
||||
return true;
|
||||
}
|
||||
|
||||
function recoverLargeTauriPaste(event: ClipboardEvent, currentView: EditorViewType): boolean {
|
||||
const eventText = event.clipboardData?.getData("text/plain") ?? "";
|
||||
if (props.readOnly || currentView.state.selection.ranges.length !== 1 || !shouldRecoverLargeTauriPaste(eventText, isTauriRuntime())) return false;
|
||||
@@ -1166,6 +1196,7 @@ const contextMenuActions: QueryEditorContextMenuActions = {
|
||||
copySelectedSqlAsRichTextFromContextMenu,
|
||||
cutSelectedSqlFromContextMenu,
|
||||
pasteClipboardSqlFromContextMenu,
|
||||
pasteClipboardSqlRestoringSource,
|
||||
convertSelectedSqlCase,
|
||||
convertSelectedNamingStyle,
|
||||
openDelimitedListDialog,
|
||||
@@ -2055,6 +2086,7 @@ const codeMirrorLifecycle = useQueryEditorCodeMirror({
|
||||
),
|
||||
EditorView.domEventHandlers({
|
||||
paste(event, currentView) {
|
||||
if (tryRestoreSqlFromSourcePaste(event, currentView)) return true;
|
||||
return recoverLargeTauriPaste(event, currentView);
|
||||
},
|
||||
dragover(event) {
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<script setup lang="ts">
|
||||
import { computed } from "vue";
|
||||
import { useI18n } from "vue-i18n";
|
||||
import { AlignLeft, Camera, CaseLower, CaseSensitive, CaseUpper, ClipboardPaste, Code2, Columns3, Download, Eye, FileCode, Highlighter, MessageSquareText, Minimize2, Pencil, PencilRuler, Play, Copy, List, Scissors, Search, Sparkles, Table2, TextSelect, Trash2 } from "@lucide/vue";
|
||||
import { AlignLeft, Camera, CaseLower, CaseSensitive, CaseUpper, ClipboardPaste, Code2, Columns3, Download, Eye, FileCode, Highlighter, MessageSquareText, Minimize2, Pencil, PencilRuler, Play, Copy, List, Scissors, Search, Sparkles, Table2, TextSelect, Trash2, WandSparkles } from "@lucide/vue";
|
||||
import CustomContextMenu, { type ContextMenuItem } from "@/components/ui/CustomContextMenu.vue";
|
||||
import { canFormatSqlForDatabaseType } from "@/lib/sql/sqlFormatter";
|
||||
import { supportsQueryEditorBlockComments } from "@/lib/database/databaseFeatureSupport";
|
||||
@@ -35,6 +35,7 @@ export interface QueryEditorContextMenuActions {
|
||||
copySelectedSqlAsRichTextFromContextMenu: () => void;
|
||||
cutSelectedSqlFromContextMenu: () => void;
|
||||
pasteClipboardSqlFromContextMenu: () => void;
|
||||
pasteClipboardSqlRestoringSource: () => void;
|
||||
convertSelectedSqlCase: (mode: "upper" | "lower") => void;
|
||||
convertSelectedNamingStyle: () => void;
|
||||
openDelimitedListDialog: () => void;
|
||||
@@ -215,6 +216,13 @@ const contextMenuItems = computed<ContextMenuItem[]>(() => {
|
||||
icon: ClipboardPaste,
|
||||
shortcut: "Mod+V",
|
||||
},
|
||||
{
|
||||
// 显式入口:即使关闭了「粘贴时自动还原源码 SQL」设置也能使用
|
||||
label: t("editor.contextMenu.pasteRestoringSourceSql"),
|
||||
action: actions.pasteClipboardSqlRestoringSource,
|
||||
disabled: state.readOnly,
|
||||
icon: WandSparkles,
|
||||
},
|
||||
{
|
||||
label: t("editor.contextMenu.sendToAi"),
|
||||
action: () => {
|
||||
|
||||
+122
@@ -0,0 +1,122 @@
|
||||
// @vitest-environment happy-dom
|
||||
|
||||
import { createApp, h, nextTick, reactive, shallowRef } from "vue";
|
||||
import { createPinia, setActivePinia } from "pinia";
|
||||
import { createI18n } from "vue-i18n";
|
||||
import { EditorView } from "@codemirror/view";
|
||||
import { afterEach, describe, expect, it, vi } from "vitest";
|
||||
import QueryEditor from "../QueryEditor.vue";
|
||||
import { useSettingsStore } from "@/stores/settingsStore";
|
||||
import { useConnectionStore } from "@/stores/connectionStore";
|
||||
import type { QueryEditorProps } from "../queryEditorTypes";
|
||||
|
||||
vi.mock("@/lib/common/clipboard", () => ({
|
||||
copyToClipboard: vi.fn().mockResolvedValue(undefined),
|
||||
readTextFromClipboard: vi.fn().mockResolvedValue(""),
|
||||
}));
|
||||
|
||||
// Java 风格:字符串拼接 + 源码层 `\n` 转义
|
||||
const SOURCE_SQL = '"SELECT * " +\n"FROM users \\n " +\n"WHERE id = 1"';
|
||||
const RESTORED_SQL = "SELECT * FROM users \n WHERE id = 1";
|
||||
const PLAIN_SQL = "SELECT * FROM users WHERE id = 1";
|
||||
|
||||
const cleanups: Array<() => void> = [];
|
||||
|
||||
afterEach(() => {
|
||||
for (const cleanup of cleanups.splice(0).reverse()) cleanup();
|
||||
vi.restoreAllMocks();
|
||||
});
|
||||
|
||||
async function mountEditor(overrides: Partial<QueryEditorProps> = {}) {
|
||||
const pinia = createPinia();
|
||||
setActivePinia(pinia);
|
||||
const settingsStore = useSettingsStore();
|
||||
useConnectionStore();
|
||||
const props = reactive<QueryEditorProps>({ modelValue: "", tabId: "source-paste", databaseType: "mysql", dialect: "mysql", autoFocus: false, ...overrides });
|
||||
const editor = shallowRef<InstanceType<typeof QueryEditor>>();
|
||||
const host = document.createElement("div");
|
||||
document.body.append(host);
|
||||
const app = createApp({
|
||||
render: () =>
|
||||
h(QueryEditor, {
|
||||
...props,
|
||||
ref: editor,
|
||||
"onUpdate:modelValue": (value: string) => {
|
||||
props.modelValue = value;
|
||||
},
|
||||
}),
|
||||
});
|
||||
app.use(pinia);
|
||||
app.use(createI18n({ legacy: false, locale: "en", messages: { en: {} }, missingWarn: false, fallbackWarn: false }));
|
||||
app.mount(host);
|
||||
cleanups.push(() => {
|
||||
app.unmount();
|
||||
host.remove();
|
||||
});
|
||||
await vi.waitFor(() => expect(host.querySelector(".cm-editor")).not.toBeNull(), { timeout: 5000 });
|
||||
const view = EditorView.findFromDOM(host.querySelector(".cm-editor") as HTMLElement)!;
|
||||
return { view, props, settingsStore };
|
||||
}
|
||||
|
||||
/** 构造带纯文本剪贴板内容的 paste 事件(happy-dom 没有 ClipboardEvent 实现) */
|
||||
function pasteEvent(text: string): Event {
|
||||
const event = new Event("paste", { bubbles: true, cancelable: true });
|
||||
Object.defineProperty(event, "clipboardData", { value: { getData: (type: string) => (type === "text/plain" ? text : "") } });
|
||||
return event;
|
||||
}
|
||||
|
||||
async function pasteInto(view: EditorView, text: string): Promise<Event> {
|
||||
const event = pasteEvent(text);
|
||||
view.contentDOM.dispatchEvent(event);
|
||||
await nextTick();
|
||||
return event;
|
||||
}
|
||||
|
||||
describe("QueryEditor source-code SQL paste", () => {
|
||||
it("restores concatenated source SQL when the setting is enabled", async () => {
|
||||
const { view, settingsStore } = await mountEditor();
|
||||
expect(settingsStore.editorSettings.restoreSqlFromSourcePasteEnabled).toBe(true);
|
||||
|
||||
await pasteInto(view, SOURCE_SQL);
|
||||
expect(view.state.doc.toString()).toBe(RESTORED_SQL);
|
||||
});
|
||||
|
||||
it("claims the paste event when it restores the SQL", async () => {
|
||||
const { view } = await mountEditor();
|
||||
|
||||
// 还原路径自己完成插入并阻止默认粘贴,保证只写入一次
|
||||
const event = await pasteInto(view, SOURCE_SQL);
|
||||
expect(event.defaultPrevented).toBe(true);
|
||||
expect(view.state.doc.toString()).toBe(RESTORED_SQL);
|
||||
});
|
||||
|
||||
it("keeps the pasted text untouched when the setting is disabled", async () => {
|
||||
const { view, settingsStore } = await mountEditor();
|
||||
settingsStore.editorSettings.restoreSqlFromSourcePasteEnabled = false;
|
||||
|
||||
await pasteInto(view, SOURCE_SQL);
|
||||
expect(view.state.doc.toString()).not.toBe(RESTORED_SQL);
|
||||
});
|
||||
|
||||
it("keeps the pasted text untouched when the editor is read-only", async () => {
|
||||
const { view } = await mountEditor({ readOnly: true });
|
||||
|
||||
await pasteInto(view, SOURCE_SQL);
|
||||
expect(view.state.doc.toString()).toBe("");
|
||||
});
|
||||
|
||||
it("replaces the current selection with the restored SQL as one undoable edit", async () => {
|
||||
const { view } = await mountEditor({ modelValue: "SELECT 0" });
|
||||
view.dispatch({ selection: { anchor: 0, head: view.state.doc.length } });
|
||||
|
||||
await pasteInto(view, SOURCE_SQL);
|
||||
expect(view.state.doc.toString()).toBe(RESTORED_SQL);
|
||||
});
|
||||
|
||||
it("leaves plain SQL paste to the default editor behavior", async () => {
|
||||
const { view } = await mountEditor();
|
||||
|
||||
await pasteInto(view, PLAIN_SQL);
|
||||
expect(view.state.doc.toString()).not.toBe(RESTORED_SQL);
|
||||
});
|
||||
});
|
||||
+16
@@ -133,6 +133,22 @@ describe("QueryEditor extracted text actions", () => {
|
||||
expect(clipboard.readTextFromClipboard).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("restores source-code SQL through the explicit paste action", async () => {
|
||||
clipboard.readTextFromClipboard.mockResolvedValue('"SELECT * " +\n"FROM users \\n " +\n"WHERE id = 1"');
|
||||
const { actions, editorView } = mountActions("");
|
||||
await actions.pasteClipboardSqlRestoringSource();
|
||||
expect(editorView.state.doc.toString()).toBe("SELECT * FROM users \n WHERE id = 1");
|
||||
expect(undo(editorView)).toBe(true);
|
||||
expect(editorView.state.doc.toString()).toBe("");
|
||||
});
|
||||
|
||||
it("pastes the original text when the clipboard is not a source-code SQL concatenation", async () => {
|
||||
clipboard.readTextFromClipboard.mockResolvedValue("SELECT * FROM users");
|
||||
const { actions, editorView } = mountActions("");
|
||||
await actions.pasteClipboardSqlRestoringSource();
|
||||
expect(editorView.state.doc.toString()).toBe("SELECT * FROM users");
|
||||
});
|
||||
|
||||
it("preserves multi-range case conversion and selects each replacement", () => {
|
||||
const { actions, editorView } = mountActions("select id, name from users");
|
||||
editorView.dispatch({ selection: EditorSelection.create([EditorSelection.range(0, 6), EditorSelection.range(16, 20)]) });
|
||||
|
||||
@@ -8,6 +8,7 @@ import { copyToClipboard, readTextFromClipboard } from "@/lib/common/clipboard";
|
||||
import { blankLineDeletionChanges, replaceSelectedEditorText } from "@/lib/editor/queryEditorTextEdits";
|
||||
import { queryEditorClipboardPasteChange } from "@/lib/editor/queryEditorClipboardPaste";
|
||||
import { buildSqlInConditionFromPasteSource, insertTextForSqlInCondition } from "@/lib/sql/sqlInListPaste";
|
||||
import { restoreSqlFromSourcePaste } from "@/lib/sql/sqlSourcePaste";
|
||||
import { convertSqlSelectionCase, type SqlSelectionCaseMode } from "@/lib/sql/sqlSelectionCase";
|
||||
import { convertToNextNamingStyle } from "@/lib/naming/namingStyleConverter";
|
||||
import { copySqlAsRichText } from "@/lib/sql/sqlRichText";
|
||||
@@ -125,6 +126,29 @@ export function useQueryEditorTextActions(options: QueryEditorTextActionsOptions
|
||||
}
|
||||
}
|
||||
|
||||
// 粘贴并还原源码 SQL:显式入口,即使「粘贴时自动还原」开关关闭也可以使用
|
||||
async function pasteClipboardSqlRestoringSource() {
|
||||
if (props.readOnly) return;
|
||||
const currentView = view.value;
|
||||
if (!currentView) return;
|
||||
try {
|
||||
const text = await readTextFromClipboard();
|
||||
if (!text) return;
|
||||
const result = restoreSqlFromSourcePaste(text);
|
||||
const selection = currentView.state.selection.main;
|
||||
currentView.dispatch({
|
||||
...queryEditorClipboardPasteChange(result.sql, selection.from, selection.to),
|
||||
scrollIntoView: true,
|
||||
userEvent: "input.paste",
|
||||
});
|
||||
// 未识别时也照常插入原文,但要提示用户没有发生还原
|
||||
toast(result.changed ? t("editor.sqlSourcePasteRestored") : t("editor.sqlSourcePasteNotDetected"), result.changed ? 2000 : 3000);
|
||||
focusEditor();
|
||||
} catch (e: any) {
|
||||
toast(t("editor.contextMenu.pasteClipboardReadFailed", { message: e?.message || String(e) }), 5000);
|
||||
}
|
||||
}
|
||||
|
||||
function toggleCommentFromContextMenu() {
|
||||
const currentView = view.value;
|
||||
if (!currentView || props.readOnly) return;
|
||||
@@ -291,6 +315,7 @@ export function useQueryEditorTextActions(options: QueryEditorTextActionsOptions
|
||||
copySelectedSqlAsRichTextFromContextMenu,
|
||||
cutSelectedSqlFromContextMenu,
|
||||
pasteClipboardSqlFromContextMenu,
|
||||
pasteClipboardSqlRestoringSource,
|
||||
toggleCommentFromContextMenu,
|
||||
toggleBlockCommentFromContextMenu,
|
||||
selectAllSqlFromContextMenu,
|
||||
|
||||
Reference in new issue
Block a user