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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (28) hide show
  1. package/README.md +766 -766
  2. package/package.json +3 -3
  3. package/src/package.spec.ts +28 -28
  4. package/src/theia-extra.d.ts +410 -410
  5. package/src/theia.d.ts +18078 -17684
  6. package/src/theia.proposed.canonicalUriProvider.d.ts +64 -64
  7. package/src/theia.proposed.customEditorMove.d.ts +41 -41
  8. package/src/theia.proposed.debugVisualization.d.ts +189 -189
  9. package/src/theia.proposed.diffCommand.d.ts +55 -55
  10. package/src/theia.proposed.documentPaste.d.ts +316 -316
  11. package/src/theia.proposed.editSessionIdentityProvider.d.ts +89 -89
  12. package/src/theia.proposed.extensionsAny.d.ts +57 -57
  13. package/src/theia.proposed.externalUriOpener.d.ts +158 -158
  14. package/src/theia.proposed.findTextInFiles.d.ts +178 -178
  15. package/src/theia.proposed.fsChunks.d.ts +32 -32
  16. package/src/theia.proposed.mappedEditsProvider.d.ts +59 -59
  17. package/src/theia.proposed.multiDocumentHighlightProvider.ts +82 -82
  18. package/src/theia.proposed.notebookCellExecutionState.d.ts +68 -68
  19. package/src/theia.proposed.notebookKernelSource.d.ts +62 -62
  20. package/src/theia.proposed.notebookMessaging.d.ts +84 -84
  21. package/src/theia.proposed.portsAttributes.d.ts +115 -115
  22. package/src/theia.proposed.profileContentHandlers.d.ts +35 -35
  23. package/src/theia.proposed.resolvers.d.ts +44 -44
  24. package/src/theia.proposed.scmValidation.d.ts +70 -70
  25. package/src/theia.proposed.shareProvider.d.ts +92 -92
  26. package/src/theia.proposed.terminalQuickFixProvider.d.ts +103 -103
  27. package/src/theia.proposed.textSearchProvider.d.ts +145 -145
  28. package/src/theia.proposed.timeline.d.ts +177 -177
