allow contributed range of higlight for code actions (#202197)

* groundwork for segttings

* laying groundowrk for new API

* more groundwork, api fixed

* cleanup

* more cleanup

* added updates

* fixed spacing

Author: justschen

Diff for: src/vs/editor/common/languages.ts

@@ -749,6 +749,7 @@ export interface CodeAction {
 	isPreferred?: boolean;
 	isAI?: boolean;
 	disabled?: string;
+	ranges?: IRange[];
 }
 
 export const enum CodeActionTriggerType {

Diff for: src/vs/editor/contrib/codeAction/browser/codeActionController.ts

@@ -279,7 +279,12 @@ export class CodeActionController extends Disposable implements IEditorContribut
 				return { canPreview: !!action.action.edit?.edits.length };
 			},
 			onFocus: (action: CodeActionItem | undefined) => {
-				if (action && action.action.diagnostics) {
+				// If provider contributes ranges, then highlight contributed range over diagnostic range.
+				if (action && action.action.ranges) {
+					currentDecorations.clear();
+					const decorations: IModelDeltaDecoration[] = action.action.ranges.map(range => ({ range, options: CodeActionController.DECORATION }));
+					currentDecorations.set(decorations);
+				} else if (action && action.action.diagnostics) {
 					currentDecorations.clear();
 					const decorations: IModelDeltaDecoration[] = action.action.diagnostics.map(diagnostic => ({ range: diagnostic, options: CodeActionController.DECORATION }));
 					currentDecorations.set(decorations);

Diff for: src/vs/monaco.d.ts

@@ -7102,6 +7102,7 @@ declare namespace monaco.languages {
 		isPreferred?: boolean;
 		isAI?: boolean;
 		disabled?: string;
+		ranges?: IRange[];
 	}
 
 	export enum CodeActionTriggerType {

Diff for: src/vs/workbench/api/common/extHost.protocol.ts

@@ -1992,6 +1992,7 @@ export interface ICodeActionDto {
 	isPreferred?: boolean;
 	isAI?: boolean;
 	disabled?: string;
+	ranges?: IRange[];
 }
 
 export interface ICodeActionListDto {

Diff for: src/vs/workbench/api/common/extHostLanguageFeatures.ts

@@ -474,6 +474,9 @@ class CodeActionAdapter {
 					}
 				}
 
+				// Ensures that this is either a Range[] or an empty array so we don't get Array<Range | undefined>
+				const range = candidate.ranges ?? [];
+
 				// new school: convert code action
 				actions.push({
 					cacheId: [cacheId, i],
@@ -484,6 +487,7 @@ class CodeActionAdapter {
 					kind: candidate.kind && candidate.kind.value,
 					isPreferred: candidate.isPreferred,
 					isAI: isProposedApiEnabled(this._extension, 'codeActionAI') ? candidate.isAI : false,
+					ranges: isProposedApiEnabled(this._extension, 'codeActionRanges') ? coalesce(range.map(typeConvert.Range.from)) : undefined,
 					disabled: candidate.disabled?.reason
 				});
 			}

Diff for: src/vs/workbench/services/extensions/common/extensionsApiProposals.ts

@@ -17,6 +17,7 @@ export const allApiProposals = Object.freeze({
 	chatRequestAccess: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.chatRequestAccess.d.ts',
 	chatTab: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.chatTab.d.ts',
 	codeActionAI: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.codeActionAI.d.ts',
+	codeActionRanges: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.codeActionRanges.d.ts',
 	codiconDecoration: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.codiconDecoration.d.ts',
 	commentReactor: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.commentReactor.d.ts',
 	commentsDraftState: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.commentsDraftState.d.ts',

Diff for: src/vscode-dts/vscode.proposed.codeActionRanges.d.ts

@@ -0,0 +1,17 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+declare module 'vscode' {
+
+	export interface CodeAction {
+		/**
+		 *
+		 * The range to which this Code Action applies to, which will be highlighted.
+		 *
+		 * Ex: A refactoring action will highlight the range of text that will be affected.
+		 */
+		ranges?: Range[];
+	}
+}