vscode/src/vscode-dts/vscode.proposed.terminalShellEnv.d.ts

/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

declare module 'vscode' {
	// @anthonykim1 @tyriar https://github.com/microsoft/vscode/issues/227467

	export interface TerminalShellIntegrationEnvironment {
		/**
		 * The dictionary of environment variables.
		 */
		value: { [key: string]: string | undefined };

		/**
		 * Whether the environment came from a trusted source and is therefore safe to use its
		 * values in a manner that could lead to execution of arbitrary code. If this value is
		 * `false`, {@link value} should either not be used for something that could lead to arbitrary
		 * code execution, or the user should be warned beforehand.
		 *
		 * This is `true` only when the environment was reported explicitly and it used a nonce for
		 * verification.
		 */
		isTrusted: boolean;
	}

	export interface TerminalShellIntegration {
		/**
		 * The environment of the shell process. This is undefined if the shell integration script
		 * does not send the environment.
		 */
		readonly env: TerminalShellIntegrationEnvironment | undefined;
	}

	// TODO: Is it fine that this shares onDidChangeTerminalShellIntegration with cwd and the shellIntegration object itself?
}