@sussudio/platform
Version:
Internal APIs for VS Code's service injection the base services.
651 lines (650 loc) • 24.8 kB
JavaScript
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { Codicon } from '@sussudio/base/common/codicons.mjs';
import { localize } from 'vscode-nls.mjs';
import { Extensions } from '../../configuration/common/configurationRegistry.mjs';
import { Registry } from '../../registry/common/platform.mjs';
import { createProfileSchemaEnums } from './terminalProfiles.mjs';
export const terminalColorSchema = {
type: ['string', 'null'],
enum: [
'terminal.ansiBlack',
'terminal.ansiRed',
'terminal.ansiGreen',
'terminal.ansiYellow',
'terminal.ansiBlue',
'terminal.ansiMagenta',
'terminal.ansiCyan',
'terminal.ansiWhite',
],
default: null,
};
export const terminalIconSchema = {
type: 'string',
enum: Array.from(Codicon.getAll(), (icon) => icon.id),
markdownEnumDescriptions: Array.from(Codicon.getAll(), (icon) => `$(${icon.id})`),
};
const terminalProfileBaseProperties = {
args: {
description: localize('terminalProfile.args', 'An optional set of arguments to run the shell executable with.'),
type: 'array',
items: {
type: 'string',
},
},
overrideName: {
description: localize(
'terminalProfile.overrideName',
'Controls whether or not the profile name overrides the auto detected one.',
),
type: 'boolean',
},
icon: {
description: localize('terminalProfile.icon', 'A codicon ID to associate with the terminal icon.'),
...terminalIconSchema,
},
color: {
description: localize('terminalProfile.color', 'A theme color ID to associate with the terminal icon.'),
...terminalColorSchema,
},
env: {
markdownDescription: localize(
'terminalProfile.env',
'An object with environment variables that will be added to the terminal profile process. Set to `null` to delete environment variables from the base environment.',
),
type: 'object',
additionalProperties: {
type: ['string', 'null'],
},
default: {},
},
};
const terminalProfileSchema = {
type: 'object',
required: ['path'],
properties: {
path: {
description: localize(
'terminalProfile.path',
'A single path to a shell executable or an array of paths that will be used as fallbacks when one fails.',
),
type: ['string', 'array'],
items: {
type: 'string',
},
},
...terminalProfileBaseProperties,
},
};
const terminalAutomationProfileSchema = {
type: 'object',
required: ['path'],
properties: {
path: {
description: localize('terminalAutomationProfile.path', 'A single path to a shell executable.'),
type: ['string'],
items: {
type: 'string',
},
},
...terminalProfileBaseProperties,
},
};
const shellDeprecationMessageLinux = localize(
'terminal.integrated.shell.linux.deprecation',
'This is deprecated, the new recommended way to configure your default shell is by creating a terminal profile in {0} and setting its profile name as the default in {1}. This will currently take priority over the new profiles settings but that will change in the future.',
'`#terminal.integrated.profiles.linux#`',
'`#terminal.integrated.defaultProfile.linux#`',
);
const shellDeprecationMessageOsx = localize(
'terminal.integrated.shell.osx.deprecation',
'This is deprecated, the new recommended way to configure your default shell is by creating a terminal profile in {0} and setting its profile name as the default in {1}. This will currently take priority over the new profiles settings but that will change in the future.',
'`#terminal.integrated.profiles.osx#`',
'`#terminal.integrated.defaultProfile.osx#`',
);
const shellDeprecationMessageWindows = localize(
'terminal.integrated.shell.windows.deprecation',
'This is deprecated, the new recommended way to configure your default shell is by creating a terminal profile in {0} and setting its profile name as the default in {1}. This will currently take priority over the new profiles settings but that will change in the future.',
'`#terminal.integrated.profiles.windows#`',
'`#terminal.integrated.defaultProfile.windows#`',
);
const automationShellDeprecationMessageLinux = localize(
'terminal.integrated.automationShell.linux.deprecation',
'This is deprecated, the new recommended way to configure your automation shell is by creating a terminal automation profile with {0}. This will currently take priority over the new automation profile settings but that will change in the future.',
'`#terminal.integrated.automationProfile.linux#`',
);
const automationShellDeprecationMessageOsx = localize(
'terminal.integrated.automationShell.osx.deprecation',
'This is deprecated, the new recommended way to configure your automation shell is by creating a terminal automation profile with {0}. This will currently take priority over the new automation profile settings but that will change in the future.',
'`#terminal.integrated.automationProfile.osx#`',
);
const automationShellDeprecationMessageWindows = localize(
'terminal.integrated.automationShell.windows.deprecation',
'This is deprecated, the new recommended way to configure your automation shell is by creating a terminal automation profile with {0}. This will currently take priority over the new automation profile settings but that will change in the future.',
'`#terminal.integrated.automationProfile.windows#`',
);
const terminalPlatformConfiguration = {
id: 'terminal',
order: 100,
title: localize('terminalIntegratedConfigurationTitle', 'Integrated Terminal'),
type: 'object',
properties: {
['terminal.integrated.automationShell.linux' /* TerminalSettingId.AutomationShellLinux */]: {
restricted: true,
markdownDescription: localize(
{
key: 'terminal.integrated.automationShell.linux',
comment: ['{0} and {1} are the `shell` and `shellArgs` settings keys'],
},
'A path that when set will override {0} and ignore {1} values for automation-related terminal usage like tasks and debug.',
'`terminal.integrated.shell.linux`',
'`shellArgs`',
),
type: ['string', 'null'],
default: null,
markdownDeprecationMessage: automationShellDeprecationMessageLinux,
},
['terminal.integrated.automationShell.osx' /* TerminalSettingId.AutomationShellMacOs */]: {
restricted: true,
markdownDescription: localize(
{
key: 'terminal.integrated.automationShell.osx',
comment: ['{0} and {1} are the `shell` and `shellArgs` settings keys'],
},
'A path that when set will override {0} and ignore {1} values for automation-related terminal usage like tasks and debug.',
'`terminal.integrated.shell.osx`',
'`shellArgs`',
),
type: ['string', 'null'],
default: null,
markdownDeprecationMessage: automationShellDeprecationMessageOsx,
},
['terminal.integrated.automationShell.windows' /* TerminalSettingId.AutomationShellWindows */]: {
restricted: true,
markdownDescription: localize(
{
key: 'terminal.integrated.automationShell.windows',
comment: ['{0} and {1} are the `shell` and `shellArgs` settings keys'],
},
'A path that when set will override {0} and ignore {1} values for automation-related terminal usage like tasks and debug.',
'`terminal.integrated.shell.windows`',
'`shellArgs`',
),
type: ['string', 'null'],
default: null,
markdownDeprecationMessage: automationShellDeprecationMessageWindows,
},
['terminal.integrated.automationProfile.linux' /* TerminalSettingId.AutomationProfileLinux */]: {
restricted: true,
markdownDescription: localize(
'terminal.integrated.automationProfile.linux',
'The terminal profile to use on Linux for automation-related terminal usage like tasks and debug. This setting will currently be ignored if {0} (now deprecated) is set.',
'`terminal.integrated.automationShell.linux`',
),
type: ['object', 'null'],
default: null,
anyOf: [{ type: 'null' }, terminalAutomationProfileSchema],
defaultSnippets: [
{
body: {
path: '${1}',
icon: '${2}',
},
},
],
},
['terminal.integrated.automationProfile.osx' /* TerminalSettingId.AutomationProfileMacOs */]: {
restricted: true,
markdownDescription: localize(
'terminal.integrated.automationProfile.osx',
'The terminal profile to use on macOS for automation-related terminal usage like tasks and debug. This setting will currently be ignored if {0} (now deprecated) is set.',
'`terminal.integrated.automationShell.osx`',
),
type: ['object', 'null'],
default: null,
anyOf: [{ type: 'null' }, terminalAutomationProfileSchema],
defaultSnippets: [
{
body: {
path: '${1}',
icon: '${2}',
},
},
],
},
['terminal.integrated.automationProfile.windows' /* TerminalSettingId.AutomationProfileWindows */]: {
restricted: true,
markdownDescription: localize(
'terminal.integrated.automationProfile.windows',
'The terminal profile to use for automation-related terminal usage like tasks and debug. This setting will currently be ignored if {0} (now deprecated) is set.',
'`terminal.integrated.automationShell.windows`',
),
type: ['object', 'null'],
default: null,
anyOf: [{ type: 'null' }, terminalAutomationProfileSchema],
defaultSnippets: [
{
body: {
path: '${1}',
icon: '${2}',
},
},
],
},
['terminal.integrated.shell.linux' /* TerminalSettingId.ShellLinux */]: {
restricted: true,
markdownDescription: localize(
'terminal.integrated.shell.linux',
'The path of the shell that the terminal uses on Linux. [Read more about configuring the shell](https://code.visualstudio.com/docs/editor/integrated-terminal#_terminal-profiles).',
),
type: ['string', 'null'],
default: null,
markdownDeprecationMessage: shellDeprecationMessageLinux,
},
['terminal.integrated.shell.osx' /* TerminalSettingId.ShellMacOs */]: {
restricted: true,
markdownDescription: localize(
'terminal.integrated.shell.osx',
'The path of the shell that the terminal uses on macOS. [Read more about configuring the shell](https://code.visualstudio.com/docs/editor/integrated-terminal#_terminal-profiles).',
),
type: ['string', 'null'],
default: null,
markdownDeprecationMessage: shellDeprecationMessageOsx,
},
['terminal.integrated.shell.windows' /* TerminalSettingId.ShellWindows */]: {
restricted: true,
markdownDescription: localize(
'terminal.integrated.shell.windows',
'The path of the shell that the terminal uses on Windows. [Read more about configuring the shell](https://code.visualstudio.com/docs/editor/integrated-terminal#_terminal-profiles).',
),
type: ['string', 'null'],
default: null,
markdownDeprecationMessage: shellDeprecationMessageWindows,
},
['terminal.integrated.shellArgs.linux' /* TerminalSettingId.ShellArgsLinux */]: {
restricted: true,
markdownDescription: localize(
'terminal.integrated.shellArgs.linux',
'The command line arguments to use when on the Linux terminal. [Read more about configuring the shell](https://code.visualstudio.com/docs/editor/integrated-terminal#_terminal-profiles).',
),
type: 'array',
items: {
type: 'string',
},
default: [],
markdownDeprecationMessage: shellDeprecationMessageLinux,
},
['terminal.integrated.shellArgs.osx' /* TerminalSettingId.ShellArgsMacOs */]: {
restricted: true,
markdownDescription: localize(
'terminal.integrated.shellArgs.osx',
'The command line arguments to use when on the macOS terminal. [Read more about configuring the shell](https://code.visualstudio.com/docs/editor/integrated-terminal#_terminal-profiles).',
),
type: 'array',
items: {
type: 'string',
},
// Unlike on Linux, ~/.profile is not sourced when logging into a macOS session. This
// is the reason terminals on macOS typically run login shells by default which set up
// the environment. See http://unix.stackexchange.com/a/119675/115410
default: ['-l'],
markdownDeprecationMessage: shellDeprecationMessageOsx,
},
['terminal.integrated.shellArgs.windows' /* TerminalSettingId.ShellArgsWindows */]: {
restricted: true,
markdownDescription: localize(
'terminal.integrated.shellArgs.windows',
'The command line arguments to use when on the Windows terminal. [Read more about configuring the shell](https://code.visualstudio.com/docs/editor/integrated-terminal#_terminal-profiles).',
),
anyOf: [
{
type: 'array',
items: {
type: 'string',
markdownDescription: localize(
'terminal.integrated.shellArgs.windows',
'The command line arguments to use when on the Windows terminal. [Read more about configuring the shell](https://code.visualstudio.com/docs/editor/integrated-terminal#_terminal-profiles).',
),
},
},
{
type: 'string',
markdownDescription: localize(
'terminal.integrated.shellArgs.windows.string',
'The command line arguments in [command-line format](https://msdn.microsoft.com/en-au/08dfcab2-eb6e-49a4-80eb-87d4076c98c6) to use when on the Windows terminal. [Read more about configuring the shell](https://code.visualstudio.com/docs/editor/integrated-terminal#_terminal-profiles).',
),
},
],
default: [],
markdownDeprecationMessage: shellDeprecationMessageWindows,
},
['terminal.integrated.profiles.windows' /* TerminalSettingId.ProfilesWindows */]: {
restricted: true,
markdownDescription: localize(
{
key: 'terminal.integrated.profiles.windows',
comment: ['{0}, {1}, and {2} are the `source`, `path` and optional `args` settings keys'],
},
"The Windows profiles to present when creating a new terminal via the terminal dropdown. Use the {0} property to automatically detect the shell's location. Or set the {1} property manually with an optional {2}.\n\nSet an existing profile to {3} to hide the profile from the list, for example: {4}.",
'`source`',
'`path`',
'`args`',
'`null`',
'`"Ubuntu-20.04 (WSL)": null`',
),
type: 'object',
default: {
PowerShell: {
source: 'PowerShell',
icon: 'terminal-powershell',
},
'Command Prompt': {
path: ['${env:windir}\\Sysnative\\cmd.exe', '${env:windir}\\System32\\cmd.exe'],
args: [],
icon: 'terminal-cmd',
},
'Git Bash': {
source: 'Git Bash',
},
},
additionalProperties: {
anyOf: [
{
type: 'object',
required: ['source'],
properties: {
source: {
description: localize(
'terminalProfile.windowsSource',
'A profile source that will auto detect the paths to the shell. Note that non-standard executable locations are not supported and must be created manually in a new profile.',
),
enum: ['PowerShell', 'Git Bash'],
},
...terminalProfileBaseProperties,
},
},
{
type: 'object',
required: ['extensionIdentifier', 'id', 'title'],
properties: {
extensionIdentifier: {
description: localize(
'terminalProfile.windowsExtensionIdentifier',
'The extension that contributed this profile.',
),
type: 'string',
},
id: {
description: localize('terminalProfile.windowsExtensionId', 'The id of the extension terminal'),
type: 'string',
},
title: {
description: localize('terminalProfile.windowsExtensionTitle', 'The name of the extension terminal'),
type: 'string',
},
...terminalProfileBaseProperties,
},
},
{ type: 'null' },
terminalProfileSchema,
],
},
},
['terminal.integrated.profiles.osx' /* TerminalSettingId.ProfilesMacOs */]: {
restricted: true,
markdownDescription: localize(
{
key: 'terminal.integrated.profile.osx',
comment: ['{0} and {1} are the `path` and optional `args` settings keys'],
},
'The macOS profiles to present when creating a new terminal via the terminal dropdown. Set the {0} property manually with an optional {1}.\n\nSet an existing profile to {2} to hide the profile from the list, for example: {3}.',
'`path`',
'`args`',
'`null`',
'`"bash": null`',
),
type: 'object',
default: {
bash: {
path: 'bash',
args: ['-l'],
icon: 'terminal-bash',
},
zsh: {
path: 'zsh',
args: ['-l'],
},
fish: {
path: 'fish',
args: ['-l'],
},
tmux: {
path: 'tmux',
icon: 'terminal-tmux',
},
pwsh: {
path: 'pwsh',
icon: 'terminal-powershell',
},
},
additionalProperties: {
anyOf: [
{
type: 'object',
required: ['extensionIdentifier', 'id', 'title'],
properties: {
extensionIdentifier: {
description: localize(
'terminalProfile.osxExtensionIdentifier',
'The extension that contributed this profile.',
),
type: 'string',
},
id: {
description: localize('terminalProfile.osxExtensionId', 'The id of the extension terminal'),
type: 'string',
},
title: {
description: localize('terminalProfile.osxExtensionTitle', 'The name of the extension terminal'),
type: 'string',
},
...terminalProfileBaseProperties,
},
},
{ type: 'null' },
terminalProfileSchema,
],
},
},
['terminal.integrated.profiles.linux' /* TerminalSettingId.ProfilesLinux */]: {
restricted: true,
markdownDescription: localize(
{
key: 'terminal.integrated.profile.linux',
comment: ['{0} and {1} are the `path` and optional `args` settings keys'],
},
'The Linux profiles to present when creating a new terminal via the terminal dropdown. Set the {0} property manually with an optional {1}.\n\nSet an existing profile to {2} to hide the profile from the list, for example: {3}.',
'`path`',
'`args`',
'`null`',
'`"bash": null`',
),
type: 'object',
default: {
bash: {
path: 'bash',
icon: 'terminal-bash',
},
zsh: {
path: 'zsh',
},
fish: {
path: 'fish',
},
tmux: {
path: 'tmux',
icon: 'terminal-tmux',
},
pwsh: {
path: 'pwsh',
icon: 'terminal-powershell',
},
},
additionalProperties: {
anyOf: [
{
type: 'object',
required: ['extensionIdentifier', 'id', 'title'],
properties: {
extensionIdentifier: {
description: localize(
'terminalProfile.linuxExtensionIdentifier',
'The extension that contributed this profile.',
),
type: 'string',
},
id: {
description: localize('terminalProfile.linuxExtensionId', 'The id of the extension terminal'),
type: 'string',
},
title: {
description: localize('terminalProfile.linuxExtensionTitle', 'The name of the extension terminal'),
type: 'string',
},
...terminalProfileBaseProperties,
},
},
{ type: 'null' },
terminalProfileSchema,
],
},
},
['terminal.integrated.useWslProfiles' /* TerminalSettingId.UseWslProfiles */]: {
description: localize(
'terminal.integrated.useWslProfiles',
'Controls whether or not WSL distros are shown in the terminal dropdown',
),
type: 'boolean',
default: true,
},
['terminal.integrated.inheritEnv' /* TerminalSettingId.InheritEnv */]: {
scope: 1 /* ConfigurationScope.APPLICATION */,
description: localize(
'terminal.integrated.inheritEnv',
'Whether new shells should inherit their environment from VS Code, which may source a login shell to ensure $PATH and other development variables are initialized. This has no effect on Windows.',
),
type: 'boolean',
default: true,
},
['terminal.integrated.persistentSessionScrollback' /* TerminalSettingId.PersistentSessionScrollback */]: {
scope: 1 /* ConfigurationScope.APPLICATION */,
markdownDescription: localize(
'terminal.integrated.persistentSessionScrollback',
'Controls the maximum amount of lines that will be restored when reconnecting to a persistent terminal session. Increasing this will restore more lines of scrollback at the cost of more memory and increase the time it takes to connect to terminals on start up. This setting requires a restart to take effect and should be set to a value less than or equal to `#terminal.integrated.scrollback#`.',
),
type: 'number',
default: 100,
},
['terminal.integrated.showLinkHover' /* TerminalSettingId.ShowLinkHover */]: {
scope: 1 /* ConfigurationScope.APPLICATION */,
description: localize(
'terminal.integrated.showLinkHover',
'Whether to show hovers for links in the terminal output.',
),
type: 'boolean',
default: true,
},
['terminal.integrated.ignoreProcessNames' /* TerminalSettingId.IgnoreProcessNames */]: {
description: localize(
'terminal.integrated.confirmIgnoreProcesses',
'A set of process names to ignore when using the {0} setting.',
'`terminal.integrated.confirmOnKill`',
),
type: 'array',
items: {
type: 'string',
uniqueItems: true,
},
default: [
// Popular prompt programs, these should not count as child processes
'starship',
'oh-my-posh',
// Git bash may runs a subprocess of itself (bin\bash.exe -> usr\bin\bash.exe)
'bash',
'zsh',
],
},
},
};
/**
* Registers terminal configurations required by shared process and remote server.
*/
export function registerTerminalPlatformConfiguration() {
Registry.as(Extensions.Configuration).registerConfiguration(terminalPlatformConfiguration);
registerTerminalDefaultProfileConfiguration();
}
let defaultProfilesConfiguration;
export function registerTerminalDefaultProfileConfiguration(detectedProfiles, extensionContributedProfiles) {
const registry = Registry.as(Extensions.Configuration);
let profileEnum;
if (detectedProfiles) {
profileEnum = createProfileSchemaEnums(detectedProfiles?.profiles, extensionContributedProfiles);
}
const oldDefaultProfilesConfiguration = defaultProfilesConfiguration;
defaultProfilesConfiguration = {
id: 'terminal',
order: 100,
title: localize('terminalIntegratedConfigurationTitle', 'Integrated Terminal'),
type: 'object',
properties: {
['terminal.integrated.defaultProfile.linux' /* TerminalSettingId.DefaultProfileLinux */]: {
restricted: true,
markdownDescription: localize(
'terminal.integrated.defaultProfile.linux',
'The default profile used on Linux. This setting will currently be ignored if either {0} or {1} are set.',
'`terminal.integrated.shell.linux`',
'`terminal.integrated.shellArgs.linux`',
),
type: ['string', 'null'],
default: null,
enum: detectedProfiles?.os === 3 /* OperatingSystem.Linux */ ? profileEnum?.values : undefined,
markdownEnumDescriptions:
detectedProfiles?.os === 3 /* OperatingSystem.Linux */ ? profileEnum?.markdownDescriptions : undefined,
},
['terminal.integrated.defaultProfile.osx' /* TerminalSettingId.DefaultProfileMacOs */]: {
restricted: true,
markdownDescription: localize(
'terminal.integrated.defaultProfile.osx',
'The default profile used on macOS. This setting will currently be ignored if either {0} or {1} are set.',
'`terminal.integrated.shell.osx`',
'`terminal.integrated.shellArgs.osx`',
),
type: ['string', 'null'],
default: null,
enum: detectedProfiles?.os === 2 /* OperatingSystem.Macintosh */ ? profileEnum?.values : undefined,
markdownEnumDescriptions:
detectedProfiles?.os === 2 /* OperatingSystem.Macintosh */ ? profileEnum?.markdownDescriptions : undefined,
},
['terminal.integrated.defaultProfile.windows' /* TerminalSettingId.DefaultProfileWindows */]: {
restricted: true,
markdownDescription: localize(
'terminal.integrated.defaultProfile.windows',
'The default profile used on Windows. This setting will currently be ignored if either {0} or {1} are set.',
'`terminal.integrated.shell.windows`',
'`terminal.integrated.shellArgs.windows`',
),
type: ['string', 'null'],
default: null,
enum: detectedProfiles?.os === 1 /* OperatingSystem.Windows */ ? profileEnum?.values : undefined,
markdownEnumDescriptions:
detectedProfiles?.os === 1 /* OperatingSystem.Windows */ ? profileEnum?.markdownDescriptions : undefined,
},
},
};
registry.updateConfigurations({
add: [defaultProfilesConfiguration],
remove: oldDefaultProfilesConfiguration ? [oldDefaultProfilesConfiguration] : [],
});
}