Add startup activation (#196)

Fixes #201
Fixes #200
Fixes #227
Fixes #231

Author: karthiknadig

.vscode/launch.json

@@ -11,7 +11,7 @@
             "request": "launch",
             "args": ["--extensionDevelopmentPath=${workspaceFolder}"],
             "outFiles": ["${workspaceFolder}/dist/**/*.js"],
-            "preLaunchTask": "${defaultBuildTask}"
+            "preLaunchTask": "npm: watch"
         },
         {
             "name": "Unit Tests",
@@ -30,7 +30,7 @@
             "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
             "skipFiles": ["<node_internals>/**"],
             "outFiles": ["${workspaceFolder}/out/**/*.js", "!${workspaceFolder}/**/node_modules**/*"],
-            "preLaunchTask": "tasks: watch-tests"
+            "preLaunchTask": "npm: watch-tests"
         },
         {
             "name": "Extension Tests",
@@ -41,7 +41,7 @@
                 "--extensionTestsPath=${workspaceFolder}/out/test/"
             ],
             "outFiles": ["${workspaceFolder}/out/**/*.js", "${workspaceFolder}/dist/**/*.js"],
-            "preLaunchTask": "tasks: watch-tests"
+            "preLaunchTask": "${defaultBuildTask}"
         }
     ]
 }

.vscode/settings.json

@@ -12,11 +12,17 @@
     "typescript.tsc.autoDetect": "off",
     "editor.formatOnSave": true,
     "[typescript]": {
-        "editor.defaultFormatter": "esbenp.prettier-vscode"
+        "editor.defaultFormatter": "esbenp.prettier-vscode",
+        "editor.codeActionsOnSave": {
+            "source.organizeImports": "explicit"
+        }
     },
     "[python]": {
         "editor.defaultFormatter": "charliermarsh.ruff",
-        "diffEditor.ignoreTrimWhitespace": false
+        "diffEditor.ignoreTrimWhitespace": false,
+        "editor.codeActionsOnSave": {
+            "source.organizeImports": "explicit"
+        }
     },
     "prettier.tabWidth": 4,
     "python-envs.defaultEnvManager": "ms-python.python:venv",

.vscode/tasks.json

@@ -25,13 +25,16 @@
             "presentation": {
                 "reveal": "never",
                 "group": "watchers"
-            },
-            "group": "build"
+            }
         },
         {
-            "label": "tasks: watch-tests",
+            "label": "tasks: build",
             "dependsOn": ["npm: watch", "npm: watch-tests"],
-            "problemMatcher": []
+            "problemMatcher": [],
+            "presentation": {
+                "reveal": "never",
+                "group": "watchers"
+            }
         },
         {
             "type": "npm",

package.json

@@ -86,6 +86,22 @@
                         "onExP",
                         "preview"
                     ]
+                },
+                "python-envs.terminal.autoActivationType": {
+                    "type": "string",
+                    "markdownDescription": "%python-envs.terminal.autoActivationType.description%",
+                    "default": "command",
+                    "enum": [
+                        "command",
+                        "shellStartup",
+                        "off"
+                    ],
+                    "markdownEnumDescriptions": [
+                        "%python-envs.terminal.autoActivationType.command%",
+                        "%python-envs.terminal.autoActivationType.shellStartup%",
+                        "%python-envs.terminal.autoActivationType.off%"
+                    ],
+                    "scope": "machine"
                 }
             }
         },
@@ -228,6 +244,12 @@
                 "title": "%python-envs.copyProjectPath.title%",
                 "category": "Python Envs",
                 "icon": "$(copy)"
