@theia/plugin-ext 1.23.0-next.52 → 1.23.0-next.56

package/src/common/plugin-api-rpc.ts

@@ -69,7 +69,8 @@ import {
     CommentOptions,
     CommentThreadCollapsibleState,
     CommentThread,
-    CommentThreadChangedEvent
+    CommentThreadChangedEvent,
+    CodeActionProviderDocumentation
 } from './plugin-api-rpc-model';
 import { ExtPluginApi } from './plugin-ext-api-contribution';
 import { KeysToAnyValues, KeysToKeysToAnyValue } from './types';
@@ -1493,7 +1494,7 @@ export interface LanguagesMain {
     $registerSignatureHelpProvider(handle: number, pluginInfo: PluginInfo, selector: SerializedDocumentFilter[], metadata: theia.SignatureHelpProviderMetadata): void;
     $registerHoverProvider(handle: number, pluginInfo: PluginInfo, selector: SerializedDocumentFilter[]): void;
     $registerDocumentHighlightProvider(handle: number, pluginInfo: PluginInfo, selector: SerializedDocumentFilter[]): void;
-    $registerQuickFixProvider(handle: number, pluginInfo: PluginInfo, selector: SerializedDocumentFilter[], codeActionKinds?: string[]): void;
+    $registerQuickFixProvider(handle: number, pluginInfo: PluginInfo, selector: SerializedDocumentFilter[], codeActionKinds?: string[], documentation?: CodeActionProviderDocumentation): void;
     $clearDiagnostics(id: string): void;
     $changeDiagnostics(id: string, delta: [string, MarkerData[]][]): void;
     $registerDocumentFormattingSupport(handle: number, pluginInfo: PluginInfo, selector: SerializedDocumentFilter[]): void;
@@ -1586,7 +1587,7 @@ export interface CustomEditorsExt {
         widgetOpenerOptions: WidgetOpenerOptions | undefined,
         options: theia.WebviewPanelOptions,
         cancellation: CancellationToken): Promise<void>;
-    $createCustomDocument(resource: UriComponents, viewType: string, backupId: string | undefined, cancellation: CancellationToken): Promise<{ editable: boolean }>;
+    $createCustomDocument(resource: UriComponents, viewType: string, openContext: theia.CustomDocumentOpenContext, cancellation: CancellationToken): Promise<{ editable: boolean }>;
     $disposeCustomDocument(resource: UriComponents, viewType: string): Promise<void>;
     $undo(resource: UriComponents, viewType: string, editId: number, isDirty: boolean): Promise<void>;
     $redo(resource: UriComponents, viewType: string, editId: number, isDirty: boolean): Promise<void>;

package/src/main/browser/custom-editors/custom-editors-main.ts

@@ -308,7 +308,7 @@ export class MainCustomEditorModel implements CustomEditorModel {
         editorPreferences: EditorPreferences,
         cancellation: CancellationToken,
     ): Promise<MainCustomEditorModel> {
-        const { editable } = await proxy.$createCustomDocument(URI.file(resource.path.toString()), viewType, undefined, cancellation);
+        const { editable } = await proxy.$createCustomDocument(URI.file(resource.path.toString()), viewType, {}, cancellation);
         return new MainCustomEditorModel(proxy, viewType, resource, editable, undoRedoService, fileService, editorPreferences);
     }
 

package/src/main/browser/languages-main.ts

@@ -37,7 +37,7 @@ import {
 import { injectable, inject } from '@theia/core/shared/inversify';
 import {
     SerializedDocumentFilter, MarkerData, Range, RelatedInformation,
-    MarkerSeverity, DocumentLink, WorkspaceSymbolParams, CodeAction, CompletionDto
+    MarkerSeverity, DocumentLink, WorkspaceSymbolParams, CodeAction, CompletionDto, CodeActionProviderDocumentation
 } from '../../common/plugin-api-rpc-model';
 import { RPCProtocol } from '../../common/rpc-protocol';
 import { MonacoLanguages, WorkspaceSymbolProvider } from '@theia/monaco/lib/browser/monaco-languages';
@@ -710,7 +710,9 @@ export class LanguagesMainImpl implements LanguagesMain, Disposable {
         }, token);
     }
 
