@theia/plugin 1.37.0-next.21 → 1.37.0-next.29

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theia/plugin",
-  "version": "1.37.0-next.21+2deedbad7",
+  "version": "1.37.0-next.29+53b3841a9",
   "description": "Theia - Plugin API",
   "types": "./src/theia.d.ts",
   "publishConfig": {
@@ -32,5 +32,5 @@
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "2deedbad70bd4b503bf9c7e733ab9603f492600f"
+  "gitHead": "53b3841a910f05937c6f18cbeb61395dd893ded4"
 }

package/src/theia-proposed.d.ts

@@ -168,35 +168,6 @@ export module '@theia/plugin' {
         color?: ThemeColor;
     }
 
-    // #region LogLevel: https://github.com/microsoft/vscode/issues/85992
-
-    /**
-     * The severity level of a log message
-     */
-    export enum LogLevel {
-        Trace = 1,
-        Debug = 2,
-        Info = 3,
-        Warning = 4,
-        Error = 5,
-        Critical = 6,
-        Off = 7
-    }
-
-    export namespace env {
-        /**
-         * Current logging level.
-         */
-        export const logLevel: LogLevel;
-
-        /**
-         * An [event](#Event) that fires when the log level has changed.
-         */
-        export const onDidChangeLogLevel: Event<LogLevel>;
-    }
-
-    // #endregion
-
     // #region search in workspace
     /**
      * The parameters of a query for text search.

package/src/theia.d.ts

@@ -2702,6 +2702,9 @@ export module '@theia/plugin' {
 
     /**
      * An output channel is a container for readonly textual information.
+     *
+     * To get an instance of an `OutputChannel` use
+     * {@link window.createOutputChannel createOutputChannel}.
      */
     export interface OutputChannel {
 
@@ -2765,6 +2768,106 @@ export module '@theia/plugin' {
         dispose(): void;
     }
 
+    /**
+     * Log levels
+     */
+    export enum LogLevel {
+
+        /**
+         * No messages are logged with this level.
+         */
+        Off = 0,
+
+        /**
+         * All messages are logged with this level.
+         */
+        Trace = 1,
+
+        /**
+         * Messages with debug and higher log level are logged with this level.
+         */
+        Debug = 2,
+
+        /**
+         * Messages with info and higher log level are logged with this level.
+         */
+        Info = 3,
+
+        /**
+         * Messages with warning and higher log level are logged with this level.
+         */
+        Warning = 4,
+
+        /**
+         * Only error messages are logged with this level.
+         */
+        Error = 5
+    }
+
+    /**
+     * A channel for containing log output.
+     *
+     * To get an instance of a `LogOutputChannel` use
+     * {@link window.createOutputChannel createOutputChannel}.
+     */
+    export interface LogOutputChannel extends OutputChannel {
+
+        /**
+         * The current log level of the channel. Defaults to {@link env.logLevel editor log level}.
+         */
+        readonly logLevel: LogLevel;
+
+        /**
+         * An {@link Event} which fires when the log level of the channel changes.
+         */
+        readonly onDidChangeLogLevel: Event<LogLevel>;
+
+        /**
+         * Outputs the given trace message to the channel. Use this method to log verbose information.
+         *
+         * The message is only loggeed if the channel is configured to display {@link LogLevel.Trace trace} log level.
+         *
+         * @param message trace message to log
+         */
+        trace(message: string, ...args: any[]): void;
+
+        /**
+         * Outputs the given debug message to the channel.
+         *
+         * The message is only loggeed if the channel is configured to display {@link LogLevel.Debug debug} log level or lower.
+         *
+         * @param message debug message to log
+         */
+        debug(message: string, ...args: any[]): void;
+
+        /**
+         * Outputs the given information message to the channel.
+         *
+         * The message is only loggeed if the channel is configured to display {@link LogLevel.Info info} log level or lower.
+         *
+         * @param message info message to log
+         */
+        info(message: string, ...args: any[]): void;
+
+        /**
+         * Outputs the given warning message to the channel.
+         *
+         * The message is only loggeed if the channel is configured to display {@link LogLevel.Warning warning} log level or lower.
+         *
+         * @param message warning message to log
+         */
+        warn(message: string, ...args: any[]): void;
+
+        /**
+         * Outputs the given error or error message to the channel.
+         *
+         * The message is only loggeed if the channel is configured to display {@link LogLevel.Error error} log level or lower.
+         *
+         * @param error Error or error message to log
+         */
+        error(error: string | Error, ...args: any[]): void;
+    }
+
     /**
      * Options to configure the behaviour of a file open dialog.
      *
@@ -5250,6 +5353,14 @@ export module '@theia/plugin' {
          */
         export function createOutputChannel(name: string): OutputChannel;
 
+        /**
+         * Creates a new {@link LogOutputChannel log output channel} with the given name.
+         *
+         * @param name Human-readable string which will be used to represent the channel in the UI.
+         * @param options Options for the log output channel.
+         */
+        export function createOutputChannel(name: string, options: { log: true }): LogOutputChannel;
+
         /**
          * Create new terminal.
          * @param name - terminal name to display on the UI.
@@ -7527,6 +7638,15 @@ export module '@theia/plugin' {
          */
         export function asExternalUri(target: Uri): Thenable<Uri>;
 
+        /**
+         * The current log level of the editor.
+         */
+        export const logLevel: LogLevel;
+
+        /**
+         * An {@link Event} which fires when the log level of the editor changes.
+         */
+        export const onDidChangeLogLevel: Event<LogLevel>;
     }
 
     /**
@@ -12864,6 +12984,11 @@ export module '@theia/plugin' {
          */
         label?: string;
 
