@theia/plugin 1.53.0-next.55 → 1.53.0-next.64

package/src/theia.proposed.textSearchProvider.d.ts

@@ -1,145 +1,145 @@
-// *****************************************************************************
-// Copyright (C) 2023 Ericsson and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-// code copied and modified from https://github.com/microsoft/vscode/blob/1.77.0/src/vscode-dts/vscode.proposed.textSearchQuery.d.ts
-
-export module '@theia/plugin' {
-
-    /**
-     * The parameters of a query for text search.
-     */
-    export interface TextSearchQuery {
-        /**
-         * The text pattern to search for.
-         */
-        pattern: string;
-
-        /**
-         * Whether or not `pattern` should match multiple lines of text.
-         */
-        isMultiline?: boolean;
-
-        /**
-         * Whether or not `pattern` should be interpreted as a regular expression.
-         */
-        isRegExp?: boolean;
-
-        /**
-         * Whether or not the search should be case-sensitive.
-         */
-        isCaseSensitive?: boolean;
-
-        /**
-         * Whether or not to search for whole word matches only.
-         */
-        isWordMatch?: boolean;
-    }
-
-    /**
-     * A match from a text search
-     */
-    export interface TextSearchMatch {
-        /**
-         * The uri for the matching document.
-         */
-        uri: Uri;
-
-        /**
-         * The range of the match within the document, or multiple ranges for multiple matches.
-         */
-        ranges: Range | Range[];
-
-        /**
-         * A preview of the text match.
-         */
-        preview: TextSearchMatchPreview;
-    }
-
-    /**
-     * A preview of the text result.
-     */
-    export interface TextSearchMatchPreview {
-        /**
-         * The matching lines of text, or a portion of the matching line that contains the match.
-         */
-        text: string;
-
-        /**
-         * The Range within `text` corresponding to the text of the match.
-         * The number of matches must match the TextSearchMatch's range property.
-         */
-        matches: Range | Range[];
-    }
-
-    /**
-     * Options to specify the size of the result text preview.
-     * These options don't affect the size of the match itself, just the amount of preview text.
-     */
-    export interface TextSearchPreviewOptions {
-        /**
-         * The maximum number of lines in the preview.
-         * Only search providers that support multiline search will ever return more than one line in the match.
-         */
-        matchLines: number;
-
-        /**
-         * The maximum number of characters included per line.
-         */
-        charsPerLine: number;
-    }
-
-    /**
-     * A line of context surrounding a TextSearchMatch.
-     */
-    export interface TextSearchContext {
-        /**
-         * The uri for the matching document.
-         */
-        uri: Uri;
-
-        /**
-         * One line of text.
-         * previewOptions.charsPerLine applies to this
-         */
-        text: string;
-
-        /**
-         * The line number of this line of context.
-         */
-        lineNumber: number;
-    }
-
-    export type TextSearchResult = TextSearchMatch | TextSearchContext;
-
-    /**
-     * Information collected when text search is complete.
-     */
-    export interface TextSearchComplete {
-        /**
-         * Whether the search hit the limit on the maximum number of search results.
-         * `maxResults` on [`TextSearchOptions`](#TextSearchOptions) specifies the max number of results.
-         * - If exactly that number of matches exist, this should be false.
-         * - If `maxResults` matches are returned and more exist, this should be true.
-         * - If search hits an internal limit which is less than `maxResults`, this should be true.
-         */
-        limitHit?: boolean;
-    }
-
-}
+// *****************************************************************************
+// Copyright (C) 2023 Ericsson and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+// code copied and modified from https://github.com/microsoft/vscode/blob/1.77.0/src/vscode-dts/vscode.proposed.textSearchQuery.d.ts
+
+export module '@theia/plugin' {
+
+    /**
+     * The parameters of a query for text search.
+     */
+    export interface TextSearchQuery {
+        /**
+         * The text pattern to search for.
+         */
+        pattern: string;
+
+        /**
+         * Whether or not `pattern` should match multiple lines of text.
+         */
+        isMultiline?: boolean;
+
+        /**
+         * Whether or not `pattern` should be interpreted as a regular expression.
+         */
+        isRegExp?: boolean;
+
+        /**
+         * Whether or not the search should be case-sensitive.
+         */
+        isCaseSensitive?: boolean;
+
+        /**
+         * Whether or not to search for whole word matches only.
+         */
+        isWordMatch?: boolean;
+    }
+
+    /**
+     * A match from a text search
+     */
+    export interface TextSearchMatch {
+        /**
+         * The uri for the matching document.
+         */
+        uri: Uri;
+
+        /**
+         * The range of the match within the document, or multiple ranges for multiple matches.
+         */
+        ranges: Range | Range[];
+
+        /**
+         * A preview of the text match.
+         */
+        preview: TextSearchMatchPreview;
+    }
+
+    /**
+     * A preview of the text result.
+     */
+    export interface TextSearchMatchPreview {
+        /**
+         * The matching lines of text, or a portion of the matching line that contains the match.
+         */
+        text: string;
+
+        /**
+         * The Range within `text` corresponding to the text of the match.
+         * The number of matches must match the TextSearchMatch's range property.
+         */
+        matches: Range | Range[];
+    }
+
+    /**
+     * Options to specify the size of the result text preview.
+     * These options don't affect the size of the match itself, just the amount of preview text.
+     */
+    export interface TextSearchPreviewOptions {
+        /**
+         * The maximum number of lines in the preview.
+         * Only search providers that support multiline search will ever return more than one line in the match.
+         */
+        matchLines: number;
+
+        /**
+         * The maximum number of characters included per line.
+         */
+        charsPerLine: number;
+    }
+
+    /**
+     * A line of context surrounding a TextSearchMatch.
+     */
+    export interface TextSearchContext {
+        /**
+         * The uri for the matching document.
+         */
+        uri: Uri;
+
+        /**
+         * One line of text.
+         * previewOptions.charsPerLine applies to this
+         */
+        text: string;
+
+        /**
+         * The line number of this line of context.
+         */
+        lineNumber: number;
+    }
+
+    export type TextSearchResult = TextSearchMatch | TextSearchContext;
+
+    /**
+     * Information collected when text search is complete.
+     */
+    export interface TextSearchComplete {
+        /**
+         * Whether the search hit the limit on the maximum number of search results.
+         * `maxResults` on [`TextSearchOptions`](#TextSearchOptions) specifies the max number of results.
+         * - If exactly that number of matches exist, this should be false.
+         * - If `maxResults` matches are returned and more exist, this should be true.
+         * - If search hits an internal limit which is less than `maxResults`, this should be true.
+         */
+        limitHit?: boolean;
+    }
+
+}