-    $registerQuickFixProvider(handle: number, pluginInfo: PluginInfo, selector: SerializedDocumentFilter[], providedCodeActionKinds?: string[]): void {
+    $registerQuickFixProvider(handle: number, pluginInfo: PluginInfo, selector: SerializedDocumentFilter[], providedCodeActionKinds?: string[],
+        documentation?: CodeActionProviderDocumentation): void {
+
         const languageSelector = this.toLanguageSelector(selector);
         const quickFixProvider = {
             provideCodeActions: (model: monaco.editor.ITextModel, range: monaco.Range,
@@ -720,7 +722,8 @@ export class LanguagesMainImpl implements LanguagesMain, Disposable {
             },
             resolveCodeAction: (codeAction: monaco.languages.CodeAction, token: monaco.CancellationToken): Promise<monaco.languages.CodeAction> =>
                 this.resolveCodeAction(handle, codeAction, token),
-            providedCodeActionKinds
+            providedCodeActionKinds,
+            documentation
         };
         this.register(handle, monaco.modes.CodeActionProviderRegistry.register(languageSelector, quickFixProvider));
     }
@@ -1022,6 +1025,7 @@ function toMonacoAction(action: CodeAction): monaco.languages.CodeAction {
     return {
         ...action,
         diagnostics: action.diagnostics ? action.diagnostics.map(m => toMonacoMarkerData(m)) : undefined,
+        disabled: action.disabled?.reason,
         edit: action.edit ? toMonacoWorkspaceEdit(action.edit) : undefined
     };
 }

package/src/main/browser/menus/menus-contribution-handler.ts

@@ -21,7 +21,7 @@ import { injectable, inject, optional } from '@theia/core/shared/inversify';
 import { MenuPath, ILogger, CommandRegistry, Command, Mutable, MenuAction, SelectionService, CommandHandler, Disposable, DisposableCollection } from '@theia/core';
 import { EDITOR_CONTEXT_MENU, EditorWidget } from '@theia/editor/lib/browser';
 import { MenuModelRegistry } from '@theia/core/lib/common';
-import { Emitter } from '@theia/core/lib/common/event';
+import { Emitter, Event } from '@theia/core/lib/common/event';
 import { TabBarToolbarRegistry, TabBarToolbarItem } from '@theia/core/lib/browser/shell/tab-bar-toolbar';
 import { NAVIGATOR_CONTEXT_MENU } from '@theia/navigator/lib/browser/navigator-contribution';
 import { VIEW_ITEM_CONTEXT_MENU, TreeViewWidget, VIEW_ITEM_INLINE_MENU } from '../view/tree-view-widget';
@@ -359,20 +359,20 @@ export class MenusContributionPointHandler {
 
         const { when } = action;
         const whenKeys = when && this.contextKeyService.parseKeys(when);
-        let onDidChange;
+        let onDidChange: Event<void> | undefined;
         if (whenKeys && whenKeys.size) {
             const onDidChangeEmitter = new Emitter<void>();
             toDispose.push(onDidChangeEmitter);
             onDidChange = onDidChangeEmitter.event;
-            this.contextKeyService.onDidChange.maxListeners = this.contextKeyService.onDidChange.maxListeners + 1;
+            Event.addMaxListeners(this.contextKeyService.onDidChange, 1);
+            toDispose.push(Disposable.create(() => {
+                Event.addMaxListeners(this.contextKeyService.onDidChange, -1);
+            }));
             toDispose.push(this.contextKeyService.onDidChange(event => {
                 if (event.affects(whenKeys)) {
                     onDidChangeEmitter.fire(undefined);
                 }
             }));
-            toDispose.push(Disposable.create(() => {
-                this.contextKeyService.onDidChange.maxListeners = this.contextKeyService.onDidChange.maxListeners - 1;
-            }));
         }
 
         // handle group and priority

package/src/plugin/custom-editors.ts

@@ -81,7 +81,7 @@ export class CustomEditorsExtImpl implements CustomEditorsExt {
         );
     }
 
-    async $createCustomDocument(resource: UriComponents, viewType: string, backupId: string | undefined, cancellation: CancellationToken): Promise<{
+    async $createCustomDocument(resource: UriComponents, viewType: string, openContext: theia.CustomDocumentOpenContext, cancellation: CancellationToken): Promise<{
         editable: boolean;
     }> {
         const entry = this.editorProviders.get(viewType);
@@ -94,7 +94,7 @@ export class CustomEditorsExtImpl implements CustomEditorsExt {
         }
 
         const revivedResource = URI.revive(resource);
-        const document = await entry.provider.openCustomDocument(revivedResource, { backupId }, cancellation);
+        const document = await entry.provider.openCustomDocument(revivedResource, openContext, cancellation);
         this.documents.add(viewType, document);
 
         return { editable: this.supportEditing(entry.provider) };

package/src/plugin/languages/code-action.ts

@@ -104,7 +104,9 @@ export class CodeActionAdapter {
                     command: this.commands.converter.toSafeCommand(candidate.command, toDispose),
                     diagnostics: candidate.diagnostics && candidate.diagnostics.map(Converter.convertDiagnosticToMarkerData),
                     edit: candidate.edit && Converter.fromWorkspaceEdit(candidate.edit),
-                    kind: candidate.kind && candidate.kind.value
+                    kind: candidate.kind && candidate.kind.value,
+                    disabled: candidate.disabled,
+                    isPreferred: candidate.isPreferred
                 });
             }
         }

package/src/plugin/languages.ts

@@ -35,6 +35,7 @@ import { PluginModel } from '../common/plugin-protocol';
 import { Disposable, URI } from './types-impl';
 import { UriComponents } from '../common/uri-components';
 import {
+    CodeActionProviderDocumentation,
     CompletionContext,
     CompletionResultDto,
     Completion,
@@ -91,6 +92,7 @@ import { CallHierarchyAdapter } from './languages/call-hierarchy';
 import { BinaryBuffer } from '@theia/core/lib/common/buffer';
 import { DocumentSemanticTokensAdapter, DocumentRangeSemanticTokensAdapter } from './languages/semantic-highlighting';
 import { isReadonlyArray } from '../common/arrays';
+import { DisposableCollection } from '@theia/core/lib/common/disposable';
 
 type Adapter = CompletionAdapter |
     SignatureHelpAdapter |
@@ -179,10 +181,11 @@ export class LanguagesExtImpl implements LanguagesExt {
         return this.callId++;
     }
 
-    private createDisposable(callId: number): theia.Disposable {
+    private createDisposable(callId: number, onDispose?: () => void): theia.Disposable {
         return new Disposable(() => {
             this.adaptersMap.delete(callId);
             this.proxy.$unregister(callId);
+            onDispose?.();
         });
     }
 
@@ -446,13 +449,26 @@ export class LanguagesExtImpl implements LanguagesExt {
         metadata?: theia.CodeActionProviderMetadata
     ): theia.Disposable {
         const callId = this.addNewAdapter(new CodeActionAdapter(provider, this.documents, this.diagnostics, pluginModel ? pluginModel.id : '', this.commands));
+
+        let documentation: CodeActionProviderDocumentation | undefined;
+        let disposables: DisposableCollection | undefined;
+        if (metadata && metadata.documentation) {
+            disposables = new DisposableCollection();
+            documentation = metadata.documentation.map(doc => ({
+                kind: doc.kind.value,
+                command: this.commands.converter.toSafeCommand(doc.command, disposables!)
+            }));
+        }
+
         this.proxy.$registerQuickFixProvider(
             callId,
             pluginInfo,
             this.transformDocumentSelector(selector),
-            metadata && metadata.providedCodeActionKinds ? metadata.providedCodeActionKinds.map(kind => kind.value!) : undefined
+            metadata && metadata.providedCodeActionKinds ? metadata.providedCodeActionKinds.map(kind => kind.value) : undefined,
+            documentation
         );
-        return this.createDisposable(callId);
+
+        return this.createDisposable(callId, disposables?.dispose);
     }
 
     $provideCodeActions(handle: number,

package/src/plugin/types-impl.ts

@@ -1238,6 +1238,10 @@ export class CodeAction {
 
     kind?: CodeActionKind;
 
+    disabled?: { reason: string };
+
+    isPreferred?: boolean;
+
     constructor(title: string, kind?: CodeActionKind) {
         this.title = title;
         this.kind = kind;