@codingame/monaco-vscode-xterm-common 24.1.0

package/vscode/src/vs/workbench/contrib/terminal/browser/terminalActions.d.ts

@@ -0,0 +1,104 @@
+import { Action } from "@codingame/monaco-vscode-api/vscode/vs/base/common/actions";
+import { IDisposable } from "@codingame/monaco-vscode-api/vscode/vs/base/common/lifecycle";
+import { URI } from "@codingame/monaco-vscode-api/vscode/vs/base/common/uri";
+import { IAction2Options } from "@codingame/monaco-vscode-api/vscode/vs/platform/actions/common/actions";
+import { ICommandService } from "@codingame/monaco-vscode-api/vscode/vs/platform/commands/common/commands.service";
+import { ServicesAccessor } from "@codingame/monaco-vscode-api/vscode/vs/platform/instantiation/common/instantiation";
+import { Severity } from "@codingame/monaco-vscode-api/vscode/vs/platform/notification/common/notification";
+import { IOpenerService } from "@codingame/monaco-vscode-api/vscode/vs/platform/opener/common/opener.service";
+import { ITerminalProfile } from "@codingame/monaco-vscode-api/vscode/vs/platform/terminal/common/terminal";
+import { IWorkspaceFolder } from "@codingame/monaco-vscode-api/vscode/vs/platform/workspace/common/workspace";
+import { ITerminalProfileService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/terminal/common/terminal.service";
+import { ITerminalProfileResolverService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/terminal/common/terminal.service";
+import { IDetachedTerminalInstance, ITerminalInstance, IXtermTerminal } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/terminal/browser/terminal";
+import { ITerminalInstanceService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/terminal/browser/terminal.service";
+import { ITerminalGroupService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/terminal/browser/terminal.service";
+import { ITerminalEditingService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/terminal/browser/terminal.service";
+import { ITerminalEditorService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/terminal/browser/terminal.service";
+import { ITerminalConfigurationService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/terminal/browser/terminal.service";
+import { ITerminalService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/terminal/browser/terminal.service";
+export declare const switchTerminalShowTabsTitle: string;
+export declare const sharedWhenClause: {
+    terminalAvailable: import("@codingame/monaco-vscode-api/vscode/vs/platform/contextkey/common/contextkey").ContextKeyExpression | undefined;
+    terminalAvailable_and_opened: import("@codingame/monaco-vscode-api/vscode/vs/platform/contextkey/common/contextkey").ContextKeyExpression | undefined;
+    terminalAvailable_and_editorActive: import("@codingame/monaco-vscode-api/vscode/vs/platform/contextkey/common/contextkey").ContextKeyExpression | undefined;
+    terminalAvailable_and_singularSelection: import("@codingame/monaco-vscode-api/vscode/vs/platform/contextkey/common/contextkey").ContextKeyExpression | undefined;
+    focusInAny_and_normalBuffer: import("@codingame/monaco-vscode-api/vscode/vs/platform/contextkey/common/contextkey").ContextKeyExpression | undefined;
+};
+export interface WorkspaceFolderCwdPair {
+    folder: IWorkspaceFolder;
+    cwd: URI;
+    isAbsolute: boolean;
+    isOverridden: boolean;
+}
+export declare function getCwdForSplit(instance: ITerminalInstance, folders: IWorkspaceFolder[] | undefined, commandService: ICommandService, configService: ITerminalConfigurationService): Promise<string | URI | undefined>;
+export declare class TerminalLaunchHelpAction extends Action {
+    private readonly _openerService;
+    constructor(_openerService: IOpenerService);
+    run(): Promise<void>;
+}
+/**
+ * A wrapper function around registerAction2 to help make registering terminal actions more concise.
+ * The following default options are used if undefined:
+ *
+ * - `f1`: true
+ * - `category`: Terminal
+ * - `precondition`: TerminalContextKeys.processSupported
+ */
+export declare function registerTerminalAction(options: IAction2Options & {
+    run: (c: ITerminalServicesCollection, accessor: ServicesAccessor, args?: unknown, args2?: unknown) => void | Promise<unknown>;
+}): IDisposable;
+/**
+ * A wrapper around {@link registerTerminalAction} that runs a callback for all currently selected
+ * instances provided in the action context. This falls back to the active instance if there are no
+ * contextual instances provided.
+ */
+export declare function registerContextualInstanceAction(options: IAction2Options & {
+    /**
+     * When specified, only this type of active instance will be used when there are no
+     * contextual instances.
+     */
+    activeInstanceType?: "view" | "editor";
+    run: (instance: ITerminalInstance, c: ITerminalServicesCollection, accessor: ServicesAccessor, args?: unknown) => void | Promise<unknown>;
+    /**
+     * A callback to run after the `run` callbacks have completed.
+     * @param instances The selected instance(s) that the command was run on.
+     */
+    runAfter?: (instances: ITerminalInstance[], c: ITerminalServicesCollection, accessor: ServicesAccessor, args?: unknown) => void | Promise<unknown>;
+}): IDisposable;
+/**
+ * A wrapper around {@link registerTerminalAction} that ensures an active instance exists and
+ * provides it to the run function.
+ */
+export declare function registerActiveInstanceAction(options: IAction2Options & {
+    run: (activeInstance: ITerminalInstance, c: ITerminalServicesCollection, accessor: ServicesAccessor, args?: unknown) => void | Promise<unknown>;
+}): IDisposable;
+/**
+ * A wrapper around {@link registerTerminalAction} that ensures an active terminal
+ * exists and provides it to the run function.
+ *
+ * This includes detached xterm terminals that are not managed by an {@link ITerminalInstance}.
+ */
+export declare function registerActiveXtermAction(options: IAction2Options & {
+    run: (activeTerminal: IXtermTerminal, accessor: ServicesAccessor, instance: ITerminalInstance | IDetachedTerminalInstance, args?: unknown) => void | Promise<unknown>;
+}): IDisposable;
+export interface ITerminalServicesCollection {
+    service: ITerminalService;
+    configService: ITerminalConfigurationService;
+    groupService: ITerminalGroupService;
+    instanceService: ITerminalInstanceService;
+    editorService: ITerminalEditorService;
+    editingService: ITerminalEditingService;
+    profileService: ITerminalProfileService;
+    profileResolverService: ITerminalProfileResolverService;
+}
+export declare function registerTerminalActions(): void;
+export declare function validateTerminalName(name: string): {
+    content: string;
+    severity: Severity;
+} | null;
+export declare function refreshTerminalActions(detectedProfiles: ITerminalProfile[]): IDisposable;
+/**
+ * Drops repeated CWDs, if any, by keeping the one which best matches the workspace folder. It also preserves the original order.
+ */
+export declare function shrinkWorkspaceFolderCwdPairs(pairs: WorkspaceFolderCwdPair[]): WorkspaceFolderCwdPair[];