@theia/plugin 1.26.0-next.2 → 1.26.0-next.22

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theia/plugin",
-  "version": "1.26.0-next.2+08722fad0ec",
+  "version": "1.26.0-next.22+1265154246d",
   "description": "Theia - Plugin API",
   "types": "./src/theia.d.ts",
   "publishConfig": {
@@ -32,5 +32,5 @@
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "08722fad0ecdd3259457c34db61b86c8da6b61c8"
+  "gitHead": "1265154246d98e44c0e1ee479aa9d42b2615d9d1"
 }

package/src/theia.d.ts

@@ -9232,6 +9232,20 @@ export module '@theia/plugin' {
          * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
          */
         export function registerCallHierarchyProvider(selector: DocumentSelector, provider: CallHierarchyProvider): Disposable;
+
+        /**
+         * Register a linked editing range provider.
+         *
+         * Multiple providers can be registered for a language. In that case providers are sorted
+         * by their {@link languages.match score} and the best-matching provider that has a result is used. Failure
+         * of the selected provider will cause a failure of the whole operation.
+         *
+         * @param selector A selector that defines the documents this provider is applicable to.
+         * @param provider A linked editing range provider.
+         * @return A {@link Disposable} that unregisters this provider when being disposed.
+         */
+        export function registerLinkedEditingRangeProvider(selector: DocumentSelector, provider: LinkedEditingRangeProvider): Disposable;
+
     }
 
     /**
@@ -9648,6 +9662,11 @@ export module '@theia/plugin' {
          */
         readonly name: string;
 
+        /**
+         * The workspace folder of this session or `undefined` for a folderless setup.
+         */
+        readonly workspaceFolder: WorkspaceFolder | undefined;
+
         /**
          * The "resolved" [debug configuration](#DebugConfiguration) of this session.
          */
@@ -11334,6 +11353,50 @@ export module '@theia/plugin' {
         provideCallHierarchyOutgoingCalls(item: CallHierarchyItem, token: CancellationToken): ProviderResult<CallHierarchyOutgoingCall[]>;
     }
 
+    /**
+     * Represents a list of ranges that can be edited together along with a word pattern to describe valid range contents.
+     */
+    export class LinkedEditingRanges {
+        /**
+         * Create a new linked editing ranges object.
+         *
+         * @param ranges A list of ranges that can be edited together
+         * @param wordPattern An optional word pattern that describes valid contents for the given ranges
+         */
+        constructor(ranges: Range[], wordPattern?: RegExp);
+
+        /**
+         * A list of ranges that can be edited together. The ranges must have
+         * identical length and text content. The ranges cannot overlap.
+         */
+        readonly ranges: Range[];
+
+        /**
+         * An optional word pattern that describes valid contents for the given ranges.
+         * If no pattern is provided, the language configuration's word pattern will be used.
+         */
+        readonly wordPattern?: RegExp;
+    }
+
+    /**
+     * The linked editing range provider interface defines the contract between extensions and
+     * the linked editing feature.
+     */
+    export interface LinkedEditingRangeProvider {
+        /**
+         * For a given position in a document, returns the range of the symbol at the position and all ranges
+         * that have the same content. A change to one of the ranges can be applied to all other ranges if the new content
+         * is valid. An optional word pattern can be returned with the result to describe valid contents.
+         * If no result-specific word pattern is provided, the word pattern from the language configuration is used.
+         *
+         * @param document The document in which the provider was invoked.
+         * @param position The position at which the provider was invoked.
+         * @param token A cancellation token.
+         * @return A list of ranges that can be edited together
+         */
+        provideLinkedEditingRanges(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<LinkedEditingRanges>;
+    }
+
     /**
      * Represents a session of a currently logged in user.
      */