dots.vscode.terminal-options — io.github.dots-cljs/dots-vscode 1.89.0-6

Value-object describing what options a terminal should use.

color cljs

(color terminal-options)

The icon {@link ThemeColor } for the terminal. The terminal.ansi* theme keys are recommended for the best contrast and consistency across themes.

Returns: ThemeColor | undefined

cwd cljs

(cwd terminal-options)

A path or Uri for the current working directory to be used for the terminal.

Returns: string | Uri | undefined

env cljs

(env terminal-options)

Object with environment variables that will be added to the editor process.

Returns: { [key: string]: string | null | undefined; } | undefined

hide-from-user? cljs

(hide-from-user? terminal-options)

When enabled the terminal will run the process as normal but not be surfaced to the user until Terminal.show is called. The typical usage for this is when you need to run something that may need interactivity but only want to tell the user about it when interaction is needed. Note that the terminals will still be exposed to all extensions as normal. The hidden terminals will not be restored when the workspace is next opened.

Returns: boolean | undefined

icon-path cljs

(icon-path terminal-options)

The icon path or {@link ThemeIcon } for the terminal.

Returns: Uri | ThemeIcon | { light: Uri; dark: Uri; } | undefined

location cljs

(location terminal-options)

The {@link TerminalLocation } or {@link TerminalEditorLocationOptions } or {@link TerminalSplitLocationOptions } for the terminal.

Returns: TerminalLocation | TerminalEditorLocationOptions | TerminalSplitLocationOptions | undefined

message cljs

(message terminal-options)

A message to write to the terminal on first launch, note that this is not sent to the process but, rather written directly to the terminal. This supports escape sequences such a setting text style.

Returns: string | undefined

name cljs

(name terminal-options)

A human-readable string which will be used to represent the terminal in the UI.

Returns: string | undefined

set-color! cljs

(set-color! terminal-options value)

The icon {@link ThemeColor } for the terminal. The terminal.ansi* theme keys are recommended for the best contrast and consistency across themes.

set-cwd! cljs

(set-cwd! terminal-options value)

A path or Uri for the current working directory to be used for the terminal.

set-env! cljs

(set-env! terminal-options value)

Object with environment variables that will be added to the editor process.

set-hide-from-user! cljs

(set-hide-from-user! terminal-options value)

When enabled the terminal will run the process as normal but not be surfaced to the user until Terminal.show is called. The typical usage for this is when you need to run something that may need interactivity but only want to tell the user about it when interaction is needed. Note that the terminals will still be exposed to all extensions as normal. The hidden terminals will not be restored when the workspace is next opened.

set-icon-path! cljs

(set-icon-path! terminal-options value)

The icon path or {@link ThemeIcon } for the terminal.

set-is-transient! cljs

(set-is-transient! terminal-options value)

Opt-out of the default terminal persistence on restart and reload. This will only take effect when terminal.integrated.enablePersistentSessions is enabled.

set-location! cljs

(set-location! terminal-options value)

The {@link TerminalLocation } or {@link TerminalEditorLocationOptions } or {@link TerminalSplitLocationOptions } for the terminal.

set-message! cljs

(set-message! terminal-options value)

A message to write to the terminal on first launch, note that this is not sent to the process but, rather written directly to the terminal. This supports escape sequences such a setting text style.

set-name! cljs

(set-name! terminal-options value)

A human-readable string which will be used to represent the terminal in the UI.

set-shell-args! cljs

(set-shell-args! terminal-options value)

Args for the custom shell executable. A string can be used on Windows only which allows specifying shell args in command-line format.

set-shell-path! cljs

(set-shell-path! terminal-options value)

A path to a custom shell executable to be used in the terminal.

set-strict-env! cljs

(set-strict-env! terminal-options value)

Whether the terminal process environment should be exactly as provided in TerminalOptions.env. When this is false (default), the environment will be based on the window's environment and also apply configured platform settings like terminal.integrated.env.windows on top. When this is true, the complete environment must be provided as nothing will be inherited from the process or any configuration.

shell-args cljs

(shell-args terminal-options)

Args for the custom shell executable. A string can be used on Windows only which allows specifying shell args in command-line format.

Returns: string | string[] | undefined

shell-path cljs

(shell-path terminal-options)

A path to a custom shell executable to be used in the terminal.

Returns: string | undefined

strict-env? cljs

(strict-env? terminal-options)

Whether the terminal process environment should be exactly as provided in TerminalOptions.env. When this is false (default), the environment will be based on the window's environment and also apply configured platform settings like terminal.integrated.env.windows on top. When this is true, the complete environment must be provided as nothing will be inherited from the process or any configuration.

Returns: boolean | undefined

transient? cljs

(transient? terminal-options)

Opt-out of the default terminal persistence on restart and reload. This will only take effect when terminal.integrated.enablePersistentSessions is enabled.

Returns: boolean | undefined