@theia/editor 1.59.0-next.62 → 1.59.0

package/src/browser/editor-manager.ts

@@ -14,12 +14,11 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
 // *****************************************************************************
 
-import { injectable, postConstruct, inject } from '@theia/core/shared/inversify';
+import { injectable, postConstruct, inject, named } from '@theia/core/shared/inversify';
 import URI from '@theia/core/lib/common/uri';
-import { RecursivePartial, Emitter, Event, MaybePromise, CommandService, nls } from '@theia/core/lib/common';
+import { RecursivePartial, Emitter, Event, MaybePromise, CommandService, nls, ContributionProvider, Prioritizeable, Disposable } from '@theia/core/lib/common';
 import {
-    WidgetOpenerOptions, NavigatableWidgetOpenHandler, NavigatableWidgetOptions, Widget, PreferenceService, CommonCommands, getDefaultHandler,
-    defaultHandlerPriority
+    WidgetOpenerOptions, NavigatableWidgetOpenHandler, NavigatableWidgetOptions, Widget, PreferenceService, CommonCommands, getDefaultHandler, defaultHandlerPriority
 } from '@theia/core/lib/browser';
 import { EditorWidget } from './editor-widget';
 import { Range, Position, Location, TextEditor } from './editor';
@@ -33,7 +32,13 @@ export interface WidgetId {
 export interface EditorOpenerOptions extends WidgetOpenerOptions {
     selection?: RecursivePartial<Range>;
     preview?: boolean;
-    counter?: number
+    counter?: number;
+}
+
+export const EditorSelectionResolver = Symbol('EditorSelectionResolver');
+export interface EditorSelectionResolver {
+    priority?: number;
+    resolveSelection(widget: EditorWidget, options: EditorOpenerOptions, uri?: URI): Promise<RecursivePartial<Range> | undefined>;
 }
 
 @injectable()
@@ -60,9 +65,19 @@ export class EditorManager extends NavigatableWidgetOpenHandler<EditorWidget> {
     @inject(CommandService) protected readonly commands: CommandService;
     @inject(PreferenceService) protected readonly preferenceService: PreferenceService;
 
+    @inject(ContributionProvider) @named(EditorSelectionResolver)
+    protected readonly resolverContributions: ContributionProvider<EditorSelectionResolver>;
+    protected selectionResolvers: EditorSelectionResolver[] = [];
+
     @postConstruct()
     protected override init(): void {
         super.init();
+
+        this.selectionResolvers = Prioritizeable.prioritizeAllSync(
+            this.resolverContributions.getContributions(),
+            resolver => resolver.priority ?? 0
+        ).map(p => p.value);
+
         this.shell.onDidChangeActiveWidget(() => this.updateActiveEditor());
         this.shell.onDidChangeCurrentWidget(() => this.updateCurrentEditor());
         this.shell.onDidDoubleClickMainArea(() =>
@@ -91,6 +106,26 @@ export class EditorManager extends NavigatableWidgetOpenHandler<EditorWidget> {
         this.updateCurrentEditor();
     }
 
+    /**
+     * Registers a dynamic selection resolver.
+     * The resolver is added to the sorted list of selection resolvers and can later be disposed to remove it.
+     *
+     * @param resolver The selection resolver to register.
+     * @returns A Disposable that unregisters the resolver when disposed.
+     */
+    public registerSelectionResolver(resolver: EditorSelectionResolver): Disposable {
+        this.selectionResolvers.push(resolver);
+        this.selectionResolvers.sort((a, b) => (b.priority ?? 0) - (a.priority ?? 0));
+        return {
+            dispose: () => {
+                const index = this.selectionResolvers.indexOf(resolver);
+                if (index !== -1) {
+                    this.selectionResolvers.splice(index, 1);
+                }
+            }
+        };
+    }
+
     override getByUri(uri: URI, options?: EditorOpenerOptions): Promise<EditorWidget | undefined> {
         return this.getWidget(uri, options);
     }
@@ -101,22 +136,24 @@ export class EditorManager extends NavigatableWidgetOpenHandler<EditorWidget> {
 
     protected override tryGetPendingWidget(uri: URI, options?: EditorOpenerOptions): MaybePromise<EditorWidget> | undefined {
         const editorPromise = super.tryGetPendingWidget(uri, options);
-        if (editorPromise) {
-            // Reveal selection before attachment to manage nav stack. (https://github.com/eclipse-theia/theia/issues/8955)
-            if (!(editorPromise instanceof Widget)) {
-                editorPromise.then(editor => this.revealSelection(editor, options, uri));
-            } else {
-                this.revealSelection(editorPromise, options, uri);
-            }
+        if (!editorPromise) {
+            return editorPromise;
         }
-        return editorPromise;
+
+        // Reveal selection before attachment to manage nav stack. (https://github.com/eclipse-theia/theia/issues/8955)
+        if (!(editorPromise instanceof Widget)) {
+            return editorPromise.then(editor => this.revealSelection(editor, options, uri)).then(() => editorPromise);
+        } else {
+            return this.revealSelection(editorPromise, options, uri).then(() => editorPromise);
+        }
+
     }
 
     protected override async getWidget(uri: URI, options?: EditorOpenerOptions): Promise<EditorWidget | undefined> {
         const editor = await super.getWidget(uri, options);
         if (editor) {
             // Reveal selection before attachment to manage nav stack. (https://github.com/eclipse-theia/theia/issues/8955)
-            this.revealSelection(editor, options, uri);
+            await this.revealSelection(editor, options, uri);
         }
         return editor;
     }
@@ -124,7 +161,7 @@ export class EditorManager extends NavigatableWidgetOpenHandler<EditorWidget> {
     protected override async getOrCreateWidget(uri: URI, options?: EditorOpenerOptions): Promise<EditorWidget> {
         const editor = await super.getOrCreateWidget(uri, options);
         // Reveal selection before attachment to manage nav stack. (https://github.com/eclipse-theia/theia/issues/8955)
-        this.revealSelection(editor, options, uri);
+        await this.revealSelection(editor, options, uri);
         return editor;
     }
 
@@ -240,13 +277,17 @@ export class EditorManager extends NavigatableWidgetOpenHandler<EditorWidget> {
         return this.open(uri, splitOptions);
     }
 
-    protected revealSelection(widget: EditorWidget, input?: EditorOpenerOptions, uri?: URI): void {
+    protected async revealSelection(widget: EditorWidget, input?: EditorOpenerOptions, uri?: URI): Promise<void> {
         let inputSelection = input?.selection;
+        if (!inputSelection) {
+            inputSelection = await this.resolveSelection(widget, input ?? {}, uri);
+        }
+        // this logic could be moved into a 'EditorSelectionResolver'
         if (!inputSelection && uri) {
+            // support file:///some/file.js#73,84
+            // support file:///some/file.js#L73
             const match = /^L?(\d+)(?:,(\d+))?/.exec(uri.fragment);
             if (match) {
-                // support file:///some/file.js#73,84
-                // support file:///some/file.js#L73
                 inputSelection = {
                     start: {
                         line: parseInt(match[1]) - 1,
@@ -256,22 +297,36 @@ export class EditorManager extends NavigatableWidgetOpenHandler<EditorWidget> {
             }
         }
         if (inputSelection) {
-            const editor = widget.editor;
             const selection = this.getSelection(widget, inputSelection);
+            const editor = widget.editor;
             if (Position.is(selection)) {
                 editor.cursor = selection;
                 editor.revealPosition(selection);
             } else if (Range.is(selection)) {
                 editor.cursor = selection.end;
-                editor.selection = {
-                    ...selection,
-                    direction: 'ltr'
-                };
+                editor.selection = { ...selection, direction: 'ltr' };
                 editor.revealRange(selection);
             }
         }
     }
 
+    protected async resolveSelection(widget: EditorWidget, options: EditorOpenerOptions, uri?: URI): Promise<RecursivePartial<Range> | undefined> {
+        if (options.selection) {
+            return options.selection;
+        }
+        for (const resolver of this.selectionResolvers) {
+            try {
+                const selection = await resolver.resolveSelection(widget, options, uri);
+                if (selection) {
+                    return selection;
+                }
+            } catch (error) {
+                console.error(error);
+            }
+        }
+        return undefined;
+    }
+
     protected getSelection(widget: EditorWidget, selection: RecursivePartial<Range>): Range | Position | undefined {
         const { start, end } = selection;
         if (Position.is(start)) {

package/src/browser/editor-preferences.ts

@@ -40,7 +40,7 @@ const codeActionsContributionSchema: PreferenceSchema['properties'] = {
                 properties: {
                     'source.fixAll': {
                         type: 'boolean',
-                        description: nls.localizeByDefault('Controls whether auto fix action should be run on file save.')
+                        description: nls.localizeByDefault('Controls whether \'{0}\' actions should be run on file save.', 'quickfix')
                     }
                 },
                 additionalProperties: {
@@ -53,7 +53,7 @@ const codeActionsContributionSchema: PreferenceSchema['properties'] = {
             }
         ],
         default: {},
-        markdownDescription: nls.localizeByDefault('Run Code Actions for the editor on save. Code Actions must be specified and the editor must not be shutting down. Example: `"source.organizeImports": "explicit" `'),
+        markdownDescription: nls.localizeByDefault('Run Code Actions for the editor on save. Code Actions must be specified and the editor must not be shutting down. When {0} is set to `afterDelay`, Code Actions will only be run when the file is saved explicitly. Example: `"source.organizeImports": "explicit" `'),
         scope: 'language-overridable',
     }
 };
@@ -68,7 +68,7 @@ interface CodeActionsContributionProperties {
 const fileContributionSchema: PreferenceSchema['properties'] = {
     'editor.formatOnSave': {
         'type': 'boolean',
-        'description': nls.localizeByDefault('Format a file on save. A formatter must be available, the file must not be saved after delay, and the editor must not be shutting down.'),
+        'description': nls.localizeByDefault('Format a file on save. A formatter must be available and the editor must not be shutting down. When {0} is set to `afterDelay`, the file will only be formatted when saved explicitly.'),
         'scope': PreferenceScope.fromString('language-overridable'),
     },
     'editor.formatOnSaveMode': {