Fix autofixable ESLint warnings (#13613)

* Autofixed changes
* Fix that one require that was confusing ESLint
* Change max-len rule to warning + ignore strings
* Add a return value to make compile step pass
* Fix linting step
* Re-enable comma-dangle + address comments
* ESLint pass after main merge

Author: kimadeline

.eslintignore

@@ -301,6 +301,7 @@ src/test/common/utils/regexp.unit.test.ts
 src/test/common/utils/cacheUtils.unit.test.ts
 src/test/common/utils/decorators.unit.test.ts
 src/test/common/utils/localize.functional.test.ts
+src/test/common/utils/workerPool.functional.test.ts
 src/test/common/configSettings/configSettings.pythonPath.unit.test.ts
 src/test/common/configSettings/configSettings.unit.test.ts
 src/test/common/featureDeprecationManager.unit.test.ts
@@ -1053,6 +1054,7 @@ src/client/common/utils/version.ts
 src/client/common/utils/misc.ts
 src/client/common/utils/logging.ts
 src/client/common/utils/cacheUtils.ts
+src/client/common/utils/workerPool.ts
 src/client/common/crypto.ts
 src/client/common/extensions.ts
 src/client/common/dotnet/compatibilityService.ts

.eslintrc

@@ -45,7 +45,6 @@
 		"@typescript-eslint/no-useless-constructor": "error",
 		"@typescript-eslint/no-var-requires": "off",
 		// Other rules
-		"comma-dangle": "off",
 		"func-names": "off",
 		"import/extensions": "off",
 		"import/namespace": "off",
@@ -68,10 +67,12 @@
 			}
 		],
 		"max-len": [
-			"error",
+			"warn",
 			{
 				"code": 120,
 				"ignorePattern": "^import\\s.+\\sfrom\\s.+;$",
+				"ignoreStrings": true,
+				"ignoreTemplateLiterals": true,
 				"ignoreUrls": true
 			}
 		],

src/client/pythonEnvironments/discovery/globalenv.ts

