feat(editor): support customizing snippet trigger key

This commit is contained in:
lxk955 authored and GitHub committed 2026-10-04 09:57:49 +08:00
1 parent b10ecd096c
commit 69687c1a84
25 files changed
+242 -10

No files matched your search

@@ -114,6 +114,7 @@ import {
normalizeMcpGlobalPolicy,
type ClickTableNavigationTarget,
type EditorSettings,
type SnippetTriggerKey,
type SqlCompletionTriggerMode,
type SqlTableCompletionSchemaQualification,
type TableHoverLookupMode,
@@ -967,6 +968,7 @@ function editableSnippet(snippet: SqlSnippet): SqlSnippet {
}
const editSnippets = ref<SqlSnippet[]>(settingsStore.editorSettings.snippets.map(editableSnippet));
const editSnippetTriggerKey = ref<SnippetTriggerKey>(settingsStore.editorSettings.snippetTriggerKey);
function editableSqlShortcut(action: SqlShortcutAction): SqlShortcutAction {
const next: SqlShortcutAction = { ...action, enabled: action.enabled !== false };
@@ -1179,6 +1181,7 @@ function currentEditorSettingsDraft(): EditorSettingsDraft {
updateDownloadSource: editUpdateDownloadSource.value,
toolbarItems: { ...editToolbarItems.value },
snippets: editSnippets.value,
snippetTriggerKey: editSnippetTriggerKey.value,
sqlShortcuts: editSqlShortcuts.value,
sqlVariableSubstitutionEnabled: editSqlVariableSubstitutionEnabled.value,
sqlVariableSyntaxOverrides: editSqlVariableSyntaxOverrides.value,
@@ -1851,6 +1854,7 @@ function syncEditorSettingsDraftFromStore() {
editUpdateDownloadSource.value = settingsStore.editorSettings.updateDownloadSource;
editToolbarItems.value = { ...settingsStore.editorSettings.toolbarItems };
editSnippets.value = settingsStore.editorSettings.snippets.map(editableSnippet);
editSnippetTriggerKey.value = settingsStore.editorSettings.snippetTriggerKey;
editSqlShortcuts.value = mergeDefaultSqlShortcuts(settingsStore.editorSettings.sqlShortcuts.map(editableSqlShortcut));
editSqlVariableSubstitutionEnabled.value = settingsStore.editorSettings.sqlVariableSubstitutionEnabled;
editSqlVariableSyntaxOverrides.value = normalizeSqlVariableSyntaxOverrides(settingsStore.editorSettings.sqlVariableSyntaxOverrides);
@@ -1997,6 +2001,7 @@ const editorSettingsDraftRefs: EditorSettingsDraftRefMap = {
updateDownloadSource: editUpdateDownloadSource,
toolbarItems: editToolbarItems,
snippets: editSnippets,
snippetTriggerKey: editSnippetTriggerKey,
sqlShortcuts: editSqlShortcuts,
sqlVariableSubstitutionEnabled: editSqlVariableSubstitutionEnabled,
sqlVariableSyntaxOverrides: editSqlVariableSyntaxOverrides,
@@ -2544,6 +2549,7 @@ function resetDefaultsForTab(tab: SettingsCategory) {
editShortcuts.value = normalizeShortcutSettings(DEFAULT_EDITOR_SETTINGS.shortcuts);
} else if (tab === "snippets") {
editSnippets.value = DEFAULT_SQL_SNIPPETS.map((s) => ({ ...s }));
editSnippetTriggerKey.value = DEFAULT_EDITOR_SETTINGS.snippetTriggerKey;
} else if (tab === "updates") {
editAutoUpdateApp.value = DEFAULT_EDITOR_SETTINGS.autoUpdateApp;
editAutoUpdateDrivers.value = DEFAULT_EDITOR_SETTINGS.autoUpdateDrivers;
@@ -2694,6 +2700,7 @@ function resetAllDefaults() {
editUpdateDownloadSource.value = DEFAULT_EDITOR_SETTINGS.updateDownloadSource;
editToolbarItems.value = { ...DEFAULT_EDITOR_SETTINGS.toolbarItems };
editSnippets.value = DEFAULT_SQL_SNIPPETS.map((s) => ({ ...s }));
editSnippetTriggerKey.value = DEFAULT_EDITOR_SETTINGS.snippetTriggerKey;
editSqlShortcuts.value = DEFAULT_SQL_SHORTCUTS.map(editableSqlShortcut);
}
@@ -2835,6 +2842,12 @@ function onCompletionTriggerModeChange(v: any) {
}
}
function onSnippetTriggerKeyChange(v: any) {
if (v === "tab" || v === "space" || v === "both") {
editSnippetTriggerKey.value = v;
}
}
function onTableCompletionSchemaQualificationChange(v: any) {
if (v === "never" || v === "collision" || v === "always") {
editTableCompletionSchemaQualification.value = v;
@@ -9395,6 +9408,26 @@ onUnmounted(() => {
{{ t("settings.snippetsAdd") }}
</Button>
</div>
<div data-settings-search-id="snippet-trigger-key" :class="['settings-item flex items-center justify-between gap-4 rounded-md border bg-muted/20 px-3 py-2', settingsSearchTargetClass('snippet-trigger-key')]">
<div class="min-w-0 space-y-1">
<Label>{{ t("settings.snippetTriggerKey") }}</Label>
<p class="text-xs leading-tight text-muted-foreground">
{{ t("settings.snippetTriggerKeyDescription") }}
</p>
</div>
<Select :model-value="editSnippetTriggerKey" @update:model-value="onSnippetTriggerKeyChange">
<SelectTrigger class="h-8 w-44 shrink-0">
<SelectValue :placeholder="t('settings.snippetTriggerKey')" />
</SelectTrigger>
<SelectContent>
<SelectItem value="tab">{{ t("settings.snippetTriggerKeyTab") }}</SelectItem>
<SelectItem value="space">{{ t("settings.snippetTriggerKeySpace") }}</SelectItem>
<SelectItem value="both">{{ t("settings.snippetTriggerKeyBoth") }}</SelectItem>
</SelectContent>
</Select>
</div>
<div class="rounded-md border bg-muted/30 px-3 py-2 text-xs text-muted-foreground">
<p>{{ t("settings.snippetsPlaceholderHint") }}</p>
<pre class="mt-2 overflow-x-auto whitespace-pre-wrap rounded bg-background/70 px-2 py-1.5 font-mono text-[11px] leading-relaxed text-foreground">
@@ -1812,7 +1812,7 @@ const completion = useQueryEditorCompletion({
});
const { triggerSqlCompletion, shouldTriggerSqlCompletionForPosition, scheduleSqlCompletionStart, consumeSqlCompletionAutoStartSuppression, scheduleDeferredCompletionTrigger, clearDeferredCompletionTrigger } = completion;
const { editorIndentUnit, handleTab, handleEnter, acceptCompletionOrNextSnippetField, acceptSqlServerCompletionOnSpace, clearPendingCompletionEnter, clearPendingCompletionTab } = useQueryEditorCompletionKeys({
const { editorIndentUnit, handleTab, handleEnter, acceptCompletionOrNextSnippetField, handleSpace, clearPendingCompletionEnter, clearPendingCompletionTab } = useQueryEditorCompletionKeys({
props,
settingsStore,
runtime: codeMirrorRuntime,
@@ -1998,7 +1998,7 @@ const codeMirrorLifecycle = useQueryEditorCodeMirror({
initializedRuntime.vimModeComp.of(vimModeExtension(initialSettings.vimModeEnabled)),
initializedRuntime.defaultKeymapComp.of(defaultKeymapExtension()),
keymap.of([...searchKeymapWithoutModD(searchKeymap), ...historyKeymap, ...foldKeymapWithoutAllBindings(foldKeymap, initializedRuntime.codeMirrorFoldAll, initializedRuntime.codeMirrorUnfoldAll), ...completionKeymap]),
Prec.highest(keymap.of([{ key: "Space", run: acceptSqlServerCompletionOnSpace }])),
Prec.highest(keymap.of([{ key: "Space", run: handleSpace }])),
initializedRuntime.sqlLanguageComp.of(sqlExtensions.buildSqlLanguageExtension()),
initializedRuntime.sqlSemanticHighlightComp.of(sqlExtensions.buildSqlSemanticHighlightExtension()),
createSqlUnknownObjectHighlights({
@@ -33,4 +33,10 @@ describe("EditorSettingsDialog settings search targets", () => {
expect(entry?.category).toBe(owningTab);
expect(dialogSource).toContain(`data-settings-search-id="${entry?.targetId}"`);
});
it("renders the snippet trigger key setting in the tab its search entry points at", () => {
const entry = SETTINGS_SEARCH_DEFINITIONS.find((definition) => definition.id === "snippet-trigger-key");
expect(entry?.category).toBe("snippets");
expect(dialogSource).toContain(`data-settings-search-id="${entry?.targetId}"`);
});
});
@@ -45,7 +45,7 @@ function createHarness(overrides: Partial<QueryEditorProps> = {}) {
codeMirrorSelectFirstCompletion: vi.fn(() => false),
codeMirrorInsertNewlineKeepIndent: newline,
});
const settings = reactive({ editorSettings: { sqlFormatter: { useTabs: false, tabWidth: 2 }, shortcuts: { acceptCompletion: "Tab" }, selectFirstCompletionOnOpen: false, sqlServerSpaceConfirmsCompletion: true } });
const settings = reactive({ editorSettings: { sqlFormatter: { useTabs: false, tabWidth: 2 }, shortcuts: { acceptCompletion: "Tab" }, selectFirstCompletionOnOpen: false, sqlServerSpaceConfirmsCompletion: true, snippetTriggerKey: "tab" as const } });
const completion = { suppressAutoStartUntil: 0 };
const keys = useQueryEditorCompletionKeys({ props, settingsStore: settings as Options["settingsStore"], runtime, completion, batchSelection: { applySelectedBatchColumnSelection: batch }, isEditorComposing: composing, retryDelayMs: 5, tabMaxWaitMs: 40, enterMaxWaitMs: 20 });
cleanups.push(() => {
@@ -174,4 +174,69 @@ describe("QueryEditor completion-key ownership", () => {
expect(view.state.doc.toString()).toBe("users ");
expect(view.state.selection.main.head).toBe(6);
});
it("accepts snippet completion on Tab when snippetTriggerKey is tab or both", () => {
const { keys, view, status, runtime, accept } = createHarness();
status.mockReturnValue("active");
runtime.codeMirrorSelectedCompletionIndex = () => 0;
runtime.codeMirrorSelectedCompletion = () => ({ label: "sel", type: "snippet" });
accept.mockReturnValue(true);
expect(keys.handleTab(view)).toBe(true);
expect(accept).toHaveBeenCalledOnce();
});
it("does not accept snippet completion on Tab when snippetTriggerKey is space", () => {
const { keys, view, status, runtime, accept, settings } = createHarness();
settings.editorSettings.snippetTriggerKey = "space";
status.mockReturnValue("active");
runtime.codeMirrorSelectedCompletionIndex = () => 0;
runtime.codeMirrorSelectedCompletion = () => ({ label: "sel", type: "snippet" });
accept.mockReturnValue(true);
expect(keys.handleTab(view)).toBe(true);
expect(accept).not.toHaveBeenCalled();
expect(view.state.doc.toString()).toBe("abc ");
});
it("accepts snippet completion on Space when snippetTriggerKey is space or both", () => {
const { keys, view, status, runtime, accept, settings } = createHarness();
settings.editorSettings.snippetTriggerKey = "space";
status.mockReturnValue("active");
runtime.codeMirrorSelectedCompletionIndex = () => 0;
runtime.codeMirrorSelectedCompletion = () => ({ label: "sel", type: "snippet" });
accept.mockReturnValue(true);
expect(keys.handleSpace(view)).toBe(true);
expect(accept).toHaveBeenCalledOnce();
accept.mockClear();
settings.editorSettings.snippetTriggerKey = "both";
expect(keys.handleSpace(view)).toBe(true);
expect(accept).toHaveBeenCalledOnce();
});
it("does not accept snippet completion on Space when snippetTriggerKey is tab", () => {
const { keys, view, status, runtime, accept, settings } = createHarness();
settings.editorSettings.snippetTriggerKey = "tab";
status.mockReturnValue("active");
runtime.codeMirrorSelectedCompletionIndex = () => 0;
runtime.codeMirrorSelectedCompletion = () => ({ label: "sel", type: "snippet" });
accept.mockReturnValue(true);
expect(keys.handleSpace(view)).toBe(false);
expect(accept).not.toHaveBeenCalled();
});
it("ignores Space for snippet completion while an IME composition is active", () => {
const { keys, view, status, runtime, accept, composing, settings } = createHarness();
settings.editorSettings.snippetTriggerKey = "space";
status.mockReturnValue("active");
runtime.codeMirrorSelectedCompletionIndex = () => 0;
runtime.codeMirrorSelectedCompletion = () => ({ label: "sel", type: "snippet" });
composing.mockReturnValue(true);
expect(keys.handleSpace(view)).toBe(false);
expect(accept).not.toHaveBeenCalled();
});
});
@@ -129,6 +129,24 @@ export function useQueryEditorCompletionKeys(options: QueryEditorCompletionKeysO
return handled;
}
function getTargetCompletion(view: EditorViewType): QueryCompletionOption | null {
const selected = codeMirrorRuntime.codeMirrorSelectedCompletion?.(view.state) as QueryCompletionOption | null | undefined;
if (selected) return selected;
const current = codeMirrorRuntime.codeMirrorCurrentCompletions?.(view.state) as QueryCompletionOption[] | undefined;
if (current && current.length > 0) {
return current[0] ?? null;
}
return null;
}
function canAcceptCurrentCompletionOnTab(view: EditorViewType): boolean {
if (settingsStore.editorSettings.snippetTriggerKey === "space") {
const target = getTargetCompletion(view);
if (target?.type === "snippet") return false;
}
return true;
}
function acceptCompletionOrNextSnippetField(view: EditorViewType): boolean {
// A non-empty selection belongs to snippet navigation or block indentation,
// not word completion. A popup opened by an indent edit must not hijack Tab.
@@ -136,12 +154,26 @@ export function useQueryEditorCompletionKeys(options: QueryEditorCompletionKeysO
if (view.state.selection.ranges.every((range) => range.empty)) {
const completionStatus = codeMirrorRuntime.codeMirrorCompletionStatus?.(view.state) ?? null;
if (isBatchColumnSelectionCompletionActive(completionStatus) && applySelectedBatchColumnSelection(view)) return true;
if (completionStatus === "active" && acceptSelectedOrFirstCompletion(view, codeMirrorRuntime.codeMirrorAcceptCompletion, codeMirrorRuntime.codeMirrorSelectedCompletionIndex, codeMirrorRuntime.codeMirrorSelectFirstCompletion)) return true;
if (completionStatus) return waitForCompletionTab(view);
if (completionStatus === "active" && canAcceptCurrentCompletionOnTab(view) && acceptSelectedOrFirstCompletion(view, codeMirrorRuntime.codeMirrorAcceptCompletion, codeMirrorRuntime.codeMirrorSelectedCompletionIndex, codeMirrorRuntime.codeMirrorSelectFirstCompletion)) return true;
if (completionStatus && canAcceptCurrentCompletionOnTab(view)) return waitForCompletionTab(view);
}
return codeMirrorRuntime.codeMirrorNextSnippetField?.(view) ?? false;
}
function acceptSnippetCompletionOnSpace(view: EditorViewType): boolean {
if (isEditorComposing(view)) return false;
const triggerKey = settingsStore.editorSettings.snippetTriggerKey;
if (triggerKey !== "space" && triggerKey !== "both") return false;
if (codeMirrorRuntime.codeMirrorCompletionStatus?.(view.state) !== "active") return false;
if (!view.state.selection.main.empty) return false;
const target = getTargetCompletion(view);
if (target?.type !== "snippet") return false;
if (target?.dbxBatchColumnSelection || target?.dbxBatchColumnSelectionAction) return false;
return acceptSelectedOrFirstCompletion(view, codeMirrorRuntime.codeMirrorAcceptCompletion, codeMirrorRuntime.codeMirrorSelectedCompletionIndex, codeMirrorRuntime.codeMirrorSelectFirstCompletion);
}
function acceptSqlServerCompletionOnSpace(view: EditorViewType): boolean {
if (isEditorComposing(view)) return false;
if (props.databaseType !== "sqlserver" || !settingsStore.editorSettings.sqlServerSpaceConfirmsCompletion) return false;
@@ -174,6 +206,13 @@ export function useQueryEditorCompletionKeys(options: QueryEditorCompletionKeysO
return true;
}
function handleSpace(view: EditorViewType): boolean {
if (isEditorComposing(view)) return false;
if (!view.state.selection.main.empty) return false;
if (acceptSnippetCompletionOnSpace(view)) return true;
return acceptSqlServerCompletionOnSpace(view);
}
function clearPendingCompletionTab() {
if (pendingCompletionTabTimer === null) return;
clearTimeout(pendingCompletionTabTimer);
@@ -196,8 +235,8 @@ export function useQueryEditorCompletionKeys(options: QueryEditorCompletionKeysO
if (view.state.doc !== initialDoc || selectionRanges.length !== initialSelectionRanges.length || selectionRanges.some((range, index) => !range.empty || range.anchor !== initialSelectionRanges[index]?.anchor || range.head !== initialSelectionRanges[index]?.head)) return;
const completionStatus = codeMirrorRuntime.codeMirrorCompletionStatus?.(view.state) ?? null;
if (completionStatus === "active" && acceptSelectedOrFirstCompletion(view, codeMirrorRuntime.codeMirrorAcceptCompletion, codeMirrorRuntime.codeMirrorSelectedCompletionIndex, codeMirrorRuntime.codeMirrorSelectFirstCompletion)) return;
if (completionStatus && Date.now() - startedAt < COMPLETION_TAB_MAX_WAIT_MS) {
if (completionStatus === "active" && canAcceptCurrentCompletionOnTab(view) && acceptSelectedOrFirstCompletion(view, codeMirrorRuntime.codeMirrorAcceptCompletion, codeMirrorRuntime.codeMirrorSelectedCompletionIndex, codeMirrorRuntime.codeMirrorSelectFirstCompletion)) return;
if (completionStatus && Date.now() - startedAt < COMPLETION_TAB_MAX_WAIT_MS && canAcceptCurrentCompletionOnTab(view)) {
pendingCompletionTabTimer = setTimeout(retry, COMPLETION_TAB_RETRY_DELAY_MS);
return;
}
@@ -212,5 +251,5 @@ export function useQueryEditorCompletionKeys(options: QueryEditorCompletionKeysO
return true;
}
return { editorIndentUnit, handleTab, handleEnter, acceptCompletionOrNextSnippetField, acceptSqlServerCompletionOnSpace, clearPendingCompletionEnter, clearPendingCompletionTab };
return { editorIndentUnit, handleTab, handleEnter, acceptCompletionOrNextSnippetField, acceptSqlServerCompletionOnSpace, acceptSnippetCompletionOnSpace, handleSpace, clearPendingCompletionEnter, clearPendingCompletionTab };
}