+        /**
+         * The optional state of a comment thread, which may affect how the comment is displayed.
+         */
+        state?: CommentThreadState;
+
         /**
          * Dispose this comment thread.
          *
@@ -12877,6 +13002,14 @@ export module '@theia/plugin' {
         canReply: boolean;
     }
 
+    /**
+     * The state of a comment thread.
+     */
+    export enum CommentThreadState {
+        Unresolved = 0,
+        Resolved = 1
+    }
+
     /**
      * Author information of a {@link Comment comment}
      */
@@ -15439,6 +15572,14 @@ export interface TestRunProfile {
      */
     isDefault: boolean;
 
+    /**
+     * Whether this profile supports continuous running of requests. If so,
+     * then {@link TestRunRequest.continuous} may be set to `true`. Defaults
+     * to false.
+     * @stubbed
+     */
+    supportsContinuousRun: boolean;
+
     /**
      * Associated tag for the profile. If this is set, only {@link TestItem}
      * instances with the same tag will be eligible to execute in this profile.
@@ -15461,6 +15602,11 @@ export interface TestRunProfile {
      * associated with the request should be created before the function returns
      * or the returned promise is resolved.
      *
+     * If {@link supportsContinuousRun} is set, then {@link TestRunRequest.continuous}
+     * may be `true`. In this case, the profile should observe changes to
+     * source code and create new test runs by calling {@link TestController.createTestRun},
+     * until the cancellation is requested on the `token`.
+     *
      * @param request Request information for the test run.
      * @param cancellationToken Token that signals the used asked to abort the
      * test run. If cancellation is requested on this token, all {@link TestRun}
@@ -15520,11 +15666,12 @@ export interface TestController {
      * @param runHandler Function called to start a test run.
      * @param isDefault Whether this is the default action for its kind.
      * @param tag Profile test tag.
+     * @param supportsContinuousRun Whether the profile supports continuous running.
      * @returns An instance of a {@link TestRunProfile}, which is automatically
      * associated with this controller.
      * @stubbed
      */
-    createRunProfile(label: string, kind: TestRunProfileKind, runHandler: (request: TestRunRequest, token: CancellationToken) => Thenable<void> | void, isDefault?: boolean, tag?: TestTag): TestRunProfile;
+    createRunProfile(label: string, kind: TestRunProfileKind, runHandler: (request: TestRunRequest, token: CancellationToken) => Thenable<void> | void, isDefault?: boolean, tag?: TestTag, supportsContinuousRun?: boolean): TestRunProfile;
 
     /**
      * A function provided by the extension that the editor may call to request
@@ -15644,12 +15791,19 @@ export class TestRunRequest {
      */
     readonly profile: TestRunProfile | undefined;
 
+    /**
+     * Whether the profile should run continuously as source code changes. Only
+     * relevant for profiles that set {@link TestRunProfile.supportsContinuousRun}.
+     */
+    readonly continuous?: boolean;
+
     /**
      * @param include Array of specific tests to run, or undefined to run all tests
      * @param exclude An array of tests to exclude from the run.
      * @param profile The run profile used for this request.
+     * @param continuous Whether to run tests continuously as source changes.
      */
-    constructor(include?: readonly TestItem[], exclude?: readonly TestItem[], profile?: TestRunProfile);
+    constructor(include?: readonly TestItem[], exclude?: readonly TestItem[], profile?: TestRunProfile, continuous?: boolean);
 }
 
 /**