feat(grid): enable code folding and line numbers for json cell details
This commit is contained in:
1 parent
dab39c690a
commit
33b4652d39
6 files changed
+120
-1
No files matched your search
@@ -6720,6 +6720,8 @@ watch(valueEditorContainer, async (el) => {
|
|||||||
fontSize: editorFontSize,
|
fontSize: editorFontSize,
|
||||||
fontFamily: detailEditorFontFamily,
|
fontFamily: detailEditorFontFamily,
|
||||||
lineWrapping: () => settingsStore.editorSettings.wordWrap,
|
lineWrapping: () => settingsStore.editorSettings.wordWrap,
|
||||||
|
lineNumbers: true,
|
||||||
|
folding: true,
|
||||||
});
|
});
|
||||||
const editor = valueDetailEditor;
|
const editor = valueDetailEditor;
|
||||||
await editor.create(el, detailEditValue.value, activeCellDetail.value?.type);
|
await editor.create(el, detailEditValue.value, activeCellDetail.value?.type);
|
||||||
|
|||||||
@@ -104,6 +104,8 @@ watch(jsonPreviewContainer, async (element) => {
|
|||||||
fontSize: () => settingsStore.editorSettings.fontSize,
|
fontSize: () => settingsStore.editorSettings.fontSize,
|
||||||
fontFamily: () => settingsStore.editorSettings.tableFontFamily,
|
fontFamily: () => settingsStore.editorSettings.tableFontFamily,
|
||||||
lineWrapping: () => settingsStore.editorSettings.wordWrap,
|
lineWrapping: () => settingsStore.editorSettings.wordWrap,
|
||||||
|
lineNumbers: true,
|
||||||
|
folding: true,
|
||||||
});
|
});
|
||||||
await jsonPreviewEditor.create(element, props.detail?.formattedJson ?? "", "json");
|
await jsonPreviewEditor.create(element, props.detail?.formattedJson ?? "", "json");
|
||||||
} else if (!element && jsonPreviewEditor) {
|
} else if (!element && jsonPreviewEditor) {
|
||||||
|
|||||||
@@ -40,6 +40,8 @@ watch(previewContainer, async (element) => {
|
|||||||
fontSize: () => settingsStore.editorSettings.fontSize,
|
fontSize: () => settingsStore.editorSettings.fontSize,
|
||||||
fontFamily: () => settingsStore.editorSettings.tableFontFamily,
|
fontFamily: () => settingsStore.editorSettings.tableFontFamily,
|
||||||
lineWrapping: () => settingsStore.editorSettings.wordWrap,
|
lineWrapping: () => settingsStore.editorSettings.wordWrap,
|
||||||
|
lineNumbers: true,
|
||||||
|
folding: true,
|
||||||
});
|
});
|
||||||
await previewEditor.create(element, props.text, "json");
|
await previewEditor.create(element, props.text, "json");
|
||||||
} else if (!element && previewEditor) {
|
} else if (!element && previewEditor) {
|
||||||
|
|||||||
@@ -0,0 +1,77 @@
|
|||||||
|
// @vitest-environment happy-dom
|
||||||
|
|
||||||
|
import { readFileSync } from "node:fs";
|
||||||
|
import { resolve } from "node:path";
|
||||||
|
import { describe, expect, it } from "vitest";
|
||||||
|
import { createPinia, setActivePinia } from "pinia";
|
||||||
|
import { foldCode, unfoldCode } from "@codemirror/language";
|
||||||
|
import { useCellDetailEditor } from "@/composables/useCellDetailEditor";
|
||||||
|
|
||||||
|
const dataGridSource = readFileSync(resolve(import.meta.dirname, "../DataGrid.vue"), "utf8");
|
||||||
|
const useDataGridCellDetailSource = readFileSync(resolve(import.meta.dirname, "../../../composables/useDataGridCellDetail.ts"), "utf8");
|
||||||
|
const cellDetailDialogSource = readFileSync(resolve(import.meta.dirname, "../DataGridCellDetailDialog.vue"), "utf8");
|
||||||
|
const mongoJsonPreviewSource = readFileSync(resolve(import.meta.dirname, "../DataGridMongoJsonPreview.vue"), "utf8");
|
||||||
|
|
||||||
|
describe("DataGrid cell detail code folding and line numbers (#10431)", () => {
|
||||||
|
it("enables code folding and line numbers across all cell detail and JSON preview editors", () => {
|
||||||
|
// #10431: useDataGridCellDetail, DataGrid valueDetailEditor, DataGridCellDetailDialog,
|
||||||
|
// and DataGridMongoJsonPreview must enable folding and line numbers for JSON values
|
||||||
|
expect(useDataGridCellDetailSource).toMatch(/folding:\s*true/);
|
||||||
|
expect(useDataGridCellDetailSource).toMatch(/lineNumbers:\s*true/);
|
||||||
|
|
||||||
|
expect(dataGridSource).toMatch(/folding:\s*true/);
|
||||||
|
expect(dataGridSource).toMatch(/lineNumbers:\s*true/);
|
||||||
|
|
||||||
|
expect(cellDetailDialogSource).toMatch(/folding:\s*true/);
|
||||||
|
expect(cellDetailDialogSource).toMatch(/lineNumbers:\s*true/);
|
||||||
|
|
||||||
|
expect(mongoJsonPreviewSource).toMatch(/folding:\s*true/);
|
||||||
|
expect(mongoJsonPreviewSource).toMatch(/lineNumbers:\s*true/);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("mounts line numbers and fold gutter in useCellDetailEditor when folding and lineNumbers are enabled", async () => {
|
||||||
|
const pinia = createPinia();
|
||||||
|
setActivePinia(pinia);
|
||||||
|
|
||||||
|
const host = document.createElement("div");
|
||||||
|
document.body.append(host);
|
||||||
|
|
||||||
|
const editor = useCellDetailEditor({
|
||||||
|
language: "json",
|
||||||
|
folding: true,
|
||||||
|
lineNumbers: true,
|
||||||
|
editorTheme: () => "default",
|
||||||
|
appAppearance: () => "light",
|
||||||
|
appPalette: () => ({}) as any,
|
||||||
|
fontSize: () => 13,
|
||||||
|
fontFamily: () => "monospace",
|
||||||
|
});
|
||||||
|
|
||||||
|
const jsonDoc = `{\n "name": "DBX",\n "items": [\n 1,\n 2\n ]\n}`;
|
||||||
|
await editor.create(host, jsonDoc, "json");
|
||||||
|
|
||||||
|
const cmGutters = host.querySelector(".cm-gutters");
|
||||||
|
expect(cmGutters).not.toBeNull();
|
||||||
|
|
||||||
|
const lineNumbersGutter = host.querySelector(".cm-lineNumbers");
|
||||||
|
expect(lineNumbersGutter).not.toBeNull();
|
||||||
|
|
||||||
|
const foldGutter = host.querySelector(".cm-foldGutter");
|
||||||
|
expect(foldGutter).not.toBeNull();
|
||||||
|
|
||||||
|
// Verify folding interaction on the CodeMirror EditorView
|
||||||
|
const cmView = editor.view.value;
|
||||||
|
expect(cmView).not.toBeNull();
|
||||||
|
if (cmView) {
|
||||||
|
// Fold the root object at line 1
|
||||||
|
const folded = foldCode(cmView);
|
||||||
|
expect(typeof folded).toBe("boolean");
|
||||||
|
// Unfold back
|
||||||
|
const unfolded = unfoldCode(cmView);
|
||||||
|
expect(typeof unfolded).toBe("boolean");
|
||||||
|
}
|
||||||
|
|
||||||
|
editor.destroy();
|
||||||
|
host.remove();
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -11,18 +11,24 @@ const mocks = vi.hoisted(() => ({
|
|||||||
getValue: vi.fn(() => ""),
|
getValue: vi.fn(() => ""),
|
||||||
openSearch: vi.fn(),
|
openSearch: vi.fn(),
|
||||||
focus: vi.fn(),
|
focus: vi.fn(),
|
||||||
|
createdOptions: [] as Array<Record<string, any>>,
|
||||||
onChange: undefined as undefined | ((value: string) => void),
|
onChange: undefined as undefined | ((value: string) => void),
|
||||||
onSaveShortcut: undefined as undefined | ((event: KeyboardEvent) => boolean),
|
onSaveShortcut: undefined as undefined | ((event: KeyboardEvent) => boolean),
|
||||||
fontFamily: undefined as undefined | (() => string),
|
fontFamily: undefined as undefined | (() => string),
|
||||||
lineWrapping: undefined as undefined | (() => boolean),
|
lineWrapping: undefined as undefined | (() => boolean),
|
||||||
|
lineNumbers: undefined as undefined | boolean,
|
||||||
|
folding: undefined as undefined | boolean,
|
||||||
}));
|
}));
|
||||||
|
|
||||||
vi.mock("@/composables/useCellDetailEditor", () => ({
|
vi.mock("@/composables/useCellDetailEditor", () => ({
|
||||||
useCellDetailEditor: (options: { onChange?: (value: string) => void; onSaveShortcut?: (event: KeyboardEvent) => boolean; fontFamily: () => string; lineWrapping?: () => boolean }) => {
|
useCellDetailEditor: (options: Record<string, any>) => {
|
||||||
|
mocks.createdOptions.push(options);
|
||||||
mocks.onChange = options.onChange;
|
mocks.onChange = options.onChange;
|
||||||
mocks.onSaveShortcut = options.onSaveShortcut;
|
mocks.onSaveShortcut = options.onSaveShortcut;
|
||||||
mocks.fontFamily = options.fontFamily;
|
mocks.fontFamily = options.fontFamily;
|
||||||
mocks.lineWrapping = options.lineWrapping;
|
mocks.lineWrapping = options.lineWrapping;
|
||||||
|
mocks.lineNumbers = options.lineNumbers;
|
||||||
|
mocks.folding = options.folding;
|
||||||
return {
|
return {
|
||||||
create: mocks.create,
|
create: mocks.create,
|
||||||
destroy: mocks.destroy,
|
destroy: mocks.destroy,
|
||||||
@@ -64,10 +70,13 @@ function detail(): DataGridCellDetail {
|
|||||||
|
|
||||||
beforeEach(() => {
|
beforeEach(() => {
|
||||||
vi.clearAllMocks();
|
vi.clearAllMocks();
|
||||||
|
mocks.createdOptions = [];
|
||||||
mocks.onChange = undefined;
|
mocks.onChange = undefined;
|
||||||
mocks.onSaveShortcut = undefined;
|
mocks.onSaveShortcut = undefined;
|
||||||
mocks.fontFamily = undefined;
|
mocks.fontFamily = undefined;
|
||||||
mocks.lineWrapping = undefined;
|
mocks.lineWrapping = undefined;
|
||||||
|
mocks.lineNumbers = undefined;
|
||||||
|
mocks.folding = undefined;
|
||||||
mocks.getValue.mockReturnValue("");
|
mocks.getValue.mockReturnValue("");
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -83,6 +92,8 @@ describe("useDataGridCellDetail", () => {
|
|||||||
expect(mocks.focus).toHaveBeenCalledOnce();
|
expect(mocks.focus).toHaveBeenCalledOnce();
|
||||||
expect(mocks.fontFamily?.()).toBe("'Grid Font', sans-serif");
|
expect(mocks.fontFamily?.()).toBe("'Grid Font', sans-serif");
|
||||||
expect(mocks.lineWrapping?.()).toBe(true);
|
expect(mocks.lineWrapping?.()).toBe(true);
|
||||||
|
expect(mocks.folding).toBe(true);
|
||||||
|
expect(mocks.lineNumbers).toBe(true);
|
||||||
|
|
||||||
composable.detailsEditorContainer.value = undefined;
|
composable.detailsEditorContainer.value = undefined;
|
||||||
await nextTick();
|
await nextTick();
|
||||||
@@ -197,4 +208,27 @@ describe("useDataGridCellDetail", () => {
|
|||||||
await nextTick();
|
await nextTick();
|
||||||
scope.stop();
|
scope.stop();
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("enables code folding and line numbers for the side JSON preview editor (#10431)", async () => {
|
||||||
|
const scope = effectScope();
|
||||||
|
const cellDetail = detail();
|
||||||
|
cellDetail.formattedJson = '{\n "name": "dbx"\n}';
|
||||||
|
const composable = scope.run(() => useDataGridCellDetail({ detail: ref(cellDetail), editValue: ref(""), onCancel: vi.fn() }))!;
|
||||||
|
|
||||||
|
composable.sideJsonPreviewContainer.value = document.createElement("div");
|
||||||
|
await nextTick();
|
||||||
|
await Promise.resolve();
|
||||||
|
|
||||||
|
expect(mocks.create).toHaveBeenCalledOnce();
|
||||||
|
expect(mocks.create).toHaveBeenCalledWith(composable.sideJsonPreviewContainer.value, '{\n "name": "dbx"\n}', "json");
|
||||||
|
expect(mocks.createdOptions[0]?.folding).toBe(true);
|
||||||
|
expect(mocks.createdOptions[0]?.lineNumbers).toBe(true);
|
||||||
|
expect(mocks.createdOptions[0]?.language).toBe("json");
|
||||||
|
expect(mocks.createdOptions[0]?.readOnly).toBe(true);
|
||||||
|
|
||||||
|
composable.sideJsonPreviewContainer.value = undefined;
|
||||||
|
await nextTick();
|
||||||
|
expect(mocks.destroy).toHaveBeenCalledOnce();
|
||||||
|
scope.stop();
|
||||||
|
});
|
||||||
});
|
});
|
||||||
@@ -23,6 +23,8 @@ export function useDataGridCellDetail(options: { detail: Ref<DataGridCellDetail>
|
|||||||
fontSize: () => settingsStore.editorSettings.fontSize,
|
fontSize: () => settingsStore.editorSettings.fontSize,
|
||||||
fontFamily: () => settingsStore.editorSettings.tableFontFamily,
|
fontFamily: () => settingsStore.editorSettings.tableFontFamily,
|
||||||
lineWrapping: () => settingsStore.editorSettings.wordWrap,
|
lineWrapping: () => settingsStore.editorSettings.wordWrap,
|
||||||
|
lineNumbers: true,
|
||||||
|
folding: true,
|
||||||
});
|
});
|
||||||
|
|
||||||
watch(geometryPreviewOpen, async (open) => {
|
watch(geometryPreviewOpen, async (open) => {
|
||||||
|
|||||||
Reference in new issue
Block a user