Merge pull request microsoft#97644 from ludokx/diff-editor-codelens

alexdima · web-flow · commit 9ada5827b474 · 2020-07-10T11:24:45.000+02:00
Add microsoft#97640: Added options to enable codelens for diff editors
diff --git a/src/vs/editor/browser/widget/diffEditorWidget.ts b/src/vs/editor/browser/widget/diffEditorWidget.ts
@@ -206,6 +206,8 @@ export class DiffEditorWidget extends Disposable implements editorBrowser.IDiffE
 
 	private _ignoreTrimWhitespace: boolean;
 	private _originalIsEditable: boolean;
+	private _originalCodeLens: boolean;
+	private _modifiedCodeLens: boolean;
 
 	private _renderSideBySide: boolean;
 	private _maxComputationTime: number;
@@ -281,6 +283,16 @@ export class DiffEditorWidget extends Disposable implements editorBrowser.IDiffE
 			this._originalIsEditable = Boolean(options.originalEditable);
 		}
 
+		this._originalCodeLens = false;
+		if (typeof options.originalCodeLens !== 'undefined') {
+			this._originalCodeLens = Boolean(options.originalCodeLens);
+		}
+
+		this._modifiedCodeLens = false;
+		if (typeof options.modifiedCodeLens !== 'undefined') {
+			this._modifiedCodeLens = Boolean(options.modifiedCodeLens);
+		}
+
 		this._updateDecorationsRunner = this._register(new RunOnceScheduler(() => this._updateDecorations(), 0));
 
 		this._containerDomElement = document.createElement('div');
