Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve terminal profile config help #183424

Merged
merged 1 commit into from May 25, 2023
+19 −22
Merged

Improve terminal profile config help #183424

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
41 changes: 19 additions & 22 deletions src/vs/platform/terminal/common/terminalPlatformConfiguration.ts
View file
Open in desktop
Expand Up @@ -5,7 +5,7 @@

import { getAllCodicons } from 'vs/base/common/codicons';
import { IJSONSchema, IJSONSchemaMap } from 'vs/base/common/jsonSchema';
import { OperatingSystem } from 'vs/base/common/platform';
import { OperatingSystem, Platform, PlatformToString } from 'vs/base/common/platform';
import { localize } from 'vs/nls';
import { ConfigurationScope, Extensions, IConfigurationNode, IConfigurationRegistry } from 'vs/platform/configuration/common/configurationRegistry';
import { Registry } from 'vs/platform/registry/common/platform';
Expand Down Expand Up @@ -93,6 +93,21 @@ const terminalAutomationProfileSchema: IJSONSchema = {
}
};

function createTerminalProfileMarkdownDescription(platform: Platform.Linux | Platform.Mac | Platform.Windows): string {
const key = platform === Platform.Linux ? 'linux' : platform === Platform.Mac ? 'osx' : 'windows';
return localize(
{
key: 'terminal.integrated.profile',
comment: ['{0} is the platform, {1} is a code block, {2} and {3} are a link start and end']
},
"A set of terminal profile customizations for {0} which allows adding, removing or changing how terminals are launched. Profiles are made up of a mandatory path, optional arguments and other presentation options.\n\nTo override an existing profile use its profile name as the key, for example:\n\n{1}\n\n{2}Read more about configuring profiles{3}.",
PlatformToString(platform),
'```json\n"terminal.integrated.profile.' + key + '": {\n "bash": null\n}\n```',
'[',
'](https://code.visualstudio.com/docs/terminal/profiles)'
);
}

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#`');
Expand Down Expand Up @@ -255,13 +270,7 @@ const terminalPlatformConfiguration: IConfigurationNode = {
},
[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`'
),
markdownDescription: createTerminalProfileMarkdownDescription(Platform.Windows),
type: 'object',
default: {
'PowerShell': {
Expand Down Expand Up @@ -319,13 +328,7 @@ const terminalPlatformConfiguration: IConfigurationNode = {
},
[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`'
),
markdownDescription: createTerminalProfileMarkdownDescription(Platform.Mac),
type: 'object',
default: {
'bash': {
Expand Down Expand Up @@ -378,13 +381,7 @@ const terminalPlatformConfiguration: IConfigurationNode = {
},
[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`'
),
markdownDescription: createTerminalProfileMarkdownDescription(Platform.Linux),
type: 'object',
default: {
'bash': {
Expand Down