@theia/plugin 1.24.0-next.5 → 1.24.0-next.6

package/README.md

@@ -681,8 +681,9 @@ Example of code symbol provider registration:
 ```typescript
 const documentsSelector: theia.DocumentSelector = { scheme: 'file', language: 'typescript' };
 const provider = { provideDocumentSymbols: provideSymbols };
+const metadata = { label: 'providerLabel' }
 
-const disposable = theia.languages.registerDocumentSymbolProvider(documentsSelector, provider);
+const disposable = theia.languages.registerDocumentSymbolProvider(documentsSelector, provider, metadata);
 
 ...
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theia/plugin",
-  "version": "1.24.0-next.5+e292e0efff2",
+  "version": "1.24.0-next.6+7fd85c0991f",
   "description": "Theia - Plugin API",
   "types": "./src/theia.d.ts",
   "publishConfig": {
@@ -32,5 +32,5 @@
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "e292e0efff25da6a81c86acc828b97d9d02bba8a"
+  "gitHead": "7fd85c0991f4adc4bb79dd749aa8495df2aff1a3"
 }

package/src/theia.d.ts

@@ -6952,6 +6952,16 @@ export module '@theia/plugin' {
         provideDocumentSymbols(document: TextDocument, token: CancellationToken): ProviderResult<SymbolInformation[] | DocumentSymbol[]>;
     }
 
+    /**
+     * Metadata about a {@link DocumentSymbolProvider}.
+     */
+    export interface DocumentSymbolProviderMetadata {
+        /**
+         * A human-readable string that is shown when multiple outline trees show for one document.
+         */
+        label?: string;
+    }
+
     /**
      * Represents a color in RGBA space.
      */
@@ -8974,9 +8984,11 @@ export module '@theia/plugin' {
          *
          * @param selector A selector that defines the documents this provider is applicable to.
          * @param provider A document symbol provider.
-         * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
+         * @param metadata Optional metadata about the provider.
+         * @return A {@link Disposable disposable} that unregisters this provider when being disposed.
          */
-        export function registerDocumentSymbolProvider(selector: DocumentSelector, provider: DocumentSymbolProvider): Disposable;
+        export function registerDocumentSymbolProvider(selector: DocumentSelector, provider: DocumentSymbolProvider,
+            metadata?: DocumentSymbolProviderMetadata): Disposable;
 
         /**
          * Register a color provider.