feat: use the autoActivationType setting in terminal manager

Author: karthiknadig

package.json

@@ -94,12 +94,12 @@
                     "enum": [
                         "command",
                         "startup",
-                        "none"
+                        "off"
                     ],
                     "enumDescriptions": [
                         "%python-envs.terminal.autoActivationType.command%",
                         "%python-envs.terminal.autoActivationType.startup%",
-                        "%python-envs.terminal.autoActivationType.none%"
+                        "%python-envs.terminal.autoActivationType.off%"
                     ],
                     "scope": "machine"
                 }

package.nls.json

@@ -9,7 +9,7 @@
     "python-envs.terminal.autoActivationType.description": "The type of activation to use when activating an environment in the terminal",
     "python-envs.terminal.autoActivationType.command": "Activation by executing a command in the terminal.",
     "python-envs.terminal.autoActivationType.startup": "Activation by modifying the terminal shell startup script.",
-    "python-envs.terminal.autoActivationType.none": "No automatic activation of environments.",
+    "python-envs.terminal.autoActivationType.off": "No automatic activation of environments.",
     "python-envs.setEnvManager.title": "Set Environment Manager",
     "python-envs.setPkgManager.title": "Set Package Manager",
     "python-envs.addPythonProject.title": "Add Python Project",

src/features/terminal/terminalManager.ts

@@ -11,14 +11,15 @@ import {
 import { PythonEnvironment, PythonEnvironmentApi, PythonProject, PythonTerminalCreateOptions } from '../../api';
 import { isActivatableEnvironment } from '../common/activation';
 import { getConfiguration } from '../../common/workspace.apis';
-import { getEnvironmentForTerminal, waitForShellIntegration } from './utils';
+import { getAutoActivationType, getEnvironmentForTerminal, waitForShellIntegration } from './utils';
 import {
     DidChangeTerminalActivationStateEvent,
     TerminalActivation,
     TerminalActivationInternal,
     TerminalEnvironment,
 } from './terminalActivationState';
 import { getPythonApi } from '../pythonApi';
+import { traceInfo, traceVerbose } from '../../common/logging';
 
 export interface TerminalCreation {
     create(environment: PythonEnvironment, options: PythonTerminalCreateOptions): Promise<Terminal>;
@@ -97,26 +98,33 @@ export class TerminalManagerImpl implements TerminalManager {
     }
 
     private async autoActivateOnTerminalOpen(terminal: Terminal, environment: PythonEnvironment): Promise<void> {
-        const config = getConfiguration('python');
-        if (!config.get<boolean>('terminal.activateEnvironment', false)) {
-            return;
-        }
-
-        if (isActivatableEnvironment(environment)) {
-            await withProgress(
-                {
-                    location: ProgressLocation.Window,
-                    title: `Activating environment: ${environment.environmentPath.fsPath}`,
-                },
-                async () => {
-                    await waitForShellIntegration(terminal);
-                    await this.activate(terminal, environment);
-                },
+        const actType = getAutoActivationType();
+        if (actType === 'command') {
+            if (isActivatableEnvironment(environment)) {
+                await withProgress(
+                    {
+                        location: ProgressLocation.Window,
+                        title: `Activating environment: ${environment.environmentPath.fsPath}`,
+                    },
+                    async () => {
+                        await waitForShellIntegration(terminal);
+                        await this.activate(terminal, environment);
+                    },
+                );
+            } else {
+                traceVerbose(`Environment ${environment.environmentPath.fsPath} is not activatable`);
+            }
+        } else if (actType === 'off') {
+            traceInfo(`"python-envs.terminal.autoActivationType" is set to "${actType}", skipping auto activation`);
+        } else if (actType === 'startup') {
+            traceInfo(
+                `"python-envs.terminal.autoActivationType" is set to "${actType}", terminal should be activated by shell startup script`,
             );
         }
     }
 
     public async create(environment: PythonEnvironment, options: PythonTerminalCreateOptions): Promise<Terminal> {
+        // https://github.com/microsoft/vscode-python-environments/issues/172
         // const name = options.name ?? `Python: ${environment.displayName}`;
         const newTerminal = createTerminal({
             name: options.name,
@@ -214,8 +222,7 @@ export class TerminalManagerImpl implements TerminalManager {
     }
 
     public async initialize(api: PythonEnvironmentApi): Promise<void> {
-        const config = getConfiguration('python');
-        if (config.get<boolean>('terminal.activateEnvInCurrentTerminal', false)) {
+        if (getAutoActivationType() === 'command') {
             await Promise.all(
                 terminals().map(async (t) => {
                     this.skipActivationOnOpen.add(t);

src/features/terminal/utils.ts

@@ -2,7 +2,7 @@ import * as path from 'path';
 import { Terminal, TerminalOptions, Uri } from 'vscode';
 import { sleep } from '../../common/utils/asyncUtils';
 import { PythonEnvironment, PythonProject, PythonProjectEnvironmentApi, PythonProjectGetterApi } from '../../api';
-import { getWorkspaceFolders } from '../../common/workspace.apis';
+import { getConfiguration, getWorkspaceFolders } from '../../common/workspace.apis';
 
 const SHELL_INTEGRATION_TIMEOUT = 500; // 0.5 seconds
 const SHELL_INTEGRATION_POLL_INTERVAL = 20; // 0.02 seconds
@@ -89,3 +89,11 @@ export async function getEnvironmentForTerminal(
 
     return env;
 }
+
+export function getAutoActivationType(): 'off' | 'command' | 'startup' {
+    // 'startup' auto-activation means terminal is activated via shell startup scripts.
+    // 'command' auto-activation means terminal is activated via a command.
+    // 'off' means no auto-activation.
+    const config = getConfiguration('python-envs');
+    return config.get<'off' | 'command' | 'startup'>('terminal.autoActivationType', 'command');
+}