Add ev3devBrowser.interactiveTerminal.env setting

This adds a new setting for passing additional environment variables to programs run using the debugger's interactiveTerminal option. This is useful for things like PYTHONINSPECT where it only makes sense to set it when there is a terminal.

Author: dlech

README.md

@@ -90,6 +90,9 @@ This extension contributes the following settings:
 *   `ev3devBrowser.env`: If you need to set environment variables for running
     remote programs, you can set them here. Each variable is defined as a
     key/value pair.
+*   `ev3devBrowser.interactiveTerminal.env`: This is similar to `ev3devBrowser.env`
+    but the environment variables are only applied when running a program in
+    the interactive terminal.
 *   `ev3devBrowser.download.include`: Use this to specify which files to
     included when downloading files to the remote device. Can use glob patterns.
 *   `ev3devBrowser.download.exclude`: Use this to specify which files to

package.json

@@ -52,6 +52,22 @@
                     "description": "Addition environment variables to use on remote devices.",
                     "uniqueItems": true
                 },
+                "ev3devBrowser.interactiveTerminal.env": {
+                    "scope": "window",
+                    "type": "object",
+                    "patternProperties": {
+                        "[A-Za-z0-9_]{1,}": {
+                            "type": "string"
+                        }
+                    },
+                    "additionalProperties": false,
+                    "default": {
+                        "PYTHONINSPECT": "TRUE",
+                        "MICROPYINSPECT": "TRUE"
+                    },
+                    "description": "Addition environment variables to use on remote devices only when using the interactive terminal that is started by the debugger.",
+                    "uniqueItems": true
+                },
                 "ev3devBrowser.download.include": {
                     "scope": "resource",
                     "type": "string",

src/device.ts

@@ -223,10 +223,10 @@ export class Device extends vscode.Disposable {
      * Executes a command on the remote device.
      * @param command The absolute path of the command.
      */
-    public exec(command: string, pty?: ssh2.PseudoTtyOptions): Promise<ssh2.ClientChannel> {
+    public exec(command: string, env?: any, pty?: ssh2.PseudoTtyOptions): Promise<ssh2.ClientChannel> {
         return new Promise((resolve, reject) => {
             const options = {
-                env: vscode.workspace.getConfiguration('ev3devBrowser').get('env'),
+                env: env,
                 pty: pty,
             };
             this.client.exec(command, options, (err, channel) => {

src/extension.ts

@@ -148,7 +148,11 @@ async function handleCustomDebugEvent(event: vscode.DebugSessionCustomEvent): Pr
                 if (args.interactiveTerminal) {
                     const config = vscode.workspace.getConfiguration(`terminal.integrated.env.${getPlatform()}`);
                     const termEnv = config.get<string>('TERM');
-                    const ch = await device.exec(command, { term: termEnv || process.env['TERM'] || 'xterm-256color' });
+                    const env = {
+                        ...vscode.workspace.getConfiguration('ev3devBrowser').get<object>('env'),
+                        ...vscode.workspace.getConfiguration('ev3devBrowser').get<object>('interactiveTerminal.env'),
+                    };
+                    const ch = await device.exec(command, env, { term: termEnv || process.env['TERM'] || 'xterm-256color' });
                     const writeEmitter = new vscode.EventEmitter<string>();
                     ch.stdout.on('data', (data: string | Buffer) => writeEmitter.fire(String(data)));
                     ch.stderr.on('data', (data: string | Buffer) => writeEmitter.fire(String(data)));
@@ -212,7 +216,8 @@ async function handleCustomDebugEvent(event: vscode.DebugSessionCustomEvent): Pr
                     output.show(true);
                     output.clear();
                     output.appendLine(`Starting: ${command}`);
-                    const channel = await device.exec(command);
+                    const env = vscode.workspace.getConfiguration('ev3devBrowser').get('env');
+                    const channel = await device.exec(command, env);
                     channel.on('close', () => {
                         if (debugRestarting) {
                             activeDebugSessions.add(event.session.id);