feat(editor): optional space completion confirmation for SQL Server
This commit is contained in:
24 files changed
+202
-2
No files matched your search
@@ -37,6 +37,7 @@ interface MockState {
|
||||
doc: {
|
||||
lineAt: (position: number) => { from: number; text: string };
|
||||
};
|
||||
sliceDoc: (from: number, to: number) => string;
|
||||
selection: { main: MockSelection; ranges: MockSelection[] };
|
||||
replaceSelection: ReturnType<typeof vi.fn>;
|
||||
update: ReturnType<typeof vi.fn>;
|
||||
@@ -52,12 +53,15 @@ interface TabHarness {
|
||||
handleEnter: (view: MockView) => boolean;
|
||||
insertNewlineWithoutCompletion: (view: MockView) => boolean;
|
||||
acceptCompletionOrNextSnippetField: (view: MockView) => boolean;
|
||||
acceptSqlServerCompletionOnSpace: (view: MockView) => boolean;
|
||||
clearPendingCompletionTab: () => void;
|
||||
consumeSqlCompletionAutoStartSuppression: () => boolean;
|
||||
}
|
||||
|
||||
function createHarness(options: {
|
||||
databaseType?: string;
|
||||
completionStatus: (state: MockState) => "active" | "pending" | null;
|
||||
selectedCompletion?: (state: MockState) => { type?: string } | null;
|
||||
acceptCompletion?: (view: MockView) => boolean;
|
||||
selectedCompletionIndex?: (state: MockState) => number | null;
|
||||
selectFirstCompletion?: (view: MockView) => boolean;
|
||||
@@ -68,6 +72,7 @@ function createHarness(options: {
|
||||
indentMore?: (view: MockView) => boolean;
|
||||
acceptCompletionShortcut?: string;
|
||||
selectFirstCompletionOnOpen?: boolean;
|
||||
sqlServerSpaceConfirmsCompletion?: boolean;
|
||||
imeComposing?: (view: MockView) => boolean;
|
||||
}): TabHarness {
|
||||
const source = [
|
||||
@@ -88,6 +93,7 @@ function createHarness(options: {
|
||||
extractFunction("clearPendingCompletionEnter"),
|
||||
extractFunction("insertNewlineWithoutCompletion"),
|
||||
extractFunction("acceptCompletionOrNextSnippetField"),
|
||||
extractFunction("acceptSqlServerCompletionOnSpace"),
|
||||
extractFunction("clearPendingCompletionTab"),
|
||||
extractFunction("waitForCompletionTab"),
|
||||
extractFunction("consumeSqlCompletionAutoStartSuppression"),
|
||||
@@ -97,6 +103,7 @@ function createHarness(options: {
|
||||
}).outputText;
|
||||
const factory = new Function(
|
||||
"codeMirrorCompletionStatus",
|
||||
"codeMirrorSelectedCompletion",
|
||||
"isBatchColumnSelectionCompletionActive",
|
||||
"codeMirrorAcceptCompletion",
|
||||
"codeMirrorSelectedCompletionIndex",
|
||||
@@ -114,10 +121,11 @@ function createHarness(options: {
|
||||
"shortcutToCodeMirrorKey",
|
||||
"props",
|
||||
"isEditorComposing",
|
||||
`${javascript}\nreturn { handleTab, handleEnter, insertNewlineWithoutCompletion, acceptCompletionOrNextSnippetField, clearPendingCompletionTab, consumeSqlCompletionAutoStartSuppression };`,
|
||||
`${javascript}\nreturn { handleTab, handleEnter, insertNewlineWithoutCompletion, acceptCompletionOrNextSnippetField, acceptSqlServerCompletionOnSpace, clearPendingCompletionTab, consumeSqlCompletionAutoStartSuppression };`,
|
||||
);
|
||||
return factory(
|
||||
options.completionStatus,
|
||||
options.selectedCompletion ?? (() => ({ type: "column" })),
|
||||
(status: "active" | "pending" | null) => status === "active",
|
||||
options.acceptCompletion ?? (() => false),
|
||||
options.selectedCompletionIndex ?? (() => 0),
|
||||
@@ -135,11 +143,12 @@ function createHarness(options: {
|
||||
sqlFormatter: { useTabs: false, tabWidth: 2 },
|
||||
shortcuts: { ...DEFAULT_SHORTCUT_SETTINGS, acceptCompletion: options.acceptCompletionShortcut ?? DEFAULT_SHORTCUT_SETTINGS.acceptCompletion },
|
||||
selectFirstCompletionOnOpen: options.selectFirstCompletionOnOpen ?? false,
|
||||
sqlServerSpaceConfirmsCompletion: options.sqlServerSpaceConfirmsCompletion ?? true,
|
||||
},
|
||||
},
|
||||
normalizeShortcutSettings,
|
||||
shortcutToCodeMirrorKey,
|
||||
{ databaseType: "mysql" },
|
||||
{ databaseType: options.databaseType ?? "mysql" },
|
||||
options.imeComposing ?? ((view: MockView) => (view as MockView & { composing?: boolean }).composing === true || (view as MockView & { compositionStarted?: boolean }).compositionStarted === true),
|
||||
) as TabHarness;
|
||||
}
|
||||
@@ -150,6 +159,7 @@ function createView(text = "SELECT", position = text.length, selectionOverrides:
|
||||
doc: {
|
||||
lineAt: () => ({ from: 0, text }),
|
||||
},
|
||||
sliceDoc: (from, to) => text.slice(from, to),
|
||||
selection: { main: selection, ranges: [selection, ...additionalRanges] },
|
||||
replaceSelection: vi.fn((insert: string) => ({ insert })),
|
||||
update: vi.fn((change: unknown, options: unknown) => ({ change, options })),
|
||||
@@ -560,3 +570,77 @@ describe("QueryEditor completion Tab keymap", () => {
|
||||
expect(startCompletion).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
describe("QueryEditor SQL Server completion Space keymap", () => {
|
||||
it.each(["keyword", "table", "column"])("accepts an active %s completion", (type) => {
|
||||
const acceptCompletion = vi.fn(() => true);
|
||||
const harness = createHarness({
|
||||
databaseType: "sqlserver",
|
||||
completionStatus: () => "active",
|
||||
selectedCompletion: () => ({ type }),
|
||||
acceptCompletion,
|
||||
});
|
||||
const view = createView("FXXX ");
|
||||
|
||||
expect(harness.acceptSqlServerCompletionOnSpace(view)).toBe(true);
|
||||
expect(acceptCompletion).toHaveBeenCalledWith(view);
|
||||
expect(view.dispatch).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("inserts the typed space when automatic completion spacing is disabled", () => {
|
||||
const harness = createHarness({ databaseType: "sqlserver", completionStatus: () => "active", acceptCompletion: () => true });
|
||||
const view = createView("FXXX");
|
||||
|
||||
expect(harness.acceptSqlServerCompletionOnSpace(view)).toBe(true);
|
||||
expect(view.dispatch).toHaveBeenCalledWith({
|
||||
changes: { from: 4, insert: " " },
|
||||
selection: { anchor: 5 },
|
||||
scrollIntoView: true,
|
||||
});
|
||||
});
|
||||
|
||||
it("moves over an existing following space instead of duplicating it", () => {
|
||||
const harness = createHarness({ databaseType: "sqlserver", completionStatus: () => "active", acceptCompletion: () => true });
|
||||
const view = createView("FXXX ", 4);
|
||||
|
||||
expect(harness.acceptSqlServerCompletionOnSpace(view)).toBe(true);
|
||||
expect(view.dispatch).toHaveBeenCalledWith({ selection: { anchor: 5 }, scrollIntoView: true });
|
||||
});
|
||||
|
||||
it.each([
|
||||
{ databaseType: "postgresql", status: "active", completionType: "column" },
|
||||
{ databaseType: "sqlserver", status: "pending", completionType: "column" },
|
||||
{ databaseType: "sqlserver", status: "active", completionType: "function" },
|
||||
{ databaseType: "sqlserver", status: "active", completionType: "snippet" },
|
||||
])("keeps ordinary Space input for $databaseType/$status/$completionType", ({ databaseType, status, completionType }) => {
|
||||
const acceptCompletion = vi.fn(() => true);
|
||||
const harness = createHarness({
|
||||
databaseType,
|
||||
completionStatus: () => status as "active" | "pending",
|
||||
selectedCompletion: () => ({ type: completionType }),
|
||||
acceptCompletion,
|
||||
});
|
||||
|
||||
expect(harness.acceptSqlServerCompletionOnSpace(createView())).toBe(false);
|
||||
expect(acceptCompletion).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("keeps ordinary Space input when CodeMirror cannot accept the selected completion", () => {
|
||||
const harness = createHarness({ databaseType: "sqlserver", completionStatus: () => "active", acceptCompletion: () => false });
|
||||
|
||||
expect(harness.acceptSqlServerCompletionOnSpace(createView())).toBe(false);
|
||||
});
|
||||
|
||||
it("keeps ordinary Space input while the SQL Server space-confirm setting is disabled", () => {
|
||||
const acceptCompletion = vi.fn(() => true);
|
||||
const harness = createHarness({
|
||||
databaseType: "sqlserver",
|
||||
completionStatus: () => "active",
|
||||
acceptCompletion,
|
||||
sqlServerSpaceConfirmsCompletion: false,
|
||||
});
|
||||
|
||||
expect(harness.acceptSqlServerCompletionOnSpace(createView())).toBe(false);
|
||||
expect(acceptCompletion).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
@@ -72,6 +72,32 @@ describe("settings search", () => {
|
||||
expect(searchSettings(entries, "line number", "en").map((entry) => entry.id)).toEqual(["editor-line-numbers"]);
|
||||
});
|
||||
|
||||
it("indexes SQL Server space confirmation when SQL Server exists or an exported setting is enabled", () => {
|
||||
const definition = SETTINGS_SEARCH_DEFINITIONS.find((entry) => entry.id === "editor-sqlserver-space-completion");
|
||||
expect(definition).toEqual(
|
||||
expect.objectContaining({
|
||||
id: "editor-sqlserver-space-completion",
|
||||
category: "editor",
|
||||
titleKey: "settings.sqlServerSpaceConfirmsCompletion",
|
||||
descriptionKey: "settings.sqlServerSpaceConfirmsCompletionDescription",
|
||||
targetId: "editor",
|
||||
visible: expect.any(Function),
|
||||
}),
|
||||
);
|
||||
|
||||
const context = { isWeb: false, visibleCategories: new Set<SettingsCategory>(["editor"]) };
|
||||
const withoutSqlServer = resolveSettingsSearchEntries(SETTINGS_SEARCH_DEFINITIONS, { ...context, hasSqlServerConnection: false, sqlServerSpaceConfirmsCompletionEnabled: false }, translate, categoryLabels);
|
||||
const importedWithoutSqlServer = resolveSettingsSearchEntries(SETTINGS_SEARCH_DEFINITIONS, { ...context, hasSqlServerConnection: false, sqlServerSpaceConfirmsCompletionEnabled: true }, translate, categoryLabels);
|
||||
const withSqlServer = resolveSettingsSearchEntries(SETTINGS_SEARCH_DEFINITIONS, { ...context, hasSqlServerConnection: true, sqlServerSpaceConfirmsCompletionEnabled: false }, translate, categoryLabels);
|
||||
|
||||
expect(withoutSqlServer.map((entry) => entry.id)).not.toContain("editor-sqlserver-space-completion");
|
||||
expect(importedWithoutSqlServer.map((entry) => entry.id)).toContain("editor-sqlserver-space-completion");
|
||||
expect(withSqlServer.map((entry) => entry.id)).toContain("editor-sqlserver-space-completion");
|
||||
expect(settingsDialogSource).toContain('const hasSqlServerConnection = computed(() => connectionStore.connections.some((connection) => effectiveDatabaseTypeForConnection(connection) === "sqlserver"));');
|
||||
expect(settingsDialogSource).toContain("const showSqlServerSpaceConfirmsCompletion = computed(");
|
||||
expect(settingsDialogSource).toContain('<div v-if="showSqlServerSpaceConfirmsCompletion" class="settings-item flex items-center justify-between gap-4 rounded-md border bg-muted/20 px-3 py-2">');
|
||||
});
|
||||
|
||||
it("does not index connection or query timeout under editor settings", () => {
|
||||
expect(SETTINGS_SEARCH_DEFINITIONS.map((definition) => definition.id)).not.toContain("editor-global-connect-timeout");
|
||||
expect(SETTINGS_SEARCH_DEFINITIONS.map((definition) => definition.id)).not.toContain("editor-global-query-timeout");
|
||||
|
||||
@@ -26,6 +26,7 @@ export const EDITOR_SETTINGS_DRAFT_KEYS = [
|
||||
"showInsertValueHints",
|
||||
"autoAliasTables",
|
||||
"insertSpaceAfterCompletion",
|
||||
"sqlServerSpaceConfirmsCompletion",
|
||||
"sortCompletionColumnsAlphabetically",
|
||||
"selectFirstCompletionOnOpen",
|
||||
"wordWrap",
|
||||
|
||||
@@ -13,6 +13,8 @@ export function resolveSettingsCategory(initialTab?: string): SettingsCategory {
|
||||
|
||||
export interface SettingsSearchContext {
|
||||
isWeb: boolean;
|
||||
hasSqlServerConnection?: boolean;
|
||||
sqlServerSpaceConfirmsCompletionEnabled?: boolean;
|
||||
visibleCategories: ReadonlySet<SettingsCategory>;
|
||||
}
|
||||
|
||||
@@ -88,6 +90,7 @@ export function createToolbarVisibilitySettingsSearchDefinitions(items: readonly
|
||||
|
||||
const desktopOnly = (context: SettingsSearchContext) => !context.isWeb;
|
||||
const webOnly = (context: SettingsSearchContext) => context.isWeb;
|
||||
const sqlServerSpaceCompletionVisible = (context: SettingsSearchContext) => context.hasSqlServerConnection === true || context.sqlServerSpaceConfirmsCompletionEnabled === true;
|
||||
|
||||
export interface ShortcutSearchDefinitionSource {
|
||||
id: string;
|
||||
@@ -129,6 +132,7 @@ export const SETTINGS_SEARCH_DEFINITIONS: readonly SettingsSearchDefinition[] =
|
||||
{ id: "editor-vim", category: "editor", titleKey: "settings.vimMode", descriptionKey: "settings.vimModeDescription", targetId: "editor" },
|
||||
{ id: "editor-brackets", category: "editor", titleKey: "settings.autoCloseBrackets", descriptionKey: "settings.autoCloseBracketsDescription", targetId: "editor" },
|
||||
{ id: "editor-completion-spacing", category: "editor", titleKey: "settings.insertSpaceAfterCompletion", descriptionKey: "settings.insertSpaceAfterCompletionDescription", targetId: "editor" },
|
||||
{ id: "editor-sqlserver-space-completion", category: "editor", titleKey: "settings.sqlServerSpaceConfirmsCompletion", descriptionKey: "settings.sqlServerSpaceConfirmsCompletionDescription", targetId: "editor", visible: sqlServerSpaceCompletionVisible },
|
||||
{ id: "editor-completion-trigger-mode", category: "editor", titleKey: "settings.completionTriggerMode", descriptionKey: "settings.completionTriggerModeDescription", targetId: "editor" },
|
||||
{ id: "editor-auto-alias", category: "editor", titleKey: "settings.autoAliasTables", descriptionKey: "settings.autoAliasTablesDescription", targetId: "editor" },
|
||||
{ id: "editor-unsaved-close", category: "editor", titleKey: "settings.confirmUnsavedSqlClose", descriptionKey: "settings.confirmUnsavedSqlCloseDescription", targetId: "editor" },
|
||||
|
||||
@@ -83,6 +83,7 @@ const SETTINGS_TRANSFER_CATEGORY_KEYS: Record<SettingsTransferCategoryId, readon
|
||||
"showInsertValueHints",
|
||||
"autoAliasTables",
|
||||
"insertSpaceAfterCompletion",
|
||||
"sqlServerSpaceConfirmsCompletion",
|
||||
"sortCompletionColumnsAlphabetically",
|
||||
"selectFirstCompletionOnOpen",
|
||||
"completionTriggerMode",
|
||||
|
||||
Reference in new issue
Block a user