@@ -1,92 +1,92 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2023 STMicroelectronics and others.
3
- //
4
- // This program and the accompanying materials are made available under the
5
- // terms of the Eclipse Public License v. 2.0 which is available at
6
- // http://www.eclipse.org/legal/epl-2.0.
7
- //
8
- // This Source Code may also be made available under the following Secondary
9
- // Licenses when the conditions for such availability set forth in the Eclipse
10
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
- // with the GNU Classpath Exception which is available at
12
- // https://www.gnu.org/software/classpath/license.html.
13
- //
14
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
- // *****************************************************************************
16
-
17
- /*---------------------------------------------------------------------------------------------
18
- * Copyright (c) Microsoft Corporation. All rights reserved.
19
- * Licensed under the MIT License. See License.txt in the project root for license information.
20
- *--------------------------------------------------------------------------------------------*/
21
-
22
- // code copied and modified from https://github.com/microsoft/vscode/blob/release/1.79/src/vscode-dts/vscode.proposed.shareProvider.d.ts
23
-
24
- // https://github.com/microsoft/vscode/issues/176316 @joyceerhl
25
-
26
- export module '@theia/plugin' {
27
-
28
- /**
29
- * Data about an item which can be shared.
30
- */
31
- export interface ShareableItem {
32
- /**
33
- * A resource in the workspace that can be shared.
34
- */
35
- resourceUri: Uri;
36
-
37
- /**
38
- * If present, a selection within the `resourceUri`.
39
- */
40
- selection?: Range;
41
- }
42
-
43
- /**
44
- * A provider which generates share links for resources in the editor.
45
- */
46
- export interface ShareProvider {
47
-
48
- /**
49
- * A unique ID for the provider.
50
- * This will be used to activate specific extensions contributing share providers if necessary.
51
- */
52
- readonly id: string;
53
-
54
- /**
55
- * A label which will be used to present this provider's options in the UI.
56
- */
57
- readonly label: string;
58
-
59
- /**
60
- * The order in which the provider should be listed in the UI when there are multiple providers.
61
- */
62
- readonly priority: number;
63
-
64
- /**
65
- *
66
- * @param item Data about an item which can be shared.
67
- * @param token A cancellation token.
68
- * @returns A {@link Uri} representing an external link or sharing text. The provider result
69
- * will be copied to the user's clipboard and presented in a confirmation dialog.
70
- */
71
- provideShare(item: ShareableItem, token: CancellationToken): ProviderResult<Uri | string>;
72
- }
73
-
74
- export namespace window {
75
-
76
- /**
77
- * Register a share provider. An extension may register multiple share providers.
78
- * There may be multiple share providers for the same {@link ShareableItem}.
79
- * @param selector A document selector to filter whether the provider should be shown for a {@link ShareableItem}.
80
- * @param provider A share provider.
81
- */
82
- export function registerShareProvider(selector: DocumentSelector, provider: ShareProvider): Disposable;
83
- }
84
-
85
- export interface TreeItem {
86
-
87
- /**
88
- * An optional property which, when set, inlines a `Share` option in the context menu for this tree item.
89
- */
90
- shareableItem?: ShareableItem;
91
- }
92
- }
1
+ // *****************************************************************************
2
+ // Copyright (C) 2023 STMicroelectronics and others.
3
+ //
4
+ // This program and the accompanying materials are made available under the
5
+ // terms of the Eclipse Public License v. 2.0 which is available at
6
+ // http://www.eclipse.org/legal/epl-2.0.
7
+ //
8
+ // This Source Code may also be made available under the following Secondary
9
+ // Licenses when the conditions for such availability set forth in the Eclipse
10
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
+ // with the GNU Classpath Exception which is available at
12
+ // https://www.gnu.org/software/classpath/license.html.
13
+ //
14
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+
17
+ /*---------------------------------------------------------------------------------------------
18
+ * Copyright (c) Microsoft Corporation. All rights reserved.
19
+ * Licensed under the MIT License. See License.txt in the project root for license information.
20
+ *--------------------------------------------------------------------------------------------*/
21
+
22
+ // code copied and modified from https://github.com/microsoft/vscode/blob/release/1.79/src/vscode-dts/vscode.proposed.shareProvider.d.ts
23
+
24
+ // https://github.com/microsoft/vscode/issues/176316 @joyceerhl
25
+
26
+ export module '@theia/plugin' {
27
+
28
+ /**
29
+ * Data about an item which can be shared.
30
+ */
31
+ export interface ShareableItem {
32
+ /**
33
+ * A resource in the workspace that can be shared.
34
+ */
35
+ resourceUri: Uri;
36
+
37
+ /**
38
+ * If present, a selection within the `resourceUri`.
39
+ */
40
+ selection?: Range;
41
+ }
42
+
43
+ /**
44
+ * A provider which generates share links for resources in the editor.
45
+ */
46
+ export interface ShareProvider {
47
+
48
+ /**
49
+ * A unique ID for the provider.
50
+ * This will be used to activate specific extensions contributing share providers if necessary.
51
+ */
52
+ readonly id: string;
53
+
54
+ /**
55
+ * A label which will be used to present this provider's options in the UI.
56
+ */
57
+ readonly label: string;
58
+
59
+ /**
60
+ * The order in which the provider should be listed in the UI when there are multiple providers.
61
+ */
62
+ readonly priority: number;
63
+
64
+ /**
65
+ *
66
+ * @param item Data about an item which can be shared.
67
+ * @param token A cancellation token.
68
+ * @returns A {@link Uri} representing an external link or sharing text. The provider result
69
+ * will be copied to the user's clipboard and presented in a confirmation dialog.
70
+ */
71
+ provideShare(item: ShareableItem, token: CancellationToken): ProviderResult<Uri | string>;
72
+ }
73
+
74
+ export namespace window {
75
+
76
+ /**
77
+ * Register a share provider. An extension may register multiple share providers.
78
+ * There may be multiple share providers for the same {@link ShareableItem}.
79
+ * @param selector A document selector to filter whether the provider should be shown for a {@link ShareableItem}.
80
+ * @param provider A share provider.
81
+ */
82
+ export function registerShareProvider(selector: DocumentSelector, provider: ShareProvider): Disposable;
83
+ }
84
+
85
+ export interface TreeItem {
86
+
87
+ /**
88
+ * An optional property which, when set, inlines a `Share` option in the context menu for this tree item.
89
+ */
90
+ shareableItem?: ShareableItem;
91
+ }
92
+ }
@@ -1,103 +1,103 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2023 Ericsson and others.
3
- //
4
- // This program and the accompanying materials are made available under the
5
- // terms of the Eclipse Public License v. 2.0 which is available at
6
- // http://www.eclipse.org/legal/epl-2.0.
7
- //
8
- // This Source Code may also be made available under the following Secondary
9
- // Licenses when the conditions for such availability set forth in the Eclipse
10
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
- // with the GNU Classpath Exception which is available at
12
- // https://www.gnu.org/software/classpath/license.html.
13
- //
14
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
- // *****************************************************************************
16
-
17
- /*---------------------------------------------------------------------------------------------
18
- * Copyright (c) Microsoft Corporation. All rights reserved.
19
- * Licensed under the MIT License. See License.txt in the project root for license information.
20
- *--------------------------------------------------------------------------------------------*/
21
- // code copied and modified from https://github.com/microsoft/vscode/blob/1.77.0/src/vscode-dts/vscode.proposed.terminalQuickFixProvider.d.ts
22
-
23
- export module '@theia/plugin' {
24
-
25
- export type SingleOrMany<T> = T[] | T;
26
-
27
- export namespace window {
28
- /**
29
- * @param provider A terminal quick fix provider
30
- * @return A {@link Disposable} that un-registers the provider when being disposed
31
- */
32
- export function registerTerminalQuickFixProvider(id: string, provider: TerminalQuickFixProvider): Disposable;
33
- }
34
-
35
- export interface TerminalQuickFixProvider {
36
- /**
37
- * Provides terminal quick fixes
38
- * @param commandMatchResult The command match result for which to provide quick fixes
39
- * @param token A cancellation token indicating the result is no longer needed
40
- * @return Terminal quick fix(es) if any
41
- */
42
- provideTerminalQuickFixes(commandMatchResult: TerminalCommandMatchResult, token: CancellationToken):
43
- ProviderResult<SingleOrMany<TerminalQuickFixTerminalCommand | TerminalQuickFixOpener | Command>>;
44
- }
45
-
46
- export interface TerminalCommandMatchResult {
47
- commandLine: string;
48
- commandLineMatch: RegExpMatchArray;
49
- outputMatch?: {
50
- regexMatch: RegExpMatchArray;
51
- outputLines?: string[];
52
- };
53
- }
54
-
55
- export class TerminalQuickFixTerminalCommand {
56
- /**
57
- * The terminal command to insert or run
58
- */
59
- terminalCommand: string;
60
- /**
61
- * Whether the command should be executed or just inserted (default)
62
- */
63
- shouldExecute?: boolean;
64
- constructor(terminalCommand: string, shouldExecute?: boolean);
65
- }
66
- export class TerminalQuickFixOpener {
67
- /**
68
- * The uri to open
69
- */
70
- uri: Uri;
71
- constructor(uri: Uri);
72
- }
73
-
74
- /**
75
- * A matcher that runs on a sub-section of a terminal command's output
76
- */
77
- interface TerminalOutputMatcher {
78
- /**
79
- * A string or regex to match against the unwrapped line. If this is a regex with the multiline
80
- * flag, it will scan an amount of lines equal to `\n` instances in the regex + 1.
81
- */
82
- lineMatcher: string | RegExp;
83
- /**
84
- * Which side of the output to anchor the {@link offset} and {@link length} against.
85
- */
86
- anchor: TerminalOutputAnchor;
87
- /**
88
- * The number of rows above or below the {@link anchor} to start matching against.
89
- */
90
- offset: number;
91
- /**
92
- * The number of wrapped lines to match against, this should be as small as possible for performance
93
- * reasons. This is capped at 40.
94
- */
95
- length: number;
96
- }
97
-
98
- enum TerminalOutputAnchor {
99
- Top = 0,
100
- Bottom = 1
101
- }
102
-
103
- }
1
+ // *****************************************************************************
2
+ // Copyright (C) 2023 Ericsson and others.
3
+ //
4
+ // This program and the accompanying materials are made available under the
5
+ // terms of the Eclipse Public License v. 2.0 which is available at
6
+ // http://www.eclipse.org/legal/epl-2.0.
7
+ //
8
+ // This Source Code may also be made available under the following Secondary
9
+ // Licenses when the conditions for such availability set forth in the Eclipse
10
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
+ // with the GNU Classpath Exception which is available at
12
+ // https://www.gnu.org/software/classpath/license.html.
13
+ //
14
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+
17
+ /*---------------------------------------------------------------------------------------------
18
+ * Copyright (c) Microsoft Corporation. All rights reserved.
19
+ * Licensed under the MIT License. See License.txt in the project root for license information.
20
+ *--------------------------------------------------------------------------------------------*/
21
+ // code copied and modified from https://github.com/microsoft/vscode/blob/1.77.0/src/vscode-dts/vscode.proposed.terminalQuickFixProvider.d.ts
22
+
23
+ export module '@theia/plugin' {
24
+
25
+ export type SingleOrMany<T> = T[] | T;
26
+
27
+ export namespace window {
28
+ /**
29
+ * @param provider A terminal quick fix provider
30
+ * @return A {@link Disposable} that un-registers the provider when being disposed
31
+ */
32
+ export function registerTerminalQuickFixProvider(id: string, provider: TerminalQuickFixProvider): Disposable;
33
+ }
34
+
35
+ export interface TerminalQuickFixProvider {
36
+ /**
37
+ * Provides terminal quick fixes
38
+ * @param commandMatchResult The command match result for which to provide quick fixes
39
+ * @param token A cancellation token indicating the result is no longer needed
40
+ * @return Terminal quick fix(es) if any
41
+ */
42
+ provideTerminalQuickFixes(commandMatchResult: TerminalCommandMatchResult, token: CancellationToken):
43
+ ProviderResult<SingleOrMany<TerminalQuickFixTerminalCommand | TerminalQuickFixOpener | Command>>;
44
+ }
45
+
46
+ export interface TerminalCommandMatchResult {
47
+ commandLine: string;
48
+ commandLineMatch: RegExpMatchArray;
49
+ outputMatch?: {
50
+ regexMatch: RegExpMatchArray;
51
+ outputLines?: string[];
52
+ };
53
+ }
54
+
55
+ export class TerminalQuickFixTerminalCommand {
56
+ /**
57
+ * The terminal command to insert or run
58
+ */
59
+ terminalCommand: string;
60
+ /**
61
+ * Whether the command should be executed or just inserted (default)
62
+ */
63
+ shouldExecute?: boolean;
64
+ constructor(terminalCommand: string, shouldExecute?: boolean);
65
+ }
66
+ export class TerminalQuickFixOpener {
67
+ /**
68
+ * The uri to open
69
+ */
70
+ uri: Uri;
71
+ constructor(uri: Uri);
72
+ }
73
+
74
+ /**
75
+ * A matcher that runs on a sub-section of a terminal command's output
76
+ */
77
+ interface TerminalOutputMatcher {
78
+ /**
79
+ * A string or regex to match against the unwrapped line. If this is a regex with the multiline
80
+ * flag, it will scan an amount of lines equal to `\n` instances in the regex + 1.
81
+ */
82
+ lineMatcher: string | RegExp;
83
+ /**
84
+ * Which side of the output to anchor the {@link offset} and {@link length} against.
85
+ */
86
+ anchor: TerminalOutputAnchor;
87
+ /**
88
+ * The number of rows above or below the {@link anchor} to start matching against.
89
+ */
90
+ offset: number;
91
+ /**
92
+ * The number of wrapped lines to match against, this should be as small as possible for performance
93
+ * reasons. This is capped at 40.
94
+ */
95
+ length: number;
96
+ }
97
+
98
+ enum TerminalOutputAnchor {
99
+ Top = 0,
100
+ Bottom = 1
101
+ }
102
+
103
+ }