package/src/theia.proposed.timeline.d.ts

@@ -1,177 +1,177 @@
-// *****************************************************************************
-// Copyright (C) 2023 Ericsson and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-// code copied and modified from https://github.com/microsoft/vscode/blob/1.77.0/src/vscode-dts/vscode.proposed.timeline.d.ts
-
-export module '@theia/plugin' {
-
-    export class TimelineItem {
-        /**
-         * A timestamp (in milliseconds since 1 January 1970 00:00:00) for when the timeline item occurred.
-         */
-        timestamp: number;
-
-        /**
-         * A human-readable string describing the timeline item.
-         */
-        label: string;
-
-        /**
-         * Optional id for the timeline item. It must be unique across all the timeline items provided by this source.
-         *
-         * If not provided, an id is generated using the timeline item's timestamp.
-         */
-        id?: string;
-
-        /**
-         * The icon path or [ThemeIcon](#ThemeIcon) for the timeline item.
-         */
-        iconPath?: Uri | { light: Uri; dark: Uri } | ThemeIcon;
-
-        /**
-         * A human readable string describing less prominent details of the timeline item.
-         */
-        description?: string;
-
-        /**
-         * The tooltip text when you hover over the timeline item.
-         */
-        detail?: string;
-
-        /**
-         * The [command](#Command) that should be executed when the timeline item is selected.
-         */
-        command?: Command;
-
-        /**
-         * Context value of the timeline item. This can be used to contribute specific actions to the item.
-         * For example, a timeline item is given a context value as `commit`. When contributing actions to `timeline/item/context`
-         * using `menus` extension point, you can specify context value for key `timelineItem` in `when` expression like `timelineItem == commit`.
-         * ```
-         * "contributes": {
-         *   "menus": {
-         *     "timeline/item/context": [{
-         *       "command": "extension.copyCommitId",
-         *       "when": "timelineItem == commit"
-         *      }]
-         *   }
-         * }
-         * ```
-         * This will show the `extension.copyCommitId` action only for items where `contextValue` is `commit`.
-         */
-        contextValue?: string;
-
-        /**
-         * Accessibility information used when screen reader interacts with this timeline item.
-         */
-        accessibilityInformation?: AccessibilityInformation;
-
-        /**
-         * @param label A human-readable string describing the timeline item
-         * @param timestamp A timestamp (in milliseconds since 1 January 1970 00:00:00) for when the timeline item occurred
-         */
-        constructor(label: string, timestamp: number);
-    }
-
-    export interface TimelineChangeEvent {
-        /**
-         * The [uri](#Uri) of the resource for which the timeline changed.
-         */
-        uri: Uri;
-
-        /**
-         * A flag which indicates whether the entire timeline should be reset.
-         */
-        reset?: boolean;
-    }
-
-    export interface Timeline {
-        readonly paging?: {
-            /**
-             * A provider-defined cursor specifying the starting point of timeline items which are after the ones returned.
-             * Use `undefined` to signal that there are no more items to be returned.
-             */
-            readonly cursor: string | undefined;
-        }
-
-        /**
-         * An array of [timeline items](#TimelineItem).
-         */
-        readonly items: readonly TimelineItem[];
-    }
-
-    export interface TimelineOptions {
-        /**
-         * A provider-defined cursor specifying the starting point of the timeline items that should be returned.
-         */
-        cursor?: string;
-
-        /**
-         * An optional maximum number timeline items or the all timeline items newer (inclusive) than the timestamp or id that should be returned.
-         * If `undefined` all timeline items should be returned.
-         */
-        limit?: number | { timestamp: number; id?: string };
-    }
-
-    export interface TimelineProvider {
-        /**
-         * An optional event to signal that the timeline for a source has changed.
-         * To signal that the timeline for all resources (uris) has changed, do not pass any argument or pass `undefined`.
-         */
-        onDidChange?: Event<TimelineChangeEvent | undefined>;
-
-        /**
-         * An identifier of the source of the timeline items. This can be used to filter sources.
-         */
-        readonly id: string;
-
-        /**
-         * A human-readable string describing the source of the timeline items. This can be used as the display label when filtering sources.
-         */
-        readonly label: string;
-
-        /**
-         * Provide [timeline items](#TimelineItem) for a [Uri](#Uri).
-         *
-         * @param uri The [uri](#Uri) of the file to provide the timeline for.
-         * @param options A set of options to determine how results should be returned.
-         * @param token A cancellation token.
-         * @return The [timeline result](#TimelineResult) or a thenable that resolves to such. The lack of a result
-         * can be signaled by returning `undefined`, `null`, or an empty array.
-         */
-        provideTimeline(uri: Uri, options: TimelineOptions, token: CancellationToken): ProviderResult<Timeline>;
-    }
-
-    export namespace workspace {
-        /**
-         * Register a timeline provider.
-         *
-         * Multiple providers can be registered. In that case, providers are asked in
-         * parallel and the results are merged. A failing provider (rejected promise or exception) will
-         * not cause a failure of the whole operation.
-         *
-         * @param scheme A scheme or schemes that defines which documents this provider is applicable to. Can be `*` to target all documents.
-         * @param provider A timeline provider.
-         * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
-         */
-        export function registerTimelineProvider(scheme: string | string[], provider: TimelineProvider): Disposable;
-    }
-
-}
+// *****************************************************************************
+// Copyright (C) 2023 Ericsson and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+// code copied and modified from https://github.com/microsoft/vscode/blob/1.77.0/src/vscode-dts/vscode.proposed.timeline.d.ts
+
+export module '@theia/plugin' {
+
+    export class TimelineItem {
+        /**
+         * A timestamp (in milliseconds since 1 January 1970 00:00:00) for when the timeline item occurred.
+         */
+        timestamp: number;
+
+        /**
+         * A human-readable string describing the timeline item.
+         */
+        label: string;
+
+        /**
+         * Optional id for the timeline item. It must be unique across all the timeline items provided by this source.
+         *
+         * If not provided, an id is generated using the timeline item's timestamp.
+         */
+        id?: string;
+
+        /**
+         * The icon path or [ThemeIcon](#ThemeIcon) for the timeline item.
+         */
+        iconPath?: Uri | { light: Uri; dark: Uri } | ThemeIcon;
+
+        /**
+         * A human readable string describing less prominent details of the timeline item.
+         */
+        description?: string;
+
+        /**
+         * The tooltip text when you hover over the timeline item.
+         */
+        detail?: string;
+
+        /**
+         * The [command](#Command) that should be executed when the timeline item is selected.
+         */
+        command?: Command;
+
+        /**
+         * Context value of the timeline item. This can be used to contribute specific actions to the item.
+         * For example, a timeline item is given a context value as `commit`. When contributing actions to `timeline/item/context`
+         * using `menus` extension point, you can specify context value for key `timelineItem` in `when` expression like `timelineItem == commit`.
+         * ```
+         * "contributes": {
+         *   "menus": {
+         *     "timeline/item/context": [{
+         *       "command": "extension.copyCommitId",
+         *       "when": "timelineItem == commit"
+         *      }]
+         *   }
+         * }
+         * ```
+         * This will show the `extension.copyCommitId` action only for items where `contextValue` is `commit`.
+         */
+        contextValue?: string;
+
+        /**
+         * Accessibility information used when screen reader interacts with this timeline item.
+         */
+        accessibilityInformation?: AccessibilityInformation;
+
+        /**
+         * @param label A human-readable string describing the timeline item
+         * @param timestamp A timestamp (in milliseconds since 1 January 1970 00:00:00) for when the timeline item occurred
+         */
+        constructor(label: string, timestamp: number);
+    }
+
+    export interface TimelineChangeEvent {
+        /**
+         * The [uri](#Uri) of the resource for which the timeline changed.
+         */
+        uri: Uri;
+
+        /**
+         * A flag which indicates whether the entire timeline should be reset.
+         */
+        reset?: boolean;
+    }
+
+    export interface Timeline {
+        readonly paging?: {
+            /**
+             * A provider-defined cursor specifying the starting point of timeline items which are after the ones returned.
+             * Use `undefined` to signal that there are no more items to be returned.
+             */
+            readonly cursor: string | undefined;
+        }
+
+        /**
+         * An array of [timeline items](#TimelineItem).
+         */
+        readonly items: readonly TimelineItem[];
+    }
+
+    export interface TimelineOptions {
+        /**
+         * A provider-defined cursor specifying the starting point of the timeline items that should be returned.
+         */
+        cursor?: string;
+
+        /**
+         * An optional maximum number timeline items or the all timeline items newer (inclusive) than the timestamp or id that should be returned.
+         * If `undefined` all timeline items should be returned.
+         */
+        limit?: number | { timestamp: number; id?: string };
+    }
+
+    export interface TimelineProvider {
+        /**
+         * An optional event to signal that the timeline for a source has changed.
+         * To signal that the timeline for all resources (uris) has changed, do not pass any argument or pass `undefined`.
+         */
+        onDidChange?: Event<TimelineChangeEvent | undefined>;
+
+        /**
+         * An identifier of the source of the timeline items. This can be used to filter sources.
+         */
+        readonly id: string;
+
+        /**
+         * A human-readable string describing the source of the timeline items. This can be used as the display label when filtering sources.
+         */
+        readonly label: string;
+
+        /**
+         * Provide [timeline items](#TimelineItem) for a [Uri](#Uri).
+         *
+         * @param uri The [uri](#Uri) of the file to provide the timeline for.
+         * @param options A set of options to determine how results should be returned.
+         * @param token A cancellation token.
+         * @return The [timeline result](#TimelineResult) or a thenable that resolves to such. The lack of a result
+         * can be signaled by returning `undefined`, `null`, or an empty array.
+         */
+        provideTimeline(uri: Uri, options: TimelineOptions, token: CancellationToken): ProviderResult<Timeline>;
+    }
+
+    export namespace workspace {
+        /**
+         * Register a timeline provider.
+         *
+         * Multiple providers can be registered. In that case, providers are asked in
+         * parallel and the results are merged. A failing provider (rejected promise or exception) will
+         * not cause a failure of the whole operation.
+         *
+         * @param scheme A scheme or schemes that defines which documents this provider is applicable to. Can be `*` to target all documents.
+         * @param provider A timeline provider.
+         * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
+         */
+        export function registerTimelineProvider(scheme: string | string[], provider: TimelineProvider): Disposable;
+    }
+
+}