Create factory function

microsoft · Aug 9, 2022 · 19e12ec · 19e12ec
1 parent 645873a
commit 19e12ec
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 16 deletions.
diff --git a/src/client/apiTypes.ts b/src/client/apiTypes.ts
@@ -245,18 +245,17 @@ export interface IProposedExtensionAPI {
         registerEnvironmentProvider(
             environmentProvider: IEnvironmentProvider,
             metadata: EnvironmentProviderMetadata,
-        ): Promise<void>;
+        ): Promise<void>; // TODO: Disposable??
     };
 }
 
 interface IEnvironmentProvider {
-    locator: ILocatorClass;
+    // TODO: createEnv
+    createLocator: ILocatorFactory;
     getEnvironmentDetails: (env: EnvInfo) => Promise<EnvironmentDetails | undefined>;
 }
 
-export interface ILocatorClass {
-    new (root?: string): ILocatorAPI;
-}
+export type ILocatorFactory = (root?: string) => ILocatorAPI;
 
 export interface ILocatorAPI {
     iterEnvs?(): IPythonEnvsIterator<EnvInfo>;

diff --git a/src/client/pythonEnvironments/base/locator.ts b/src/client/pythonEnvironments/base/locator.ts
@@ -14,10 +14,7 @@ import {
     PythonEnvsWatcher,
 } from './watcher';
 
-export interface ILocatorClass {
-    new (root?: string): ILocatorAPI;
-}
-
+export type ILocatorFactory = (root?: string) => ILocatorAPI;
 export interface ILocatorAPI {
     iterEnvs?(): IPythonEnvsIterator<EnvInfo>;
     readonly onChanged?: Event<LocatorEnvsChangedEvent>;
@@ -232,7 +229,7 @@ export interface ILocator<I = PythonEnvInfo, E extends BasicPythonEnvsChangedEve
 }
 
 export interface IEnvProvider {
-    addNewLocator?(LocatorClass: ILocatorClass, isWorkspace: boolean): void;
+    addNewLocator?(locatorFactory: ILocatorFactory, isWorkspace: boolean): void;
 }
 
 interface IResolver {

diff --git a/src/client/pythonEnvironments/base/locators/wrappers.ts b/src/client/pythonEnvironments/base/locators/wrappers.ts
@@ -3,7 +3,7 @@
 
 // eslint-disable-next-line max-classes-per-file
 import { Uri } from 'vscode';
-import { ILocatorClass } from '../../../apiTypes';
+import { ILocatorFactory } from '../../../apiTypes';
 import { IDisposable } from '../../../common/types';
 import { iterEmpty } from '../../../common/utils/async';
 import { getURIFilter } from '../../../common/utils/misc';
@@ -37,12 +37,12 @@ export class ExtensionLocators extends Locators<BasicEnvInfo> {
         return combineIterators(iterators);
     }
 
-    public addNewLocator(LocatorClass: ILocatorClass, isWorkspace: boolean): void {
+    public addNewLocator(locatorFactory: ILocatorFactory, isWorkspace: boolean): void {
         if (isWorkspace) {
-            this.workspace.addNewLocator(LocatorClass);
+            this.workspace.addNewLocator(locatorFactory);
         }
         if (!isWorkspace) {
-            this.nonWorkspace = [...this.nonWorkspace, new CustomLocator(new LocatorClass())];
+            this.nonWorkspace = [...this.nonWorkspace, new CustomLocator(locatorFactory())];
         }
     }
 }
@@ -145,10 +145,10 @@ export class WorkspaceLocators extends LazyResourceBasedLocator<BasicEnvInfo> {
         );
     }
 
-    public addNewLocator(LocatorClass: ILocatorClass): void {
+    public addNewLocator(locatorFactory: ILocatorFactory): void {
         Object.keys(this.roots).forEach((key) => {
             const root = this.roots[key];
-            const newLocator = new LocatorClass(root.fsPath);
+            const newLocator = locatorFactory(root.fsPath);
             const convertedLocator: ILocator<BasicEnvInfo> = new CustomLocator(newLocator);
             const [locators] = this.locators[key];
             locators.addLocator(convertedLocator);