@@ -25,7 +25,7 @@ export function getPyenvTypeFinder(
     pathJoin: (...parts: string[]) => string,
     // </path>
     getEnvVar: (name: string) => string | undefined,
-    exec: ExecFunc
+    exec: ExecFunc,
 ): TypeFinderFunc {
     const find = getPyenvRootFinder(homedir, pathJoin, getEnvVar, exec);
     return async (python) => {
@@ -49,7 +49,7 @@ export function getPyenvRootFinder(
     homedir: string,
     pathJoin: (...parts: string[]) => string,
     getEnvVar: (name: string) => string | undefined,
-    exec: ExecFunc
+    exec: ExecFunc,
 ): RootFinderFunc {
     return async () => {
         const root = getEnvVar('PYENV_ROOT');

src/client/pythonEnvironments/discovery/locators/helpers.ts

@@ -30,13 +30,12 @@ export async function lookForInterpretersInDirectory(pathToCheck: string, _: IFi
 export class InterpreterLocatorHelper implements IInterpreterLocatorHelper {
     constructor(
         @inject(IFileSystem) private readonly fs: IFileSystem,
-        @inject(IPipEnvServiceHelper) private readonly pipEnvServiceHelper: IPipEnvServiceHelper
+        @inject(IPipEnvServiceHelper) private readonly pipEnvServiceHelper: IPipEnvServiceHelper,
     ) {}
+
     public async mergeInterpreters(interpreters: PythonEnvironment[]): Promise<PythonEnvironment[]> {
         const items = interpreters
-            .map((item) => {
-                return { ...item };
-            })
+            .map((item) => ({ ...item }))
             .map((item) => {
                 item.path = path.normalize(item.path);
                 return item;
@@ -47,11 +46,11 @@ export class InterpreterLocatorHelper implements IInterpreterLocatorHelper {
                     // If same version and same base path, then ignore.
                     // Could be Python 3.6 with path = python.exe, and Python 3.6 and path = python3.exe.
                     if (
-                        item.version &&
-                        item.version.raw === currentVersion &&
-                        item.path &&
-                        current.path &&
-                        this.fs.arePathsSame(path.dirname(item.path), path.dirname(current.path))
+                        item.version
+                        && item.version.raw === currentVersion
+                        && item.path
+                        && current.path
+                        && this.fs.arePathsSame(path.dirname(item.path), path.dirname(current.path))
                     ) {
                         return true;
                     }
@@ -63,8 +62,8 @@ export class InterpreterLocatorHelper implements IInterpreterLocatorHelper {
                     // Preserve type information.
                     // Possible we identified environment as unknown, but a later provider has identified env type.
                     if (
-                        existingItem.envType === EnvironmentType.Unknown &&
-                        current.envType !== EnvironmentType.Unknown
+                        existingItem.envType === EnvironmentType.Unknown
+                        && current.envType !== EnvironmentType.Unknown
                     ) {
                         existingItem.envType = current.envType;
                     }
@@ -75,7 +74,7 @@ export class InterpreterLocatorHelper implements IInterpreterLocatorHelper {
                         'sysPrefix',
                         'architecture',
                         'sysVersion',
-                        'version'
+                        'version',
                     ];
                     for (const prop of props) {
                         if (!existingItem[prop] && current[prop]) {
@@ -95,7 +94,7 @@ export class InterpreterLocatorHelper implements IInterpreterLocatorHelper {
                     item.pipEnvWorkspaceFolder = info.workspaceFolder.fsPath;
                     item.envName = info.envName || item.envName;
                 }
-            })
+            }),
         );
         return items;
     }

src/client/pythonEnvironments/discovery/locators/index.ts

@@ -1,5 +1,7 @@
 import { inject, injectable } from 'inversify';
-import { Disposable, Event, EventEmitter, Uri } from 'vscode';
+import {
+    Disposable, Event, EventEmitter, Uri,
+} from 'vscode';
 import { traceDecorators } from '../../../common/logger';
 import { IPlatformService } from '../../../common/platform/types';
 import { IDisposableRegistry } from '../../../common/types';
@@ -15,7 +17,7 @@ import {
     KNOWN_PATH_SERVICE,
     PIPENV_SERVICE,
     WINDOWS_REGISTRY_SERVICE,
-    WORKSPACE_VIRTUAL_ENV_SERVICE
+    WORKSPACE_VIRTUAL_ENV_SERVICE,
 } from '../../../interpreter/contracts';
 import { IServiceContainer } from '../../../ioc/types';
 import { PythonEnvironment } from '../../info';
@@ -33,8 +35,11 @@ export class PythonInterpreterLocatorService implements IInterpreterLocatorServi
     public didTriggerInterpreterSuggestions: boolean;
 
     private readonly disposables: Disposable[] = [];
+
     private readonly platform: IPlatformService;
+
     private readonly interpreterLocatorHelper: IInterpreterLocatorHelper;
+
     private readonly _hasInterpreters: Deferred<boolean>;
 
     constructor(@inject(IServiceContainer) private serviceContainer: IServiceContainer) {
@@ -44,6 +49,7 @@ export class PythonInterpreterLocatorService implements IInterpreterLocatorServi
         this.interpreterLocatorHelper = serviceContainer.get<IInterpreterLocatorHelper>(IInterpreterLocatorHelper);
         this.didTriggerInterpreterSuggestions = false;
     }
+
     /**
      * This class should never emit events when we're locating.
      * The events will be fired by the indivitual locators retrieved in `getLocators`.
@@ -55,6 +61,7 @@ export class PythonInterpreterLocatorService implements IInterpreterLocatorServi
     public get onLocating(): Event<Promise<PythonEnvironment[]>> {
         return new EventEmitter<Promise<PythonEnvironment[]>>().event;
     }
+
     public get hasInterpreters(): Promise<boolean> {
         return this._hasInterpreters.completed ? this._hasInterpreters.promise : Promise.resolve(false);
     }
@@ -115,7 +122,7 @@ export class PythonInterpreterLocatorService implements IInterpreterLocatorServi
             [GLOBAL_VIRTUAL_ENV_SERVICE, undefined],
             [WORKSPACE_VIRTUAL_ENV_SERVICE, undefined],
             [KNOWN_PATH_SERVICE, undefined],
-            [CURRENT_PATH_SERVICE, undefined]
+            [CURRENT_PATH_SERVICE, undefined],
         ];
 
         const locators = keys

src/client/pythonEnvironments/discovery/locators/progressService.ts

@@ -16,41 +16,51 @@ import { PythonEnvironment } from '../../info';
 @injectable()
 export class InterpreterLocatorProgressService implements IInterpreterLocatorProgressService {
     private deferreds: Deferred<PythonEnvironment[]>[] = [];
+
     private readonly refreshing = new EventEmitter<void>();
+
     private readonly refreshed = new EventEmitter<void>();
+
     private readonly locators: IInterpreterLocatorService[] = [];
+
     constructor(
         @inject(IServiceContainer) serviceContainer: IServiceContainer,
-        @inject(IDisposableRegistry) private readonly disposables: Disposable[]
+        @inject(IDisposableRegistry) private readonly disposables: Disposable[],
     ) {
         this.locators = serviceContainer.getAll<IInterpreterLocatorService>(IInterpreterLocatorService);
     }
 
     public get onRefreshing(): Event<void> {
         return this.refreshing.event;
     }
+
     public get onRefreshed(): Event<void> {
         return this.refreshed.event;
     }
+
     public register(): void {
         this.locators.forEach((locator) => {
             locator.onLocating(this.handleProgress, this, this.disposables);
         });
     }
+
     @traceDecorators.verbose('Detected refreshing of Interpreters')
     private handleProgress(promise: Promise<PythonEnvironment[]>) {
         this.deferreds.push(createDeferredFrom(promise));
         this.notifyRefreshing();
         this.checkProgress();
     }
+
     @traceDecorators.verbose('All locators have completed locating')
     private notifyCompleted() {
         this.refreshed.fire();
     }
+
     @traceDecorators.verbose('Notify locators are locating')
     private notifyRefreshing() {
         this.refreshing.fire();
     }
+
     private checkProgress() {
         if (this.deferreds.length === 0) {
             return;
@@ -63,6 +73,7 @@ export class InterpreterLocatorProgressService implements IInterpreterLocatorPro
             .then(() => this.checkProgress())
             .ignoreErrors();
     }
+
     @traceDecorators.verbose('Checking whether locactors have completed locating')
     private areAllItemsComplete() {
         this.deferreds = this.deferreds.filter((item) => !item.completed);

src/client/pythonEnvironments/discovery/locators/services/KnownPathsService.ts

@@ -9,6 +9,7 @@ import { IServiceContainer } from '../../../../ioc/types';
 import { EnvironmentType, PythonEnvironment } from '../../../info';
 import { lookForInterpretersInDirectory } from '../helpers';
 import { CacheableLocatorService } from './cacheableLocatorService';
+
 const flatten = require('lodash/flatten') as typeof import('lodash/flatten');
 
 /**
@@ -19,7 +20,7 @@ export class KnownPathsService extends CacheableLocatorService {
     public constructor(
         @inject(IKnownSearchPathsForInterpreters) private knownSearchPaths: IKnownSearchPathsForInterpreters,
         @inject(IInterpreterHelper) private helper: IInterpreterHelper,
-        @inject(IServiceContainer) serviceContainer: IServiceContainer
+        @inject(IServiceContainer) serviceContainer: IServiceContainer,
     ) {
         super('KnownPathsService', serviceContainer);
     }
@@ -48,13 +49,15 @@ export class KnownPathsService extends CacheableLocatorService {
         const promises = this.knownSearchPaths.getSearchPaths().map((dir) => this.getInterpretersInDirectory(dir));
         return Promise.all<string[]>(promises)
             .then((listOfInterpreters) => flatten(listOfInterpreters))
-            .then((interpreters) => interpreters.filter((item) => item.length > 0))
-            .then((interpreters) =>
-                Promise.all(interpreters.map((interpreter) => this.getInterpreterDetails(interpreter)))
-            )
-            .then((interpreters) =>
-                interpreters.filter((interpreter) => !!interpreter).map((interpreter) => interpreter!)
-            );
+            .then((interpreters) => interpreters.filter(
+                (item) => item.length > 0,
+            ))
+            .then((interpreters) => Promise.all(
+                interpreters.map((interpreter) => this.getInterpreterDetails(interpreter)),
+            ))
+            .then((interpreters) => interpreters.filter(
+                (interpreter) => !!interpreter,
+            ).map((interpreter) => interpreter!));
     }
 
     /**
@@ -69,7 +72,7 @@ export class KnownPathsService extends CacheableLocatorService {
         return {
             ...(details as PythonEnvironment),
             path: interpreter,
-            envType: EnvironmentType.Unknown
+            envType: EnvironmentType.Unknown,
         };
     }
 
@@ -87,6 +90,7 @@ export class KnownPathsService extends CacheableLocatorService {
 @injectable()
 export class KnownSearchPathsForInterpreters implements IKnownSearchPathsForInterpreters {
     constructor(@inject(IServiceContainer) private readonly serviceContainer: IServiceContainer) {}
+
     /**
      * Return the paths where Python interpreters might be found.
      */