Update eslint rules (#14268)

* Update eslint rules

* Link fix

Author: karthiknadig

.eslintrc

@@ -70,6 +70,7 @@
                 "ignoreUrls": true
             }
         ],
+        "no-await-in-loop": "off",
         "no-confusing-arrow": [
             "error",
             {
@@ -82,6 +83,22 @@
         "no-multi-str": "off",
         "no-param-reassign": "off",
         "no-prototype-builtins": "off",
+        "no-restricted-syntax": [
+            "error",
+            {
+                "selector": "ForInStatement",
+                "message": "for..in loops iterate over the entire prototype chain, which is virtually never what you want. Use Object.{keys,values,entries}, and iterate over the resulting array."
+            },
+
+            {
+                "selector": "LabeledStatement",
+                "message": "Labels are a form of GOTO; using them makes code confusing and hard to maintain and understand."
+            },
+            {
+                "selector": "WithStatement",
+                "message": "`with` is disallowed in strict mode because it makes code impossible to predict and optimize."
+            }
+        ],
         "no-template-curly-in-string": "off",
         "no-underscore-dangle": "off",
         "no-useless-escape": "off",

src/client/pythonEnvironments/base/locatorUtils.ts

@@ -38,15 +38,14 @@ export function getQueryFilter(query: PythonLocatorQuery): (env: PythonEnvInfo)
         if (env.searchLocation === undefined) {
             // It is not a "rooted" env.
             return includeNonRooted;
-        } else {
-            // It is a "rooted" env.
-            const loc = env.searchLocation;
-            if (locationFilters !== undefined) {
-                // Check against the requested roots.  (There may be none.)
-                return locationFilters.some((filter) => filter(loc));
-            }
-            return true;
         }
+        // It is a "rooted" env.
+        const loc = env.searchLocation;
+        if (locationFilters !== undefined) {
+            // Check against the requested roots.  (There may be none.)
+            return locationFilters.some((filter) => filter(loc));
+        }
+        return true;
     }
     return (env) => {
         if (!checkKind(env)) {
@@ -101,7 +100,6 @@ export async function getEnvs(iterator: IPythonEnvsIterator): Promise<PythonEnvI
     let result = await iterator.next();
     while (!result.done) {
         envs.push(result.value);
-        // eslint-disable-next-line no-await-in-loop
         result = await iterator.next();
     }
 

src/client/pythonEnvironments/base/locators/composite/environmentsReducer.ts

@@ -38,7 +38,6 @@ export class PythonEnvsReducer implements ILocator {
             if (areSameEnv(result.value, env)) {
                 environment = result.value;
             }
-            // eslint-disable-next-line no-await-in-loop
             result = await iterator.next();
         }
         if (!environment) {
@@ -72,15 +71,13 @@ async function* iterEnvsIterator(
             if (event === null) {
                 state.done = true;
                 checkIfFinishedAndNotify(state, didUpdate);
+            } else if (seen[event.index] !== undefined) {
+                state.pending += 1;
+                resolveDifferencesInBackground(event.index, event.update, state, didUpdate, seen)
+                    .ignoreErrors();
             } else {
-                if (seen[event.index] !== undefined) {
-                    state.pending += 1;
-                    resolveDifferencesInBackground(event.index, event.update, state, didUpdate, seen)
-                        .ignoreErrors();
-                } else {
-                    // This implies a problem in a downstream locator
-                    traceVerbose(`Expected already iterated env, got ${event.old} (#${event.index})`);
-                }
+                // This implies a problem in a downstream locator
+                traceVerbose(`Expected already iterated env, got ${event.old} (#${event.index})`);
             }
         });
     }
@@ -97,7 +94,6 @@ async function* iterEnvsIterator(
             yield currEnv;
             seen.push(currEnv);
         }
-        // eslint-disable-next-line no-await-in-loop
         result = await iterator.next();
     }
     if (iterator.onUpdated === undefined) {

src/client/pythonEnvironments/base/locators/composite/environmentsResolver.ts

@@ -61,16 +61,14 @@ export class PythonEnvsResolver implements ILocator {
                 if (event === null) {
                     state.done = true;
                     checkIfFinishedAndNotify(state, didUpdate);
+                } else if (seen[event.index] !== undefined) {
+                    seen[event.index] = event.update;
+                    state.pending += 1;
+                    this.resolveInBackground(event.index, state, didUpdate, seen)
+                        .ignoreErrors();
                 } else {
-                    if (seen[event.index] !== undefined) {
-                        seen[event.index] = event.update;
-                        state.pending += 1;
-                        this.resolveInBackground(event.index, state, didUpdate, seen)
-                            .ignoreErrors();
-                    } else {
-                        // This implies a problem in a downstream locator
-                        traceVerbose(`Expected already iterated env, got ${event.old} (#${event.index})`);
-                    }
+                    // This implies a problem in a downstream locator
+                    traceVerbose(`Expected already iterated env, got ${event.old} (#${event.index})`);
                 }
             });
         }
