@codingame/monaco-vscode-api 4.0.0 → 4.1.0

package/vscode/src/vs/platform/terminal/common/terminalPlatformConfiguration.js

@@ -0,0 +1,518 @@
+import { getAllCodicons } from '../../../base/common/codicons.js';
+import { PlatformToString } from '../../../base/common/platform.js';
+import { localizeWithPath } from '../../../nls.js';
+import { Extensions } from '../../configuration/common/configurationRegistry.js';
+import { Registry } from '../../registry/common/platform.js';
+import { createProfileSchemaEnums } from './terminalProfiles.js';
+const terminalColorSchema = {
+    type: ['string', 'null'],
+    enum: [
+        'terminal.ansiBlack',
+        'terminal.ansiRed',
+        'terminal.ansiGreen',
+        'terminal.ansiYellow',
+        'terminal.ansiBlue',
+        'terminal.ansiMagenta',
+        'terminal.ansiCyan',
+        'terminal.ansiWhite'
+    ],
+    default: null
+};
+const terminalIconSchema = {
+    type: 'string',
+    enum: Array.from(getAllCodicons(), icon => icon.id),
+    markdownEnumDescriptions: Array.from(getAllCodicons(), icon => `$(${icon.id})`),
+};
+const terminalProfileBaseProperties = {
+    args: {
+        description: ( localizeWithPath(
+            'vs/platform/terminal/common/terminalPlatformConfiguration',
+            'terminalProfile.args',
+            'An optional set of arguments to run the shell executable with.'
+        )),
+        type: 'array',
+        items: {
+            type: 'string'
+        }
+    },
+    overrideName: {
+        description: ( localizeWithPath(
+            'vs/platform/terminal/common/terminalPlatformConfiguration',
+            'terminalProfile.overrideName',
+            'Whether or not to replace the dynamic terminal title that detects what program is running with the static profile name.'
+        )),
+        type: 'boolean'
+    },
+    icon: {
+        description: ( localizeWithPath(
+            'vs/platform/terminal/common/terminalPlatformConfiguration',
+            'terminalProfile.icon',
+            'A codicon ID to associate with the terminal icon.'
+        )),
+        ...terminalIconSchema
+    },
+    color: {
+        description: ( localizeWithPath(
+            'vs/platform/terminal/common/terminalPlatformConfiguration',
+            'terminalProfile.color',
+            'A theme color ID to associate with the terminal icon.'
+        )),
+        ...terminalColorSchema
+    },
+    env: {
+        markdownDescription: ( localizeWithPath(
+            'vs/platform/terminal/common/terminalPlatformConfiguration',
+            '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: ( localizeWithPath(
+                'vs/platform/terminal/common/terminalPlatformConfiguration',
+                '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: ( localizeWithPath(
+                'vs/platform/terminal/common/terminalPlatformConfiguration',
+                'terminalAutomationProfile.path',
+                'A single path to a shell executable.'
+            )),
+            type: ['string'],
+            items: {
+                type: 'string'
+            }
+        },
+        ...terminalProfileBaseProperties
+    }
+};
+function createTerminalProfileMarkdownDescription(platform) {
+    const key = platform === 2  ? 'linux' : platform === 1  ? 'osx' : 'windows';
+    return ( localizeWithPath('vs/platform/terminal/common/terminalPlatformConfiguration', {
+        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 terminalPlatformConfiguration = {
+    id: 'terminal',
+    order: 100,
+    title: ( localizeWithPath(
+        'vs/platform/terminal/common/terminalPlatformConfiguration',
+        'terminalIntegratedConfigurationTitle',
+        "Integrated Terminal"
+    )),
+    type: 'object',
+    properties: {
+        ["terminal.integrated.automationProfile.linux" ]: {
+            restricted: true,
+            markdownDescription: ( localizeWithPath(
+                'vs/platform/terminal/common/terminalPlatformConfiguration',
+                'terminal.integrated.automationProfile.linux',
+                "The terminal profile to use on Linux for automation-related terminal usage like tasks and debug."
+            )),
+            type: ['object', 'null'],
+            default: null,
+            'anyOf': [
+                { type: 'null' },
+                terminalAutomationProfileSchema
+            ],
+            defaultSnippets: [
+                {
+                    body: {
+                        path: '${1}',
+                        icon: '${2}'
+                    }
+                }
+            ]
+        },
+        ["terminal.integrated.automationProfile.osx" ]: {
+            restricted: true,
+            markdownDescription: ( localizeWithPath(
+                'vs/platform/terminal/common/terminalPlatformConfiguration',
+                'terminal.integrated.automationProfile.osx',
+                "The terminal profile to use on macOS for automation-related terminal usage like tasks and debug."
+            )),
+            type: ['object', 'null'],
+            default: null,
+            'anyOf': [
+                { type: 'null' },
+                terminalAutomationProfileSchema
+            ],
+            defaultSnippets: [
+                {
+                    body: {
+                        path: '${1}',
+                        icon: '${2}'
+                    }
+                }
+            ]
+        },
+        ["terminal.integrated.automationProfile.windows" ]: {
+            restricted: true,
+            markdownDescription: ( localizeWithPath(
+                'vs/platform/terminal/common/terminalPlatformConfiguration',
+                '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.profiles.windows" ]: {
+            restricted: true,
+            markdownDescription: createTerminalProfileMarkdownDescription(3 ),
+            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: ( localizeWithPath(
+                                    'vs/platform/terminal/common/terminalPlatformConfiguration',
+                                    '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: ( localizeWithPath(
+                                    'vs/platform/terminal/common/terminalPlatformConfiguration',
+                                    'terminalProfile.windowsExtensionIdentifier',
+                                    'The extension that contributed this profile.'
+                                )),
+                                type: 'string'
+                            },
+                            id: {
+                                description: ( localizeWithPath(
+                                    'vs/platform/terminal/common/terminalPlatformConfiguration',
+                                    'terminalProfile.windowsExtensionId',
+                                    'The id of the extension terminal'
+                                )),
+                                type: 'string'
+                            },
+                            title: {
+                                description: ( localizeWithPath(
+                                    'vs/platform/terminal/common/terminalPlatformConfiguration',
+                                    'terminalProfile.windowsExtensionTitle',
+                                    'The name of the extension terminal'
+                                )),
+                                type: 'string'
+                            },
+                            ...terminalProfileBaseProperties
+                        }
+                    },
+                    { type: 'null' },
+                    terminalProfileSchema
+                ]
+            }
+        },
+        ["terminal.integrated.profiles.osx" ]: {
+            restricted: true,
+            markdownDescription: createTerminalProfileMarkdownDescription(1 ),
+            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: ( localizeWithPath(
+                                    'vs/platform/terminal/common/terminalPlatformConfiguration',
+                                    'terminalProfile.osxExtensionIdentifier',
+                                    'The extension that contributed this profile.'
+                                )),
+                                type: 'string'
+                            },
+                            id: {
+                                description: ( localizeWithPath(
+                                    'vs/platform/terminal/common/terminalPlatformConfiguration',
+                                    'terminalProfile.osxExtensionId',
+                                    'The id of the extension terminal'
+                                )),
+                                type: 'string'
+                            },
+                            title: {
+                                description: ( localizeWithPath(
+                                    'vs/platform/terminal/common/terminalPlatformConfiguration',
+                                    'terminalProfile.osxExtensionTitle',
+                                    'The name of the extension terminal'
+                                )),
+                                type: 'string'
+                            },
+                            ...terminalProfileBaseProperties
+                        }
+                    },
+                    { type: 'null' },
+                    terminalProfileSchema
+                ]
+            }
+        },
+        ["terminal.integrated.profiles.linux" ]: {
+            restricted: true,
+            markdownDescription: createTerminalProfileMarkdownDescription(2 ),
+            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: ( localizeWithPath(
+                                    'vs/platform/terminal/common/terminalPlatformConfiguration',
+                                    'terminalProfile.linuxExtensionIdentifier',
+                                    'The extension that contributed this profile.'
+                                )),
+                                type: 'string'
+                            },
+                            id: {
+                                description: ( localizeWithPath(
+                                    'vs/platform/terminal/common/terminalPlatformConfiguration',
+                                    'terminalProfile.linuxExtensionId',
+                                    'The id of the extension terminal'
+                                )),
+                                type: 'string'
+                            },
+                            title: {
+                                description: ( localizeWithPath(
+                                    'vs/platform/terminal/common/terminalPlatformConfiguration',
+                                    'terminalProfile.linuxExtensionTitle',
+                                    'The name of the extension terminal'
+                                )),
+                                type: 'string'
+                            },
+                            ...terminalProfileBaseProperties
+                        }
+                    },
+                    { type: 'null' },
+                    terminalProfileSchema
+                ]
+            }
+        },
+        ["terminal.integrated.useWslProfiles" ]: {
+            description: ( localizeWithPath(
+                'vs/platform/terminal/common/terminalPlatformConfiguration',
+                'terminal.integrated.useWslProfiles',
+                'Controls whether or not WSL distros are shown in the terminal dropdown'
+            )),
+            type: 'boolean',
+            default: true
+        },
+        ["terminal.integrated.inheritEnv" ]: {
+            scope: 1 ,
+            description: ( localizeWithPath(
+                'vs/platform/terminal/common/terminalPlatformConfiguration',
+                '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" ]: {
+            scope: 1 ,
+            markdownDescription: ( localizeWithPath(
+                'vs/platform/terminal/common/terminalPlatformConfiguration',
+                '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" ]: {
+            scope: 1 ,
+            description: ( localizeWithPath(
+                'vs/platform/terminal/common/terminalPlatformConfiguration',
+                'terminal.integrated.showLinkHover',
+                "Whether to show hovers for links in the terminal output."
+            )),
+            type: 'boolean',
+            default: true
+        },
+        ["terminal.integrated.ignoreProcessNames" ]: {
+            markdownDescription: ( localizeWithPath(
+                'vs/platform/terminal/common/terminalPlatformConfiguration',
+                '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: [
+                'starship',
+                'oh-my-posh',
+                'bash',
+                'zsh',
+            ]
+        }
+    }
+};
+function registerTerminalPlatformConfiguration() {
+    ( Registry.as(Extensions.Configuration)).registerConfiguration(terminalPlatformConfiguration);
+    registerTerminalDefaultProfileConfiguration();
+}
+let defaultProfilesConfiguration;
+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: ( localizeWithPath(
+            'vs/platform/terminal/common/terminalPlatformConfiguration',
+            'terminalIntegratedConfigurationTitle',
+            "Integrated Terminal"
+        )),
+        type: 'object',
+        properties: {
+            ["terminal.integrated.defaultProfile.linux" ]: {
+                restricted: true,
+                markdownDescription: ( localizeWithPath(
+                    'vs/platform/terminal/common/terminalPlatformConfiguration',
+                    'terminal.integrated.defaultProfile.linux',
+                    "The default terminal profile on Linux."
+                )),
+                type: ['string', 'null'],
+                default: null,
+                enum: detectedProfiles?.os === 3  ? profileEnum?.values : undefined,
+                markdownEnumDescriptions: detectedProfiles?.os === 3  ? profileEnum?.markdownDescriptions : undefined
+            },
+            ["terminal.integrated.defaultProfile.osx" ]: {
+                restricted: true,
+                markdownDescription: ( localizeWithPath(
+                    'vs/platform/terminal/common/terminalPlatformConfiguration',
+                    'terminal.integrated.defaultProfile.osx',
+                    "The default terminal profile on macOS."
+                )),
+                type: ['string', 'null'],
+                default: null,
+                enum: detectedProfiles?.os === 2  ? profileEnum?.values : undefined,
+                markdownEnumDescriptions: detectedProfiles?.os === 2  ? profileEnum?.markdownDescriptions : undefined
+            },
+            ["terminal.integrated.defaultProfile.windows" ]: {
+                restricted: true,
+                markdownDescription: ( localizeWithPath(
+                    'vs/platform/terminal/common/terminalPlatformConfiguration',
+                    'terminal.integrated.defaultProfile.windows',
+                    "The default terminal profile on Windows."
+                )),
+                type: ['string', 'null'],
+                default: null,
+                enum: detectedProfiles?.os === 1  ? profileEnum?.values : undefined,
+                markdownEnumDescriptions: detectedProfiles?.os === 1  ? profileEnum?.markdownDescriptions : undefined
+            },
+        }
+    };
+    registry.updateConfigurations({ add: [defaultProfilesConfiguration], remove: oldDefaultProfilesConfiguration ? [oldDefaultProfilesConfiguration] : [] });
+}
+export { registerTerminalDefaultProfileConfiguration, registerTerminalPlatformConfiguration, terminalColorSchema, terminalIconSchema };

package/vscode/src/vs/platform/terminal/common/terminalProfiles.js

@@ -0,0 +1,111 @@
+import { Codicon } from '../../../base/common/codicons.js';
+import { URI } from '../../../base/common/uri.js';
+import { localizeWithPath } from '../../../nls.js';
+import { ThemeIcon } from '../../../base/common/themables.js';
+function createProfileSchemaEnums(detectedProfiles, extensionProfiles) {
+    const result = [{
+            name: null,
+            description: ( localizeWithPath(
+                'vs/platform/terminal/common/terminalProfiles',
+                'terminalAutomaticProfile',
+                'Automatically detect the default'
+            ))
+        }];
+    result.push(...( detectedProfiles.map(e => {
+        return {
+            name: e.profileName,
+            description: createProfileDescription(e)
+        };
+    })));
+    if (extensionProfiles) {
+        result.push(...( extensionProfiles.map(extensionProfile => {
+            return {
+                name: extensionProfile.title,
+                description: createExtensionProfileDescription(extensionProfile)
+            };
+        })));
+    }
+    return {
+        values: ( result.map(e => e.name)),
+        markdownDescriptions: ( result.map(e => e.description))
+    };
+}
+function createProfileDescription(profile) {
+    let description = `$(${ThemeIcon.isThemeIcon(profile.icon) ? profile.icon.id : profile.icon ? profile.icon : Codicon.terminal.id}) ${profile.profileName}\n- path: ${profile.path}`;
+    if (profile.args) {
+        if (typeof profile.args === 'string') {
+            description += `\n- args: "${profile.args}"`;
+        }
+        else {
+            description += `\n- args: [${profile.args.length === 0 ? '' : `'${profile.args.join(`','`)}'`}]`;
+        }
+    }
+    if (profile.overrideName !== undefined) {
+        description += `\n- overrideName: ${profile.overrideName}`;
+    }
+    if (profile.color) {
+        description += `\n- color: ${profile.color}`;
+    }
+    if (profile.env) {
+        description += `\n- env: ${JSON.stringify(profile.env)}`;
+    }
+    return description;
+}
+function createExtensionProfileDescription(profile) {
+    const description = `$(${ThemeIcon.isThemeIcon(profile.icon) ? profile.icon.id : profile.icon ? profile.icon : Codicon.terminal.id}) ${profile.title}\n- extensionIdentifier: ${profile.extensionIdentifier}`;
+    return description;
+}
+function terminalProfileArgsMatch(args1, args2) {
+    if (!args1 && !args2) {
+        return true;
+    }
+    else if (typeof args1 === 'string' && typeof args2 === 'string') {
+        return args1 === args2;
+    }
+    else if (Array.isArray(args1) && Array.isArray(args2)) {
+        if (args1.length !== args2.length) {
+            return false;
+        }
+        for (let i = 0; i < args1.length; i++) {
+            if (args1[i] !== args2[i]) {
+                return false;
+            }
+        }
+        return true;
+    }
+    return false;
+}
+function terminalIconsEqual(a, b) {
+    if (!a && !b) {
+        return true;
+    }
+    else if (!a || !b) {
+        return false;
+    }
+    if (ThemeIcon.isThemeIcon(a) && ThemeIcon.isThemeIcon(b)) {
+        return a.id === b.id && a.color === b.color;
+    }
+    if (typeof a === 'object' && 'light' in a && 'dark' in a
+        && typeof b === 'object' && 'light' in b && 'dark' in b) {
+        const castedA = a;
+        const castedB = b;
+        if ((URI.isUri(castedA.light) || isUriComponents(castedA.light)) && (URI.isUri(castedA.dark) || isUriComponents(castedA.dark))
+            && (URI.isUri(castedB.light) || isUriComponents(castedB.light)) && (URI.isUri(castedB.dark) || isUriComponents(castedB.dark))) {
+            return castedA.light.path === castedB.light.path && castedA.dark.path === castedB.dark.path;
+        }
+    }
+    if ((URI.isUri(a) && URI.isUri(b)) || (isUriComponents(a) || isUriComponents(b))) {
+        const castedA = a;
+        const castedB = b;
+        return castedA.path === castedB.path && castedA.scheme === castedB.scheme;
+    }
+    return false;
+}
+function isUriComponents(thing) {
+    if (!thing) {
+        return false;
+    }
+    return typeof thing.path === 'string' &&
+        typeof thing.scheme === 'string';
+}
+export { createProfileSchemaEnums, isUriComponents, terminalIconsEqual, terminalProfileArgsMatch };