add shouldProceedAfterPyprojectValidation

Author: StellaHuang95

src/common/localize.ts

@@ -64,6 +64,16 @@ export namespace Pickers {
         export const selectProject = l10n.t('Select a project, folder or script');
         export const selectProjects = l10n.t('Select one or more projects, folders or scripts');
     }
+
+    export namespace pyProject {
+        export const validationError = l10n.t('Invalid pyproject.toml');
+        export const validationErrorAction = l10n.t(
+            'The pyproject.toml file has formatting errors. What would you like to do?',
+        );
+        export const openFile = l10n.t('Open pyproject.toml');
+        export const continueAnyway = l10n.t('Continue Anyway');
+        export const cancel = l10n.t('Cancel');
+    }
 }
 
 export namespace ProjectViews {

src/managers/builtin/pipUtils.ts

@@ -1,7 +1,7 @@
 import * as tomljs from '@iarna/toml';
 import * as fse from 'fs-extra';
 import * as path from 'path';
-import { l10n, LogOutputChannel, ProgressLocation, QuickInputButtons, QuickPickItem, Uri } from 'vscode';
+import { l10n, LogOutputChannel, ProgressLocation, QuickInputButtons, QuickPickItem, Uri, window } from 'vscode';
 import { PackageManagementOptions, PythonEnvironment, PythonEnvironmentApi, PythonProject } from '../../api';
 import { EXTENSION_ROOT_DIR } from '../../common/constants';
 import { PackageManagement, Pickers, VenvManagerStrings } from '../../common/localize';
@@ -160,11 +160,12 @@ async function getCommonPackages(): Promise<Installable[]> {
 }
 
 async function selectWorkspaceOrCommon(
-    installable: Installable[],
+    installableResult: ProjectInstallableResult,
     common: Installable[],
     showSkipOption: boolean,
     installed: string[],
 ): Promise<PipPackages | undefined> {
+    const installable = installableResult.installables;
     if (installable.length === 0 && common.length === 0) {
         return undefined;
     }
@@ -206,7 +207,20 @@ async function selectWorkspaceOrCommon(
     if (selected && !Array.isArray(selected)) {
         try {
             if (selected.label === PackageManagement.workspaceDependencies) {
-                return await selectFromInstallableToInstall(installable, undefined, { showBackButton });
+                const selectedInstallables = await selectFromInstallableToInstall(installable, undefined, {
+                    showBackButton,
+                });
+
+                const validationError = installableResult.validationError;
+                const shouldProceed = await shouldProceedAfterPyprojectValidation(
+                    validationError,
+                    selectedInstallables?.install ?? [],
+                );
+                if (!shouldProceed) {
+                    return undefined;
+                }
+
+                return selectedInstallables;
             } else if (selected.label === PackageManagement.searchCommonPackages) {
                 return await selectFromCommonPackagesToInstall(common, installed, undefined, { showBackButton });
             } else if (selected.label === PackageManagement.skipPackageInstallation) {
@@ -218,7 +232,7 @@ async function selectWorkspaceOrCommon(
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
         } catch (ex: any) {
             if (ex === QuickInputButtons.Back) {
-                return selectWorkspaceOrCommon(installable, common, showSkipOption, installed);
+                return selectWorkspaceOrCommon(installableResult, common, showSkipOption, installed);
             }
         }
     }
@@ -239,17 +253,19 @@ export interface ProjectInstallableResult {
     /**
      * Validation error information if pyproject.toml validation failed
      */
-    validationError?: {
-        /**
-         * Human-readable error message describing the validation issue
-         */
-        message: string;
-
-        /**
-         * URI to the pyproject.toml file that has the validation error
-         */
-        fileUri: Uri;
-    };
+    validationError?: ValidationError;
+}
+
+export interface ValidationError {
+    /**
+     * Human-readable error message describing the validation issue
+     */
+    message: string;
+
+    /**
+     * URI to the pyproject.toml file that has the validation error
+     */
+    fileUri: Uri;
 }
 
 export async function getWorkspacePackagesToInstall(
@@ -259,15 +275,14 @@ export async function getWorkspacePackagesToInstall(
     environment?: PythonEnvironment,
     log?: LogOutputChannel,
 ): Promise<PipPackages | undefined> {
-    const result = await getProjectInstallable(api, project);
-    const installable = result.installables;
+    const installableResult = await getProjectInstallable(api, project);
     let common = await getCommonPackages();
     let installed: string[] | undefined;
     if (environment) {
         installed = (await refreshPipPackages(environment, log, { showProgress: true }))?.map((pkg) => pkg.name);
         common = mergePackages(common, installed ?? []);
     }
-    return selectWorkspaceOrCommon(installable, common, !!options.showSkipOption, installed ?? []);
+    return selectWorkspaceOrCommon(installableResult, common, !!options.showSkipOption, installed ?? []);
 }
 
 export async function getProjectInstallable(
@@ -345,6 +360,45 @@ export async function getProjectInstallable(
     };
 }
 
+export async function shouldProceedAfterPyprojectValidation(
+    validationError: ValidationError | undefined,
+    install: string[],
+): Promise<boolean> {
+    // 1. If no validation error or no installables selected, proceed
+    if (!validationError || install.length === 0) {
+        return true;
+    }
+
+    const selectedTomlInstallables = install.some((arg, index, arr) => arg === '-e' && index + 1 < arr.length);
+    if (!selectedTomlInstallables) {
+        // 2. If no toml installables selected, proceed
+        return true;
+    }
+
+    // 3. Otherwise, show error message and ask user what to do
+    const openButton = { title: Pickers.pyProject.openFile };
+    const continueButton = { title: Pickers.pyProject.continueAnyway };
+    const cancelButton = { title: Pickers.pyProject.cancel, isCloseAffordance: true };
+
+    const selection = await window.showErrorMessage(
+        validationError.message,
+        { modal: true },
+        openButton,
+        continueButton,
+        cancelButton,
+    );
+
+    if (selection === continueButton) {
+        return true;
+    }
+
+    if (selection === openButton) {
+        await window.showTextDocument(validationError.fileUri);
+    }
+
+    return false;
+}
+
 export function isPipInstallCommand(command: string): boolean {
     // Regex to match pip install commands, capturing variations like:
     // pip install package

src/managers/builtin/venvStepBasedFlow.ts

@@ -7,7 +7,12 @@ import { EventNames } from '../../common/telemetry/constants';
 import { sendTelemetryEvent } from '../../common/telemetry/sender';
 import { showInputBoxWithButtons, showQuickPickWithButtons } from '../../common/window.apis';
 import { NativePythonFinder } from '../common/nativePythonFinder';
-import { getProjectInstallable, getWorkspacePackagesToInstall, PipPackages } from './pipUtils';
+import {
+    getProjectInstallable,
+    getWorkspacePackagesToInstall,
+    PipPackages,
+    shouldProceedAfterPyprojectValidation,
+} from './pipUtils';
 import { CreateEnvironmentResult, createWithProgress, ensureGlobalEnv } from './venvUtils';
 
 /**
@@ -342,6 +347,13 @@ export async function createStepBasedVenvFlow(
             if (options.additionalPackages) {
                 allPackages.push(...options.additionalPackages);
             }
+
+            const validationError = result.validationError;
+            const shouldProceed = await shouldProceedAfterPyprojectValidation(validationError, allPackages);
+            if (!shouldProceed) {
+                return undefined;
+            }
+
             return await createWithProgress(nativeFinder, api, log, manager, state.basePython, venvRoot, quickEnvPath, {
                 install: allPackages,
                 uninstall: [],

src/managers/builtin/venvUtils.ts

@@ -26,7 +26,7 @@ import {
 } from '../common/nativePythonFinder';
 import { getShellActivationCommands, shortVersion, sortEnvironments } from '../common/utils';
 import { runPython, runUV, shouldUseUv } from './helpers';
-import { getProjectInstallable, PipPackages } from './pipUtils';
+import { getProjectInstallable, PipPackages, shouldProceedAfterPyprojectValidation } from './pipUtils';
 import { resolveSystemPythonEnvironmentPath } from './utils';
 import { addUvEnvironment, removeUvEnvironment, UV_ENVS_KEY } from './uvEnvironments';
 import { createStepBasedVenvFlow } from './venvStepBasedFlow';
@@ -404,6 +404,12 @@ export async function quickCreateVenv(
         allPackages.push(...additionalPackages);
     }
 
+    const validationError = result.validationError;
+    const shouldProceed = await shouldProceedAfterPyprojectValidation(validationError, allPackages);
+    if (!shouldProceed) {
+        return undefined;
+    }
+
     // Check if .venv already exists
     let venvPath = path.join(venvRoot.fsPath, '.venv');
     if (await fsapi.pathExists(venvPath)) {