Fix linting in debugger files

paulacamargo25 · paulacamargo25 · commit 93e99cdad676 · 2022-11-03T12:06:00.000-07:00
diff --git a/src/client/debugger/extension/configuration/debugConfigurationService.ts b/src/client/debugger/extension/configuration/debugConfigurationService.ts
@@ -28,6 +28,7 @@ import { IDebugConfigurationResolver } from './types';
 @injectable()
 export class PythonDebugConfigurationService implements IDebugConfigurationService {
     private cacheDebugConfig: DebugConfiguration | undefined = undefined;
+
     constructor(
         @inject(IDebugConfigurationResolver)
         @named('attach')
@@ -47,13 +48,12 @@ export class PythonDebugConfigurationService implements IDebugConfigurationServi
 
         // Disabled until configuration issues are addressed by VS Code. See #4007
         const multiStep = this.multiStepFactory.create<DebugConfigurationState>();
-        await multiStep.run((input, s) => this.pickDebugConfiguration(input, s), state);
+        await multiStep.run((input, s) => PythonDebugConfigurationService.pickDebugConfiguration(input, s), state);
 
-        if (Object.keys(state.config).length === 0) {
-            return;
-        } else {
+        if (Object.keys(state.config).length !== 0) {
             return [state.config as DebugConfiguration];
         }
+        return undefined;
     }
 
     public async resolveDebugConfiguration(
@@ -67,7 +67,8 @@ export class PythonDebugConfigurationService implements IDebugConfigurationServi
                 debugConfiguration as AttachRequestArguments,
                 token,
             );
-        } else if (debugConfiguration.request === 'test') {
+        }
+        if (debugConfiguration.request === 'test') {
             // `"request": "test"` is now deprecated. But some users might have it in their
             // launch config. We get here if they triggered it using F5 or start with debugger.
             throw Error(
@@ -80,9 +81,10 @@ export class PythonDebugConfigurationService implements IDebugConfigurationServi
                 } else {
                     const configs = await this.provideDebugConfigurations(folder, token);
                     if (configs === undefined) {
-                        return;
+                        return undefined;
                     }
                     if (Array.isArray(configs) && configs.length === 1) {
+                        // eslint-disable-next-line prefer-destructuring
                         debugConfiguration = configs[0];
                     }
                     this.cacheDebugConfig = cloneDeep(debugConfiguration);
@@ -107,7 +109,8 @@ export class PythonDebugConfigurationService implements IDebugConfigurationServi
         return debugConfiguration.request === 'attach' ? resolve(this.attachResolver) : resolve(this.launchResolver);
     }
 
-    protected async pickDebugConfiguration(
+    // eslint-disable-next-line consistent-return
+    protected static async pickDebugConfiguration(
         input: MultiStepInput<DebugConfigurationState>,
         state: DebugConfigurationState,
     ): Promise<InputStep<DebugConfigurationState> | void> {
@@ -178,7 +181,7 @@ export class PythonDebugConfigurationService implements IDebugConfigurationServi
             title: DebugConfigStrings.selectConfiguration.title,
             placeholder: DebugConfigStrings.selectConfiguration.placeholder,
             activeItem: items[0],
-            items: items,
+            items,
         });
         if (pick) {
             const pickedDebugConfiguration = debugConfigurations.get(pick.type)!;
diff --git a/src/client/debugger/extension/configuration/providers/djangoLaunch.ts b/src/client/debugger/extension/configuration/providers/djangoLaunch.ts
@@ -20,7 +20,7 @@ const workspaceFolderToken = '${workspaceFolder}';
 export async function buildDjangoLaunchDebugConfiguration(
     input: MultiStepInput<DebugConfigurationState>,
     state: DebugConfigurationState,
-) {
+): Promise<void> {
     const program = await getManagePyPath(state.folder);
     let manuallyEnteredAValue: boolean | undefined;
     const defaultProgram = `${workspaceFolderToken}${path.sep}manage.py`;
@@ -73,15 +73,16 @@ export async function validateManagePy(
             return error;
         }
     }
-    return;
+    return undefined;
 }
 
 export async function getManagePyPath(folder: vscode.WorkspaceFolder | undefined): Promise<string | undefined> {
     if (!folder) {
-        return;
+        return undefined;
     }
     const defaultLocationOfManagePy = path.join(folder.uri.fsPath, 'manage.py');
     if (await fs.pathExists(defaultLocationOfManagePy)) {
         return `${workspaceFolderToken}${path.sep}manage.py`;
     }
+    return undefined;
 }
diff --git a/src/client/debugger/extension/configuration/providers/fastapiLaunch.ts b/src/client/debugger/extension/configuration/providers/fastapiLaunch.ts
@@ -17,7 +17,7 @@ import { DebugConfigurationState, DebugConfigurationType } from '../../types';
 export async function buildFastAPILaunchDebugConfiguration(
     input: MultiStepInput<DebugConfigurationState>,
     state: DebugConfigurationState,
-) {
+): Promise<void> {
     const application = await getApplicationPath(state.folder);
     let manuallyEnteredAValue: boolean | undefined;
     const config: Partial<LaunchRequestArguments> = {
@@ -57,10 +57,11 @@ export async function buildFastAPILaunchDebugConfiguration(
 }
 export async function getApplicationPath(folder: WorkspaceFolder | undefined): Promise<string | undefined> {
     if (!folder) {
-        return;
+        return undefined;
     }
     const defaultLocationOfManagePy = path.join(folder.uri.fsPath, 'main.py');
     if (await fs.pathExists(defaultLocationOfManagePy)) {
         return 'main.py';
     }
+    return undefined;
 }
diff --git a/src/client/debugger/extension/configuration/providers/fileLaunch.ts b/src/client/debugger/extension/configuration/providers/fileLaunch.ts
@@ -14,7 +14,7 @@ import { DebugConfigurationState, DebugConfigurationType } from '../../types';
 export async function buildFileLaunchDebugConfiguration(
     _input: MultiStepInput<DebugConfigurationState>,
     state: DebugConfigurationState,
-) {
+): Promise<void> {
     const config: Partial<LaunchRequestArguments> = {
         name: DebugConfigStrings.file.snippet.name,
         type: DebuggerTypeName,
diff --git a/src/client/debugger/extension/configuration/providers/flaskLaunch.ts b/src/client/debugger/extension/configuration/providers/flaskLaunch.ts
@@ -17,7 +17,7 @@ import { DebugConfigurationState, DebugConfigurationType } from '../../types';
 export async function buildFlaskLaunchDebugConfiguration(
     input: MultiStepInput<DebugConfigurationState>,
     state: DebugConfigurationState,
-) {
+): Promise<void> {
     const application = await getApplicationPath(state.folder);
     let manuallyEnteredAValue: boolean | undefined;
     const config: Partial<LaunchRequestArguments> = {
@@ -61,10 +61,11 @@ export async function buildFlaskLaunchDebugConfiguration(
 }
 export async function getApplicationPath(folder: WorkspaceFolder | undefined): Promise<string | undefined> {
     if (!folder) {
-        return;
+        return undefined;
     }
     const defaultLocationOfManagePy = path.join(folder.uri.fsPath, 'app.py');
     if (await fs.pathExists(defaultLocationOfManagePy)) {
         return 'app.py';
     }
+    return undefined;
 }
diff --git a/src/client/debugger/extension/configuration/providers/moduleLaunch.ts b/src/client/debugger/extension/configuration/providers/moduleLaunch.ts
@@ -14,7 +14,7 @@ import { DebugConfigurationState, DebugConfigurationType } from '../../types';
 export async function buildModuleLaunchConfiguration(
     input: MultiStepInput<DebugConfigurationState>,
     state: DebugConfigurationState,
-) {
+): Promise<void> {
     let manuallyEnteredAValue: boolean | undefined;
     const config: Partial<LaunchRequestArguments> = {
         name: DebugConfigStrings.module.snippet.name,
diff --git a/src/client/debugger/extension/configuration/providers/pidAttach.ts b/src/client/debugger/extension/configuration/providers/pidAttach.ts
@@ -14,7 +14,7 @@ import { DebugConfigurationState, DebugConfigurationType } from '../../types';
 export async function buildPidAttachConfiguration(
     _input: MultiStepInput<DebugConfigurationState>,
     state: DebugConfigurationState,
-) {
+): Promise<void> {
     const config: Partial<AttachRequestArguments> = {
         name: DebugConfigStrings.attachPid.snippet.name,
         type: DebuggerTypeName,
diff --git a/src/client/debugger/extension/configuration/providers/pyramidLaunch.ts b/src/client/debugger/extension/configuration/providers/pyramidLaunch.ts
@@ -6,14 +6,14 @@
 import * as path from 'path';
 import * as fs from 'fs-extra';
 import { WorkspaceFolder } from 'vscode';
+import * as nls from 'vscode-nls';
 import { DebugConfigStrings } from '../../../../common/utils/localize';
 import { MultiStepInput } from '../../../../common/utils/multiStepInput';
 import { sendTelemetryEvent } from '../../../../telemetry';
 import { EventName } from '../../../../telemetry/constants';
 import { DebuggerTypeName } from '../../../constants';
 import { LaunchRequestArguments } from '../../../types';
 import { DebugConfigurationState, DebugConfigurationType } from '../../types';
-import * as nls from 'vscode-nls';
 import { resolveVariables } from '../utils/common';
 
 const localize: nls.LocalizeFunc = nls.loadMessageBundle();
@@ -23,7 +23,7 @@ const workspaceFolderToken = '${workspaceFolder}';
 export async function buildPyramidLaunchConfiguration(
     input: MultiStepInput<DebugConfigurationState>,
     state: DebugConfigurationState,
-) {
+): Promise<void> {
     const iniPath = await getDevelopmentIniPath(state.folder);
     const defaultIni = `${workspaceFolderToken}${path.sep}development.ini`;
     let manuallyEnteredAValue: boolean | undefined;
@@ -70,7 +70,7 @@ export async function validateIniPath(
     selected?: string,
 ): Promise<string | undefined> {
     if (!folder) {
-        return;
+        return undefined;
     }
     const error = DebugConfigStrings.pyramid.enterDevelopmentIniPath.invalid;
     if (!selected || selected.trim().length === 0) {
@@ -85,14 +85,16 @@ export async function validateIniPath(
             return error;
         }
     }
+    return undefined;
 }
 
 export async function getDevelopmentIniPath(folder: WorkspaceFolder | undefined): Promise<string | undefined> {
     if (!folder) {
-        return;
+        return undefined;
     }
     const defaultLocationOfManagePy = path.join(folder.uri.fsPath, 'development.ini');
     if (await fs.pathExists(defaultLocationOfManagePy)) {
         return `${workspaceFolderToken}${path.sep}development.ini`;
     }
+    return undefined;
 }
diff --git a/src/client/debugger/extension/configuration/resolvers/attach.ts b/src/client/debugger/extension/configuration/resolvers/attach.ts
@@ -16,7 +16,7 @@ export class AttachConfigurationResolver extends BaseConfigurationResolver<Attac
         debugConfiguration: AttachRequestArguments,
         _token?: CancellationToken,
     ): Promise<AttachRequestArguments | undefined> {
-        const workspaceFolder = this.getWorkspaceFolder(folder);
+        const workspaceFolder = AttachConfigurationResolver.getWorkspaceFolder(folder);
 
         await this.provideAttachDefaults(workspaceFolder, debugConfiguration as AttachRequestArguments);
 
@@ -49,41 +49,41 @@ export class AttachConfigurationResolver extends BaseConfigurationResolver<Attac
         debugConfiguration.workspaceFolder = workspaceFolder ? workspaceFolder.fsPath : undefined;
         const debugOptions = debugConfiguration.debugOptions!;
         if (!debugConfiguration.justMyCode) {
-            this.debugOption(debugOptions, DebugOptions.DebugStdLib);
+            AttachConfigurationResolver.debugOption(debugOptions, DebugOptions.DebugStdLib);
         }
         if (debugConfiguration.django) {
-            this.debugOption(debugOptions, DebugOptions.Django);
+            AttachConfigurationResolver.debugOption(debugOptions, DebugOptions.Django);
         }
         if (debugConfiguration.jinja) {
-            this.debugOption(debugOptions, DebugOptions.Jinja);
+            AttachConfigurationResolver.debugOption(debugOptions, DebugOptions.Jinja);
         }
         if (debugConfiguration.subProcess === true) {
-            this.debugOption(debugOptions, DebugOptions.SubProcess);
+            AttachConfigurationResolver.debugOption(debugOptions, DebugOptions.SubProcess);
         }
         if (
             debugConfiguration.pyramid &&
             debugOptions.indexOf(DebugOptions.Jinja) === -1 &&
             debugConfiguration.jinja !== false
         ) {
-            this.debugOption(debugOptions, DebugOptions.Jinja);
+            AttachConfigurationResolver.debugOption(debugOptions, DebugOptions.Jinja);
         }
         if (debugConfiguration.redirectOutput || debugConfiguration.redirectOutput === undefined) {
-            this.debugOption(debugOptions, DebugOptions.RedirectOutput);
+            AttachConfigurationResolver.debugOption(debugOptions, DebugOptions.RedirectOutput);
         }
 
         // We'll need paths to be fixed only in the case where local and remote hosts are the same
         // I.e. only if hostName === 'localhost' or '127.0.0.1' or ''
-        const isLocalHost = this.isLocalHost(debugConfiguration.host);
-        if (getOSType() == OSType.Windows && isLocalHost) {
-            this.debugOption(debugOptions, DebugOptions.FixFilePathCase);
+        const isLocalHost = AttachConfigurationResolver.isLocalHost(debugConfiguration.host);
+        if (getOSType() === OSType.Windows && isLocalHost) {
+            AttachConfigurationResolver.debugOption(debugOptions, DebugOptions.FixFilePathCase);
         }
-        if (getOSType() == OSType.Windows) {
-            this.debugOption(debugOptions, DebugOptions.WindowsClient);
+        if (getOSType() === OSType.Windows) {
+            AttachConfigurationResolver.debugOption(debugOptions, DebugOptions.WindowsClient);
         } else {
-            this.debugOption(debugOptions, DebugOptions.UnixClient);
+            AttachConfigurationResolver.debugOption(debugOptions, DebugOptions.UnixClient);
         }
         if (debugConfiguration.showReturnValue) {
-            this.debugOption(debugOptions, DebugOptions.ShowReturnValue);
+            AttachConfigurationResolver.debugOption(debugOptions, DebugOptions.ShowReturnValue);
         }
 
         debugConfiguration.pathMappings = this.resolvePathMappings(
@@ -93,9 +93,10 @@ export class AttachConfigurationResolver extends BaseConfigurationResolver<Attac
             debugConfiguration.remoteRoot,
             workspaceFolder,
         );
-        this.sendTelemetry('attach', debugConfiguration);
+        AttachConfigurationResolver.sendTelemetry('attach', debugConfiguration);
     }
 
+    // eslint-disable-next-line class-methods-use-this
     private resolvePathMappings(
         pathMappings: PathMapping[],
         host?: string,
@@ -106,13 +107,16 @@ export class AttachConfigurationResolver extends BaseConfigurationResolver<Attac
         // This is for backwards compatibility.
         if (localRoot && remoteRoot) {
             pathMappings.push({
-                localRoot: localRoot,
-                remoteRoot: remoteRoot,
+                localRoot,
+                remoteRoot,
             });
         }
         // If attaching to local host, then always map local root and remote roots.
-        if (this.isLocalHost(host)) {
-            pathMappings = this.fixUpPathMappings(pathMappings, workspaceFolder ? workspaceFolder.fsPath : '');
+        if (AttachConfigurationResolver.isLocalHost(host)) {
+            pathMappings = AttachConfigurationResolver.fixUpPathMappings(
+                pathMappings,
+                workspaceFolder ? workspaceFolder.fsPath : '',
+            );
         }
         return pathMappings.length > 0 ? pathMappings : undefined;
     }
diff --git a/src/client/debugger/extension/configuration/resolvers/base.ts b/src/client/debugger/extension/configuration/resolvers/base.ts
diff --git a/src/client/debugger/extension/configuration/resolvers/helper.ts b/src/client/debugger/extension/configuration/resolvers/helper.ts
diff --git a/src/client/debugger/extension/configuration/resolvers/launch.ts b/src/client/debugger/extension/configuration/resolvers/launch.ts
diff --git a/src/client/debugger/extension/serviceRegistry.ts b/src/client/debugger/extension/serviceRegistry.ts

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ const workspaceFolderToken = '${workspaceFolder}';`
`20`	`20`	`export async function buildDjangoLaunchDebugConfiguration(`
`21`	`21`	`input: MultiStepInput<DebugConfigurationState>,`
`22`	`22`	`state: DebugConfigurationState,`
`23`		`-) {`
	`23`	`+): Promise<void> {`
`24`	`24`	`const program = await getManagePyPath(state.folder);`
`25`	`25`	`let manuallyEnteredAValue: boolean \| undefined;`
`26`	`26`	const defaultProgram = `${workspaceFolderToken}${path.sep}manage.py`;
`@@ -73,15 +73,16 @@ export async function validateManagePy(`
`73`	`73`	`return error;`
`74`	`74`	`}`
`75`	`75`	`}`
`76`		`- return;`
	`76`	`+ return undefined;`
`77`	`77`	`}`
`78`	`78`
`79`	`79`	`export async function getManagePyPath(folder: vscode.WorkspaceFolder \| undefined): Promise<string \| undefined> {`
`80`	`80`	`if (!folder) {`
`81`		`- return;`
	`81`	`+ return undefined;`
`82`	`82`	`}`
`83`	`83`	`const defaultLocationOfManagePy = path.join(folder.uri.fsPath, 'manage.py');`
`84`	`84`	`if (await fs.pathExists(defaultLocationOfManagePy)) {`
`85`	`85`	return `${workspaceFolderToken}${path.sep}manage.py`;
`86`	`86`	`}`
	`87`	`+ return undefined;`
`87`	`88`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ import { DebugConfigurationState, DebugConfigurationType } from '../../types';`
`17`	`17`	`export async function buildFastAPILaunchDebugConfiguration(`
`18`	`18`	`input: MultiStepInput<DebugConfigurationState>,`
`19`	`19`	`state: DebugConfigurationState,`
`20`		`-) {`
	`20`	`+): Promise<void> {`
`21`	`21`	`const application = await getApplicationPath(state.folder);`
`22`	`22`	`let manuallyEnteredAValue: boolean \| undefined;`
`23`	`23`	`const config: Partial<LaunchRequestArguments> = {`
`@@ -57,10 +57,11 @@ export async function buildFastAPILaunchDebugConfiguration(`
`57`	`57`	`}`
`58`	`58`	`export async function getApplicationPath(folder: WorkspaceFolder \| undefined): Promise<string \| undefined> {`
`59`	`59`	`if (!folder) {`
`60`		`- return;`
	`60`	`+ return undefined;`
`61`	`61`	`}`
`62`	`62`	`const defaultLocationOfManagePy = path.join(folder.uri.fsPath, 'main.py');`
`63`	`63`	`if (await fs.pathExists(defaultLocationOfManagePy)) {`
`64`	`64`	`return 'main.py';`
`65`	`65`	`}`
	`66`	`+ return undefined;`
`66`	`67`	`}`