Show requirement files

Author: karthiknadig

src/client/common/utils/localize.ts

@@ -475,6 +475,7 @@ export namespace CreateEnv {
         );
         export const deletingEnvironmentProgress = l10n.t('Deleting existing ".venv" environment...');
         export const errorDeletingEnvironment = l10n.t('Error while deleting existing ".venv" environment.');
+        export const openRequirementsFile = l10n.t('Open requirements file');
     }
 
     export namespace Conda {

src/client/common/vscodeApis/windowApis.ts

@@ -16,9 +16,15 @@ import {
     TextEditor,
     window,
     Disposable,
+    QuickPickItemButtonEvent,
+    Uri,
 } from 'vscode';
 import { createDeferred, Deferred } from '../utils/async';
 
+export function showTextDocument(uri: Uri): Thenable<TextEditor> {
+    return window.showTextDocument(uri);
+}
+
 export function showQuickPick<T extends QuickPickItem>(
     items: readonly T[] | Thenable<readonly T[]>,
     options?: QuickPickOptions,
@@ -91,6 +97,7 @@ export async function showQuickPickWithBack<T extends QuickPickItem>(
     items: readonly T[],
     options?: QuickPickOptions,
     token?: CancellationToken,
+    itemButtonHandler?: (e: QuickPickItemButtonEvent<T>) => void,
 ): Promise<T | T[] | undefined> {
     const quickPick: QuickPick<T> = window.createQuickPick<T>();
     const disposables: Disposable[] = [quickPick];
@@ -130,6 +137,11 @@ export async function showQuickPickWithBack<T extends QuickPickItem>(
                 deferred.resolve(undefined);
             }
         }),
+        quickPick.onDidTriggerItemButton((e) => {
+            if (itemButtonHandler) {
+                itemButtonHandler(e);
+            }
+        }),
     );
     if (token) {
         disposables.push(

src/client/pythonEnvironments/creation/provider/venvUtils.ts

@@ -5,12 +5,22 @@ import * as tomljs from '@iarna/toml';
 import * as fs from 'fs-extra';
 import { flatten, isArray } from 'lodash';
 import * as path from 'path';
-import { CancellationToken, ProgressLocation, QuickPickItem, RelativePattern, WorkspaceFolder } from 'vscode';
+import {
+    CancellationToken,
+    ProgressLocation,
+    QuickPickItem,
+    QuickPickItemButtonEvent,
+    RelativePattern,
+    ThemeIcon,
+    Uri,
+    WorkspaceFolder,
+} from 'vscode';
 import { Common, CreateEnv } from '../../../common/utils/localize';
 import {
     MultiStepAction,
     MultiStepNode,
     showQuickPickWithBack,
+    showTextDocument,
     withProgress,
 } from '../../../common/vscodeApis/windowApis';
 import { findFiles } from '../../../common/vscodeApis/workspaceApis';
@@ -78,8 +88,13 @@ async function pickTomlExtras(extras: string[], token?: CancellationToken): Prom
     return undefined;
 }
 
-async function pickRequirementsFiles(files: string[], token?: CancellationToken): Promise<string[] | undefined> {
+async function pickRequirementsFiles(
+    files: string[],
+    root: string,
+    token?: CancellationToken,
+): Promise<string[] | undefined> {
     const items: QuickPickItem[] = files
+        .map((p) => path.relative(root, p))
         .sort((a, b) => {
             const al: number = a.split(/[\\\/]/).length;
             const bl: number = b.split(/[\\\/]/).length;
@@ -91,7 +106,15 @@ async function pickRequirementsFiles(files: string[], token?: CancellationToken)
             }
             return al - bl;
         })
-        .map((e) => ({ label: e }));
+        .map((e) => ({
+            label: e,
+            buttons: [
+                {
+                    iconPath: new ThemeIcon('go-to-file'),
+                    tooltip: CreateEnv.Venv.openRequirementsFile,
+                },
+            ],
+        }));
 
     const selection = await showQuickPickWithBack(
         items,
@@ -101,6 +124,11 @@ async function pickRequirementsFiles(files: string[], token?: CancellationToken)
             canPickMany: true,
         },
         token,
+        async (e: QuickPickItemButtonEvent<QuickPickItem>) => {
+            if (e.item.label) {
+                await showTextDocument(Uri.file(path.join(root, e.item.label)));
+            }
+        },
     );
 
     if (selection && isArray(selection)) {
@@ -195,14 +223,11 @@ export async function pickPackagesToInstall(
         tomlStep,
         async (context?: MultiStepAction) => {
             traceVerbose('Looking for pip requirements.');
-            const requirementFiles = (await getPipRequirementsFiles(workspaceFolder, token))?.map((p) =>
-                path.relative(workspaceFolder.uri.fsPath, p),
-            );
-
+            const requirementFiles = await getPipRequirementsFiles(workspaceFolder, token);
             if (requirementFiles && requirementFiles.length > 0) {
                 traceVerbose('Found pip requirements.');
                 try {
-                    const result = await pickRequirementsFiles(requirementFiles, token);
+                    const result = await pickRequirementsFiles(requirementFiles, workspaceFolder.uri.fsPath, token);
                     const installList = result?.map((p) => path.join(workspaceFolder.uri.fsPath, p));
                     if (installList) {
                         installList.forEach((i) => {