@@ -469,7 +481,7 @@ export class DiffEditorWidget extends Disposable implements editorBrowser.IDiffE
 	}
 
 	private _createLeftHandSideEditor(options: IDiffEditorOptions, instantiationService: IInstantiationService): CodeEditorWidget {
-		const editor = this._createInnerEditor(instantiationService, this._originalDomNode, this._adjustOptionsForLeftHandSide(options, this._originalIsEditable));
+		const editor = this._createInnerEditor(instantiationService, this._originalDomNode, this._adjustOptionsForLeftHandSide(options, this._originalIsEditable, this._originalCodeLens));
 
 		this._register(editor.onDidScrollChange((e) => {
 			if (this._isHandlingScrollEvent) {
@@ -502,7 +514,7 @@ export class DiffEditorWidget extends Disposable implements editorBrowser.IDiffE
 	}
 
 	private _createRightHandSideEditor(options: IDiffEditorOptions, instantiationService: IInstantiationService): CodeEditorWidget {
-		const editor = this._createInnerEditor(instantiationService, this._modifiedDomNode, this._adjustOptionsForRightHandSide(options));
+		const editor = this._createInnerEditor(instantiationService, this._modifiedDomNode, this._adjustOptionsForRightHandSide(options, this._modifiedCodeLens));
 
 		this._register(editor.onDidScrollChange((e) => {
 			if (this._isHandlingScrollEvent) {
@@ -662,9 +674,15 @@ export class DiffEditorWidget extends Disposable implements editorBrowser.IDiffE
 		if (typeof newOptions.originalEditable !== 'undefined') {
 			this._originalIsEditable = Boolean(newOptions.originalEditable);
 		}
+		if (typeof newOptions.originalCodeLens !== 'undefined') {
+			this._originalCodeLens = Boolean(newOptions.originalCodeLens);
+		}
+		if (typeof newOptions.modifiedCodeLens !== 'undefined') {
+			this._modifiedCodeLens = Boolean(newOptions.modifiedCodeLens);
+		}
 
-		this.modifiedEditor.updateOptions(this._adjustOptionsForRightHandSide(newOptions));
-		this.originalEditor.updateOptions(this._adjustOptionsForLeftHandSide(newOptions, this._originalIsEditable));
+		this.modifiedEditor.updateOptions(this._adjustOptionsForRightHandSide(newOptions, this._modifiedCodeLens));
+		this.originalEditor.updateOptions(this._adjustOptionsForLeftHandSide(newOptions, this._originalIsEditable, this._originalCodeLens));
 
 		// enableSplitViewResizing
 		if (typeof newOptions.enableSplitViewResizing !== 'undefined') {
@@ -1059,15 +1077,21 @@ export class DiffEditorWidget extends Disposable implements editorBrowser.IDiffE
 		return clonedOptions;
 	}
 
-	private _adjustOptionsForLeftHandSide(options: IDiffEditorOptions, isEditable: boolean): IEditorOptions {
+	private _adjustOptionsForLeftHandSide(options: IDiffEditorOptions, isEditable: boolean, isCodeLensEnabled: boolean): IEditorOptions {
 		let result = this._adjustOptionsForSubEditor(options);
+		if (isCodeLensEnabled) {
+			result.codeLens = true;
+		}
 		result.readOnly = !isEditable;
 		result.extraEditorClassName = 'original-in-monaco-diff-editor';
 		return result;
 	}
 
-	private _adjustOptionsForRightHandSide(options: IDiffEditorOptions): IEditorOptions {
+	private _adjustOptionsForRightHandSide(options: IDiffEditorOptions, isCodeLensEnabled: boolean): IEditorOptions {
 		let result = this._adjustOptionsForSubEditor(options);
+		if (isCodeLensEnabled) {
+			result.codeLens = true;
+		}
 		result.revealHorizontalRightPadding = EditorOptions.revealHorizontalRightPadding.defaultValue + DiffEditorWidget.ENTIRE_DIFF_OVERVIEW_WIDTH;
 		result.scrollbar!.verticalHasArrows = false;
 		result.extraEditorClassName = 'modified-in-monaco-diff-editor';
diff --git a/src/vs/editor/common/config/commonEditorConfig.ts b/src/vs/editor/common/config/commonEditorConfig.ts
@@ -541,6 +541,11 @@ const editorConfiguration: IConfigurationNode = {
 			type: 'boolean',
 			default: true,
 			description: nls.localize('renderIndicators', "Controls whether the diff editor shows +/- indicators for added/removed changes.")
+		},
+		'diffEditor.codeLens': {
+			type: 'boolean',
+			default: false,
+			description: nls.localize('codeLens', "Controls whether the editor shows CodeLens.")
 		}
 	}
 };
diff --git a/src/vs/editor/common/config/editorOptions.ts b/src/vs/editor/common/config/editorOptions.ts
@@ -647,6 +647,16 @@ export interface IDiffEditorOptions extends IEditorOptions {
 	 * Defaults to false.
 	 */
 	originalEditable?: boolean;
+	/**
+	 * Original editor should be have code lens enabled?
+	 * Defaults to false.
+	 */
+	originalCodeLens?: boolean;
+	/**
+	 * Modified editor should be have code lens enabled?
+	 * Defaults to false.
+	 */
+	modifiedCodeLens?: boolean;
 }
 
 //#endregion
diff --git a/src/vs/monaco.d.ts b/src/vs/monaco.d.ts
@@ -3179,6 +3179,16 @@ declare namespace monaco.editor {
 		 * Defaults to false.
 		 */
 		originalEditable?: boolean;
+		/**
+		 * Original editor should be have code lens enabled?
+		 * Defaults to false.
+		 */
+		originalCodeLens?: boolean;
+		/**
+		 * Modified editor should be have code lens enabled?
+		 * Defaults to false.
+		 */
+		modifiedCodeLens?: boolean;
 	}
 
 	/**
diff --git a/src/vs/workbench/browser/parts/editor/textDiffEditor.ts b/src/vs/workbench/browser/parts/editor/textDiffEditor.ts
@@ -202,7 +202,16 @@ export class TextDiffEditor extends BaseTextEditor implements ITextDiffEditorPan
 
 		// Handle diff editor specially by merging in diffEditor configuration
 		if (isObject(configuration.diffEditor)) {
-			objects.mixin(editorConfiguration, configuration.diffEditor);
+			// User settings defines `diffEditor.codeLens`, but there is also `editor.codeLens`.
+			// Due to the mixin, the two settings cannot be distinguished anymore.
+			//
+			// So we map `diffEditor.codeLens` to `diffEditor.originalCodeLens` and `diffEditor.modifiedCodeLens`.
+			const diffEditorConfiguration = <IDiffEditorOptions>objects.deepClone(configuration.diffEditor);
+			diffEditorConfiguration.originalCodeLens = diffEditorConfiguration.codeLens;
+			diffEditorConfiguration.modifiedCodeLens = diffEditorConfiguration.codeLens;
+			delete diffEditorConfiguration.codeLens;
+
+			objects.mixin(editorConfiguration, diffEditorConfiguration);
 		}
 
 		return editorConfiguration;

Original file line number	Diff line number	Diff line change
`@@ -541,6 +541,11 @@ const editorConfiguration: IConfigurationNode = {`
`541`	`541`	`type: 'boolean',`
`542`	`542`	`default: true,`
`543`	`543`	`description: nls.localize('renderIndicators', "Controls whether the diff editor shows +/- indicators for added/removed changes.")`
	`544`	`+ },`
	`545`	`+ 'diffEditor.codeLens': {`
	`546`	`+ type: 'boolean',`
	`547`	`+ default: false,`
	`548`	`+ description: nls.localize('codeLens', "Controls whether the editor shows CodeLens.")`
`544`	`549`	`}`
`545`	`550`	`}`
`546`	`551`	`};`