Remove isort extension dependency (#20577)

Closes #20586

Author: karthiknadig

gulpfile.js

@@ -82,7 +82,7 @@ async function addExtensionPackDependencies() {
     // extension dependencies need not be installed during development
     const packageJsonContents = await fsExtra.readFile('package.json', 'utf-8');
     const packageJson = JSON.parse(packageJsonContents);
-    packageJson.extensionPack = ['ms-toolsai.jupyter', 'ms-python.vscode-pylance', 'ms-python.isort'].concat(
+    packageJson.extensionPack = ['ms-toolsai.jupyter', 'ms-python.vscode-pylance'].concat(
         packageJson.extensionPack ? packageJson.extensionPack : [],
     );
     await fsExtra.writeFile('package.json', JSON.stringify(packageJson, null, 4), 'utf-8');

pythonFiles/sortImports.py

@@ -58,23 +58,6 @@ export function interpreterInfo(): [string[], (out: string) => InterpreterInfoJs
     return [args, parse];
 }
 
-// sortImports.py
-
-export function sortImports(filename: string, sortArgs?: string[]): [string[], (out: string) => string] {
-    const script = path.join(SCRIPTS_DIR, 'sortImports.py');
-    const args = [script, filename, '--diff'];
-    if (sortArgs) {
-        args.push(...sortArgs);
-    }
-
-    function parse(out: string) {
-        // It should just be a diff that the extension will use directly.
-        return out;
-    }
-
-    return [args, parse];
-}
-
 // normalizeSelection.py
 
 export function normalizeSelection(): [string[], (out: string) => string] {

src/client/common/process/internal/scripts/index.ts

@@ -466,6 +466,10 @@ export namespace ToolsExtensions {
     export const pylintPromptMessage = l10n.t(
         'Use the Pylint extension to enable easier configuration and new features such as quick fixes.',
     );
+    export const isortPromptMessage = l10n.t(
+        'To use sort imports, please install the isort extension. It provides easier configuration and new features such as code actions.',
+    );
     export const installPylintExtension = l10n.t('Install Pylint extension');
     export const installFlake8Extension = l10n.t('Install Flake8 extension');
+    export const installISortExtension = l10n.t('Install isort extension');
 }

src/client/common/utils/localize.ts

@@ -0,0 +1,30 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import * as path from 'path';
+import * as fs from 'fs-extra';
+import { Extension, extensions } from 'vscode';
+import { PVSC_EXTENSION_ID } from '../constants';
+
+export function getExtension<T = unknown>(extensionId: string): Extension<T> | undefined {
+    return extensions.getExtension(extensionId);
+}
+
+export function isExtensionEnabled(extensionId: string): boolean {
+    return extensions.getExtension(extensionId) !== undefined;
+}
+
+export function isExtensionDisabled(extensionId: string): boolean {
+    // We need an enabled extension to find the extensions dir.
+    const pythonExt = getExtension(PVSC_EXTENSION_ID);
+    if (pythonExt) {
+        let found = false;
+        fs.readdirSync(path.dirname(pythonExt.extensionPath), { withFileTypes: false }).forEach((s) => {
+            if (s.toString().startsWith(extensionId)) {
+                found = true;
+            }
+        });
+        return found;
+    }
+    return false;
+}

src/client/common/vscodeApis/extensionsApi.ts

@@ -4,6 +4,8 @@ import { Product } from '../common/types';
 import { IServiceContainer } from '../ioc/types';
 import { traceLog } from '../logging';
 import { BaseLinter } from './baseLinter';
+import { isExtensionEnabled } from './prompts/common';
+import { FLAKE8_EXTENSION } from './prompts/flake8Prompt';
 import { IToolsExtensionPrompt } from './prompts/types';
 import { ILintMessage } from './types';
 
@@ -15,8 +17,12 @@ export class Flake8 extends BaseLinter {
     }
 
     protected async runLinter(document: TextDocument, cancellation: CancellationToken): Promise<ILintMessage[]> {
-        if (await this.prompt.showPrompt()) {
-            traceLog('LINTING: Skipping linting from Python extension, since Flake8 extension is installed.');
+        await this.prompt.showPrompt();
+
+        if (isExtensionEnabled(this.serviceContainer, FLAKE8_EXTENSION)) {
+            traceLog(
+                'LINTING: Skipping linting from Python extension, since Flake8 extension is installed and enabled.',
+            );
             return [];
         }
 

src/client/linters/flake8.ts

@@ -8,7 +8,8 @@ import { IExperimentService, IExtensions, IPersistentState, IPersistentStateFact
 import { IServiceContainer } from '../../ioc/types';
 import { traceLog } from '../../logging';
 
-function isExtensionInstalledButDisabled(extensions: IExtensions, extensionId: string): boolean {
+export function isExtensionDisabled(serviceContainer: IServiceContainer, extensionId: string): boolean {
+    const extensions: IExtensions = serviceContainer.get<IExtensions>(IExtensions);
     // When debugging the python extension this `extensionPath` below will point to your repo.
     // If you are debugging this feature then set the `extensionPath` to right location after
     // the next line.
@@ -26,13 +27,12 @@ function isExtensionInstalledButDisabled(extensions: IExtensions, extensionId: s
     return false;
 }
 
-export function isExtensionInstalled(serviceContainer: IServiceContainer, extensionId: string): boolean {
+/**
+ * Detects if extension is installed and enabled.
+ */
+export function isExtensionEnabled(serviceContainer: IServiceContainer, extensionId: string): boolean {
     const extensions: IExtensions = serviceContainer.get<IExtensions>(IExtensions);
     const extension = extensions.getExtension(extensionId);
-    if (!extension) {
-        // The extension you are looking for might be disabled.
-        return isExtensionInstalledButDisabled(extensions, extensionId);
-    }
     return extension !== undefined;
 }
 

src/client/linters/prompts/common.ts

@@ -8,7 +8,7 @@ import { showInformationMessage } from '../../common/vscodeApis/windowApis';
 import { IServiceContainer } from '../../ioc/types';
 import { sendTelemetryEvent } from '../../telemetry';
 import { EventName } from '../../telemetry/constants';
-import { isExtensionInstalled, doNotShowPromptState, inToolsExtensionsExperiment } from './common';
+import { doNotShowPromptState, inToolsExtensionsExperiment, isExtensionDisabled, isExtensionEnabled } from './common';
 import { IToolsExtensionPrompt } from './types';
 
 export const FLAKE8_EXTENSION = 'ms-python.flake8';
@@ -20,9 +20,11 @@ export class Flake8ExtensionPrompt implements IToolsExtensionPrompt {
     public constructor(private readonly serviceContainer: IServiceContainer) {}
 
     public async showPrompt(): Promise<boolean> {
-        if (isExtensionInstalled(this.serviceContainer, FLAKE8_EXTENSION)) {
+        const isEnabled = isExtensionEnabled(this.serviceContainer, FLAKE8_EXTENSION);
+        if (isEnabled || isExtensionDisabled(this.serviceContainer, FLAKE8_EXTENSION)) {
             sendTelemetryEvent(EventName.TOOLS_EXTENSIONS_ALREADY_INSTALLED, undefined, {
                 extensionId: FLAKE8_EXTENSION,
+                isEnabled,
             });
             return true;
         }

src/client/linters/prompts/flake8Prompt.ts

@@ -8,7 +8,7 @@ import { showInformationMessage } from '../../common/vscodeApis/windowApis';
 import { IServiceContainer } from '../../ioc/types';
 import { sendTelemetryEvent } from '../../telemetry';
 import { EventName } from '../../telemetry/constants';
-import { doNotShowPromptState, inToolsExtensionsExperiment, isExtensionInstalled } from './common';
+import { doNotShowPromptState, inToolsExtensionsExperiment, isExtensionDisabled, isExtensionEnabled } from './common';
 import { IToolsExtensionPrompt } from './types';
 
 export const PYLINT_EXTENSION = 'ms-python.pylint';
@@ -20,9 +20,11 @@ export class PylintExtensionPrompt implements IToolsExtensionPrompt {
     public constructor(private readonly serviceContainer: IServiceContainer) {}
 
     public async showPrompt(): Promise<boolean> {
-        if (isExtensionInstalled(this.serviceContainer, PYLINT_EXTENSION)) {
+        const isEnabled = isExtensionEnabled(this.serviceContainer, PYLINT_EXTENSION);
+        if (isEnabled || isExtensionDisabled(this.serviceContainer, PYLINT_EXTENSION)) {
             sendTelemetryEvent(EventName.TOOLS_EXTENSIONS_ALREADY_INSTALLED, undefined, {
                 extensionId: PYLINT_EXTENSION,
+                isEnabled,
             });
             return true;
         }

src/client/linters/prompts/pylintPrompt.ts

@@ -7,6 +7,8 @@ import { Product } from '../common/types';
 import { IServiceContainer } from '../ioc/types';
 import { traceError, traceLog } from '../logging';
 import { BaseLinter } from './baseLinter';
+import { isExtensionEnabled } from './prompts/common';
+import { PYLINT_EXTENSION } from './prompts/pylintPrompt';
 import { IToolsExtensionPrompt } from './prompts/types';
 import { ILintMessage } from './types';
 
@@ -26,8 +28,12 @@ export class Pylint extends BaseLinter {
     }
 
     protected async runLinter(document: TextDocument, cancellation: CancellationToken): Promise<ILintMessage[]> {
-        if (await this.prompt.showPrompt()) {
-            traceLog('LINTING: Skipping linting from Python extension, since Pylint extension is installed.');
+        await this.prompt.showPrompt();
+
+        if (isExtensionEnabled(this.serviceContainer, PYLINT_EXTENSION)) {
+            traceLog(
+                'LINTING: Skipping linting from Python extension, since Pylint extension is installed and enabled.',
+            );
             return [];
         }