+            },
+            {
+                "command": "python-envs.terminal.revertStartupScriptChanges",
+                "title": "%python-envs.terminal.revertStartupScriptChanges.title%",
+                "category": "Python Envs",
+                "icon": "$(discard)"
             }
         ],
         "menus": {

package.nls.json

@@ -6,6 +6,11 @@
     "python-envs.pythonProjects.envManager.description": "The environment manager for creating and managing environments for this project.",
     "python-envs.pythonProjects.packageManager.description": "The package manager for managing packages in environments for this project.",
     "python-envs.terminal.showActivateButton.description": "Whether to show the 'Activate' button in the terminal menu",
+    "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.shellStartup": "Activation by modifying the terminal shell startup script. To use this feature we will need to modify your shell startup scripts.",
+    "python-envs.terminal.autoActivationType.off": "No automatic activation of environments.",
+    "python-envs.terminal.revertStartupScriptChanges.title": "Revert Shell Startup Script Changes",
     "python-envs.setEnvManager.title": "Set Environment Manager",
     "python-envs.setPkgManager.title": "Set Package Manager",
     "python-envs.addPythonProject.title": "Add Python Project",

src/common/command.api.ts

@@ -1,5 +1,10 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { commands } from 'vscode';
+import { Disposable } from 'vscode-jsonrpc';
+
+export function registerCommand(command: string, callback: (...args: any[]) => any, thisArg?: any): Disposable {
+    return commands.registerCommand(command, callback, thisArg);
+}
 
 export function executeCommand<T = unknown>(command: string, ...rest: any[]): Thenable<T> {
     return commands.executeCommand(command, ...rest);

src/common/commands.ts

@@ -0,0 +1,3 @@
+export namespace Commands {
+    export const viewLogs = 'python-envs.viewLogs';
+}

src/common/errors/utils.ts

@@ -1,6 +1,7 @@
 import * as stackTrace from 'stack-trace';
-import { commands, LogOutputChannel, window } from 'vscode';
+import { commands, LogOutputChannel } from 'vscode';
 import { Common } from '../localize';
+import { showErrorMessage, showWarningMessage } from '../window.apis';
 
 export function parseStack(ex: Error) {
     if (ex.stack && Array.isArray(ex.stack)) {
@@ -10,8 +11,8 @@ export function parseStack(ex: Error) {
     return stackTrace.parse.call(stackTrace, ex);
 }
 
-export async function showErrorMessage(message: string, log?: LogOutputChannel) {
-    const result = await window.showErrorMessage(message, Common.viewLogs);
+export async function showErrorMessageWithLogs(message: string, log?: LogOutputChannel) {
+    const result = await showErrorMessage(message, Common.viewLogs);
     if (result === Common.viewLogs) {
         if (log) {
             log.show();
@@ -21,8 +22,8 @@ export async function showErrorMessage(message: string, log?: LogOutputChannel)
     }
 }
 
-export async function showWarningMessage(message: string, log?: LogOutputChannel) {
-    const result = await window.showWarningMessage(message, Common.viewLogs);
+export async function showWarningMessageWithLogs(message: string, log?: LogOutputChannel) {
+    const result = await showWarningMessage(message, Common.viewLogs);
     if (result === Common.viewLogs) {
         if (log) {
             log.show();

src/common/localize.ts

@@ -1,4 +1,5 @@
 import { l10n } from 'vscode';
+import { Commands } from './commands';
 
 export namespace Common {
     export const recommended = l10n.t('Recommended');
@@ -11,7 +12,9 @@ export namespace Common {
     export const viewLogs = l10n.t('View Logs');
     export const yes = l10n.t('Yes');
     export const no = l10n.t('No');
+    export const ok = l10n.t('Ok');
     export const quickCreate = l10n.t('Quick Create');
+    export const installPython = l10n.t('Install Python');
 }
 
 export namespace Interpreter {
@@ -138,6 +141,11 @@ export namespace CondaStrings {
 
     export const quickCreateCondaNoEnvRoot = l10n.t('No conda environment root found');
     export const quickCreateCondaNoName = l10n.t('Could not generate a name for env');
+
+    export const condaMissingPython = l10n.t('No Python found in the selected conda environment');
+    export const condaMissingPythonNoFix = l10n.t(
+        'No Python found in the selected conda environment. Please select another environment or install Python manually.',
+    );
 }
 
 export namespace ProjectCreatorString {
@@ -156,3 +164,11 @@ export namespace EnvViewStrings {
     export const selectedGlobalTooltip = l10n.t('This environment is selected for non-workspace files');
     export const selectedWorkspaceTooltip = l10n.t('This environment is selected for workspace files');
 }
+
+export namespace ShellStartupActivationStrings {
+    export const envCollectionDescription = l10n.t('Environment variables for shell activation');
+    export const revertedShellStartupScripts = l10n.t(
+        'Removed shell startup profile code for Python environment activation. See [logs](command:{0})',
+        Commands.viewLogs,
+    );
+}

src/common/pickers/environments.ts

@@ -3,10 +3,10 @@ import { IconPath, PythonEnvironment, PythonProject } from '../../api';
 import { InternalEnvironmentManager } from '../../internal.api';
 import { Common, Interpreter, Pickers } from '../localize';
 import { showQuickPickWithButtons, showQuickPick, showOpenDialog, withProgress } from '../window.apis';
-import { isWindows } from '../../managers/common/utils';
 import { traceError } from '../logging';
 import { pickEnvironmentManager } from './managers';
 import { handlePythonPath } from '../utils/pythonPath';
+import { isWindows } from '../utils/platformUtils';
 
 type QuickPickIcon =
     | Uri