@@ -82,7 +80,6 @@ export class PythonEnvsResolver implements ILocator {
             yield currEnv;
             state.pending += 1;
             this.resolveInBackground(seen.indexOf(currEnv), state, didUpdate, seen).ignoreErrors();
-            // eslint-disable-next-line no-await-in-loop
             result = await iterator.next();
         }
         if (iterator.onUpdated === undefined) {

src/client/pythonEnvironments/common/environmentIdentifier.ts

@@ -75,10 +75,8 @@ function getIdentifiers(): Map<EnvironmentType, (path:string) => Promise<boolean
 export async function identifyEnvironment(interpreterPath: string): Promise<EnvironmentType> {
     const identifiers = getIdentifiers();
     const prioritizedEnvTypes = getPrioritizedEnvironmentType();
-    // eslint-disable-next-line no-restricted-syntax
     for (const e of prioritizedEnvTypes) {
         const identifier = identifiers.get(e);
-        // eslint-disable-next-line no-await-in-loop
         if (identifier && await identifier(interpreterPath)) {
             return e;
         }

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

@@ -130,9 +130,7 @@ export class WorkspaceLocators extends Locator {
         // Fall back to checking all the roots.
         // The eslint disable below should be removed after we have a
         // better solution for these. We need asyncFind for this.
-        // eslint-disable-next-line no-restricted-syntax
         for (const key of Object.keys(this.locators)) {
-            // eslint-disable-next-line no-await-in-loop
             const resolved = await this.locators[key].resolveEnv(env);
             if (resolved !== undefined) {
                 return resolved;

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

@@ -35,7 +35,6 @@ export async function _getAssociatedPipfile(
     let heightToSearch = options.lookIntoParentDirectories ? getSearchHeight() : 1;
     while (heightToSearch > 0 && !arePathsSame(searchDir, path.dirname(searchDir))) {
         const pipFile = path.join(searchDir, pipFileName);
-        // eslint-disable-next-line no-await-in-loop
         if (await pathExists(pipFile)) {
             return pipFile;
         }

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

@@ -18,19 +18,15 @@ import { commonPosixBinPaths, isPosixPythonBin } from '../../../common/posixUtil
 async function getPythonBinFromKnownPaths(): Promise<string[]> {
     const knownPaths = await commonPosixBinPaths();
     const pythonBins:Set<string> = new Set();
-    // eslint-disable-next-line no-restricted-syntax
     for (const knownPath of knownPaths) {
-        // eslint-disable-next-line no-await-in-loop
         const files = (await fsapi.readdir(knownPath))
             .map((filename:string) => path.join(knownPath, filename))
             .filter(isPosixPythonBin);
 
-        // eslint-disable-next-line no-restricted-syntax
         for (const file of files) {
             // Ensure that we have a collection of unique global binaries by
             // resolving all symlinks to the target binaries.
             try {
-                // eslint-disable-next-line no-await-in-loop
                 const resolvedBin = await resolveSymbolicLink(file);
                 pythonBins.add(resolvedBin);
                 traceInfo(`Found: ${file} --> ${resolvedBin}`);

src/client/pythonEnvironments/discovery/subenv.ts

@@ -4,9 +4,6 @@
 import { EnvironmentType } from '../info';
 import { getPyenvTypeFinder } from './globalenv';
 
-// tslint:disable-next-line: no-single-line-block-comment
-/* eslint-disable no-await-in-loop, no-restricted-syntax */
-
 type ExecFunc = (cmd: string, args: string[]) => Promise<{ stdout: string }>;
 
 type NameFinderFunc = (python: string) => Promise<string | undefined>;