Skip to content

fix(diff-editor): support originalEditable in inline diff mode (#5302) #5447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Veeresh Yadav (veeresh4520) wants to merge 1 commit into
base: main
Choose a base branch
from
+135 −0
Open

fix(diff-editor): support originalEditable in inline diff mode (#5302) #5447

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 117 additions & 0 deletions test/diffEditor.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
import test from 'node:test';
import assert from 'node:assert';
import * as monaco from '../node_modules/monaco-editor-core/esm/vs/editor/editor.api.js';

test('diff editor originalEditable option in inline mode (issue #5302)', async (t) => {
await t.test('allows editing original model when originalEditable is true and readOnly is false in inline diff mode', () => {
const originalModel = monaco.editor.createModel('original content', 'text/plain');
const modifiedModel = monaco.editor.createModel('modified content', 'text/plain');
const container = document.createElement('div');
document.body.appendChild(container);

const diffEditor = monaco.editor.createDiffEditor(container, {
renderSideBySide: false,
originalEditable: true,
readOnly: false,
renderOverviewRuler: false,
});

diffEditor.setModel({ original: originalModel, modified: modifiedModel });

const origEditor = diffEditor.getOriginalEditor();
const modEditor = diffEditor.getModifiedEditor();

assert.strictEqual(origEditor.getOption(monaco.editor.EditorOption.readOnly), false);
assert.strictEqual(modEditor.getOption(monaco.editor.EditorOption.readOnly), false);

// Verify editing original model applies changes
const editSuccess = origEditor.executeEdits('test', [{
range: new monaco.Range(1, 1, 1, 1),
text: 'prefix '
}]);
assert.strictEqual(editSuccess, true);
assert.strictEqual(originalModel.getValue(), 'prefix original content');

diffEditor.dispose();
originalModel.dispose();
modifiedModel.dispose();
});

await t.test('respects readOnly: true even when originalEditable: true in inline diff mode', () => {
const originalModel = monaco.editor.createModel('original content', 'text/plain');
const modifiedModel = monaco.editor.createModel('modified content', 'text/plain');
const container = document.createElement('div');
document.body.appendChild(container);

const diffEditor = monaco.editor.createDiffEditor(container, {
renderSideBySide: false,
originalEditable: true,
readOnly: true,
renderOverviewRuler: false,
});

diffEditor.setModel({ original: originalModel, modified: modifiedModel });

const origEditor = diffEditor.getOriginalEditor();
const modEditor = diffEditor.getModifiedEditor();

assert.strictEqual(origEditor.getOption(monaco.editor.EditorOption.readOnly), true);
assert.strictEqual(modEditor.getOption(monaco.editor.EditorOption.readOnly), true);

diffEditor.dispose();
originalModel.dispose();
modifiedModel.dispose();
});

await t.test('respects readOnly: false and originalEditable: false in inline diff mode', () => {
const originalModel = monaco.editor.createModel('original content', 'text/plain');
const modifiedModel = monaco.editor.createModel('modified content', 'text/plain');
const container = document.createElement('div');
document.body.appendChild(container);

const diffEditor = monaco.editor.createDiffEditor(container, {
renderSideBySide: false,
originalEditable: false,
readOnly: false,
renderOverviewRuler: false,
});

diffEditor.setModel({ original: originalModel, modified: modifiedModel });

const origEditor = diffEditor.getOriginalEditor();
const modEditor = diffEditor.getModifiedEditor();

assert.strictEqual(origEditor.getOption(monaco.editor.EditorOption.readOnly), true);
assert.strictEqual(modEditor.getOption(monaco.editor.EditorOption.readOnly), false);

diffEditor.dispose();
originalModel.dispose();
modifiedModel.dispose();
});

await t.test('preserves side-by-side behavior for originalEditable and readOnly options', () => {
const originalModel = monaco.editor.createModel('original content', 'text/plain');
const modifiedModel = monaco.editor.createModel('modified content', 'text/plain');
const container = document.createElement('div');
document.body.appendChild(container);

const diffEditor = monaco.editor.createDiffEditor(container, {
renderSideBySide: true,
originalEditable: true,
readOnly: false,
renderOverviewRuler: false,
});

diffEditor.setModel({ original: originalModel, modified: modifiedModel });

const origEditor = diffEditor.getOriginalEditor();
const modEditor = diffEditor.getModifiedEditor();

assert.strictEqual(origEditor.getOption(monaco.editor.EditorOption.readOnly), false);
assert.strictEqual(modEditor.getOption(monaco.editor.EditorOption.readOnly), false);

diffEditor.dispose();
originalModel.dispose();
modifiedModel.dispose();
});
});
18 changes: 18 additions & 0 deletions test/test-setup.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,20 @@
import { createRequire } from 'module';
import { JSDOM } from 'jsdom';

import { register } from 'node:module';

try {
register(`data:text/javascript,
export async function load(url, context, nextLoad) {
if (url.endsWith('.css')) {
return { format: 'module', shortCircuit: true, source: 'export default {};' };
}
return nextLoad(url, context);
}`, import.meta.url);
} catch (e) {
// fallback if register is not available
}

// Handle CSS imports from monaco-editor-core in CJS require context
const require = createRequire(import.meta.url);
require.extensions['.css'] = function (module, filename) {
Expand All @@ -20,13 +34,17 @@ const dom = new JSDOM('<!DOCTYPE html><html><body></body></html>', {

global.window = dom.window;
global.document = dom.window.document;
global.document.queryCommandSupported = () => false;
global.document.execCommand = () => false;
Object.defineProperty(global, 'navigator', { value: dom.window.navigator, writable: true, configurable: true });
global.HTMLElement = dom.window.HTMLElement;
global.Node = dom.window.Node;
global.Element = dom.window.Element;
global.Event = dom.window.Event;
global.MouseEvent = dom.window.MouseEvent;
global.KeyboardEvent = dom.window.KeyboardEvent;
global.UIEvent = dom.window.UIEvent;
global.ResizeObserver = class { observe() {} unobserve() {} disconnect() {} };
global.customElements = dom.window.customElements;

global.CSS = {
Expand Down