Author: Nikola Hristov

Source/extension/common/application/commands/reportIssueCommand.ts

@@ -40,12 +40,14 @@ export async function openReportIssue(): Promise<void> {
 	const virtualEnvKind = interpreter?.environment?.type || "Unknown";
 
 	const pythonVersion = getRawVersion(interpreter?.version);
+
 	await executeCommand("workbench.action.openIssueReporter", {
 		extensionId: "ms-python.debugpy",
 		issueBody: template,
 		data: userTemplate
 			.replace("{0}", pythonVersion)
 			.replace("{1}", virtualEnvKind),
 	});
+
 	sendTelemetryEvent(EventName.USE_REPORT_ISSUE_COMMAND, undefined, {});
 }

Source/extension/common/application/debugSessionTelemetry.ts

@@ -26,7 +26,9 @@ function isResponse(a: any): a is DebugProtocol.Response {
 }
 class TelemetryTracker implements DebugAdapterTracker {
 	private timer = new StopWatch();
+
 	private readonly trigger: TriggerType = "launch";
+
 	private readonly console: ConsoleType | undefined;
 
 	constructor(session: DebugSession) {
@@ -35,6 +37,7 @@ class TelemetryTracker implements DebugAdapterTracker {
 		const debugConfiguration = session.configuration as Partial<
 			LaunchRequestArguments & AttachRequestArguments
 		>;
+
 		this.console = debugConfiguration.console;
 	}
 
@@ -66,11 +69,13 @@ class TelemetryTracker implements DebugAdapterTracker {
 		if (eventName === EventName.DEBUG_SESSION_START) {
 			this.timer.reset();
 		}
+
 		const telemetryProps = {
 			trigger: this.trigger,
 			console: this.console,
 			...properties,
 		};
+
 		sendTelemetryEvent(
 			eventName as keyof IEventNamePropertyMapping,
 			this.timer.elapsedTime,

Source/extension/common/multiStepInput.ts

@@ -58,36 +58,57 @@ export type QuickInputButtonSetup = {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export interface IQuickPickParameters<T extends QuickPickItem, E = any> {
 	title?: string;
+
 	step?: number;
+
 	totalSteps?: number;
+
 	canGoBack?: boolean;
+
 	items: T[];
+
 	activeItem?: T | ((quickPick: QuickPick<T>) => Promise<T>);
+
 	placeholder: string | undefined;
+
 	customButtonSetups?: QuickInputButtonSetup[];
+
 	matchOnDescription?: boolean;
+
 	matchOnDetail?: boolean;
+
 	keepScrollPosition?: boolean;
+
 	acceptFilterBoxTextAsSelection?: boolean;
 	/**
 	 * A method called only after quickpick has been created and all handlers are registered.
 	 */
 	initialize?: (quickPick: QuickPick<T>) => void;
+
 	onChangeItem?: {
 		callback: (event: E, quickPick: QuickPick<T>) => void;
+
 		event: Event<E>;
 	};
+
 	onDidTriggerItemButton?: (e: QuickPickItemButtonEvent<T>) => void;
 }
 
 interface InputBoxParameters {
 	title: string;
+
 	password?: boolean;
+
 	step?: number;
+
 	totalSteps?: number;
+
 	value: string;
+
 	prompt: string;
+
 	buttons?: QuickInputButton[];
+
 	validate(value: string): Promise<string | undefined>;
 }
 
@@ -102,6 +123,7 @@ type MultiStepInputInputBoxResponseType<P> =
 
 export interface IMultiStepInput<S> {
 	run(start: InputStep<S>, state: S): Promise<void>;
+
 	showQuickPick<T extends QuickPickItem, P extends IQuickPickParameters<T>>({
 		title,
 		step,
@@ -111,6 +133,7 @@ export interface IMultiStepInput<S> {
 		placeholder,
 		customButtonSetups,
 	}: P): Promise<MultiStepInputQuickPickResponseType<T, P>>;
+
 	showInputBox<P extends InputBoxParameters>({
 		title,
 		step,
@@ -155,24 +178,35 @@ export class MultiStepInput<S> implements IMultiStepInput<S> {
 		const disposables: Disposable[] = [];
 
 		const input = window.createQuickPick<T>();
+
 		input.title = title;
+
 		input.step = step;
+
 		input.totalSteps = totalSteps;
+
 		input.placeholder = placeholder;
+
 		input.ignoreFocusOut = true;
+
 		input.items = items;
+
 		input.matchOnDescription = matchOnDescription || false;
+
 		input.matchOnDetail = matchOnDetail || false;
+
 		input.buttons = this.steps.length > 1 ? [QuickInputButtons.Back] : [];
 
 		if (customButtonSetups) {
 			for (const customButtonSetup of customButtonSetups) {
 				input.buttons = [...input.buttons, customButtonSetup.button];
 			}
 		}
+
 		if (this.current) {
 			this.current.dispose();
 		}
+
 		this.current = input;
 
 		if (onChangeItem) {
@@ -184,6 +218,7 @@ export class MultiStepInput<S> implements IMultiStepInput<S> {
 		if (initialize) {
 			initialize(input);
 		}
+
 		if (activeItem) {
 			if (typeof activeItem === "function") {
 				activeItem(input).then((item) => {
@@ -195,6 +230,7 @@ export class MultiStepInput<S> implements IMultiStepInput<S> {
 		} else {
 			input.activeItems = [];
 		}
+
 		this.current.show();
 		// Keep scroll position is only meant to keep scroll position when updating items,
 		// so do it after initialization. This ensures quickpick starts with the active
@@ -207,8 +243,10 @@ export class MultiStepInput<S> implements IMultiStepInput<S> {
 			input.onDidTriggerButton(async (item) => {
 				if (item === QuickInputButtons.Back) {
 					deferred.reject(InputFlowAction.back);
+
 					input.hide();
 				}
+
 				if (customButtonSetups) {
 					for (const customButtonSetup of customButtonSetups) {
 						if (
@@ -280,13 +318,21 @@ export class MultiStepInput<S> implements IMultiStepInput<S> {
 			return await new Promise<MultiStepInputInputBoxResponseType<P>>(
 				(resolve, reject) => {
 					const input = window.createInputBox();
+
 					input.title = title;
+
 					input.step = step;
+
 					input.totalSteps = totalSteps;
+
 					input.password = !!password;
+
 					input.value = value || "";
+
 					input.prompt = prompt;
+
 					input.ignoreFocusOut = true;
+
 					input.buttons = [
 						...(this.steps.length > 1
 							? [QuickInputButtons.Back]
@@ -295,6 +341,7 @@ export class MultiStepInput<S> implements IMultiStepInput<S> {
 					];
 
 					let validating = validate("");
+
 					disposables.push(
 						input.onDidTriggerButton((item) => {
 							if (item === QuickInputButtons.Back) {
@@ -306,17 +353,22 @@ export class MultiStepInput<S> implements IMultiStepInput<S> {
 						}),
 						input.onDidAccept(async () => {
 							const inputValue = input.value;
+
 							input.enabled = false;
+
 							input.busy = true;
 
 							if (!(await validate(inputValue))) {
 								resolve(inputValue);
 							}
+
 							input.enabled = true;
+
 							input.busy = false;
 						}),
 						input.onDidChangeValue(async (text) => {
 							const current = validate(text);
+
 							validating = current;
 
 							const validationMessage = await current;
@@ -333,7 +385,9 @@ export class MultiStepInput<S> implements IMultiStepInput<S> {
 					if (this.current) {
 						this.current.dispose();
 					}
+
 					this.current = input;
+
 					this.current.show();
 				},
 			);
@@ -350,13 +404,16 @@ export class MultiStepInput<S> implements IMultiStepInput<S> {
 
 			if (this.current) {
 				this.current.enabled = false;
+
 				this.current.busy = true;
 			}
+
 			try {
 				step = await step(this, state);
 			} catch (err) {
 				if (err === InputFlowAction.back) {
 					this.steps.pop();
+
 					step = this.steps.pop();
 
 					if (step === undefined) {
@@ -371,6 +428,7 @@ export class MultiStepInput<S> implements IMultiStepInput<S> {
 				}
 			}
 		}
+
 		if (this.current) {
 			this.current.dispose();
 		}

Source/extension/common/persistentState.ts

@@ -56,6 +56,7 @@ export class PersistentState<T> implements IPersistentState<T> {
 			} else {
 				await this.storage.update(this.key, newValue);
 			}
+
 			if (
 				retryOnce &&
 				JSON.stringify(this.value) !== JSON.stringify(newValue)
@@ -68,7 +69,9 @@ export class PersistentState<T> implements IPersistentState<T> {
 					this.key,
 					" retrying by resetting first",
 				);
+
 				await this.updateValue(undefined as any, false);
+
 				await this.updateValue(newValue, false);
 
 				if (JSON.stringify(this.value) !== JSON.stringify(newValue)) {
@@ -102,20 +105,26 @@ export class PersistentStateFactory implements IPersistentStateFactory {
 		untrustedWorkspace: false,
 		virtualWorkspace: true,
 	};
+
 	private globalState: Memento;
+
 	private workspaceState: Memento;
+
 	public readonly _globalKeysStorage: PersistentState<KeysStorage[]>;
 
 	public readonly _workspaceKeysStorage: PersistentState<KeysStorage[]>;
 
 	constructor(globalState: Memento, workspaceState: Memento) {
 		this.globalState = globalState;
+
 		this.workspaceState = workspaceState;
+
 		this._globalKeysStorage = new PersistentState<KeysStorage[]>(
 			this.globalState,
 			GLOBAL_PERSISTENT_KEYS,
 			[],
 		);
+
 		this._workspaceKeysStorage = new PersistentState<KeysStorage[]>(
 			this.workspaceState,
 			WORKSPACE_PERSISTENT_KEYS,
@@ -144,6 +153,7 @@ export class PersistentStateFactory implements IPersistentStateFactory {
 		if (globalKeysStorageDeprecated.value.length > 0) {
 			ignoreErrors(globalKeysStorageDeprecated.updateValue([]));
 		}
+
 		if (workspaceKeysStorageDeprecated.value.length > 0) {
 			ignoreErrors(workspaceKeysStorageDeprecated.updateValue([]));
 		}
@@ -210,19 +220,25 @@ export class PersistentStateFactory implements IPersistentStateFactory {
 				const storage = this.createGlobalPersistentState(
 					keyContent.key,
 				);
+
 				await storage.updateValue(keyContent.defaultValue);
 			}),
 		);
+
 		await Promise.all(
 			this._workspaceKeysStorage.value.map(async (keyContent) => {
 				const storage = this.createWorkspacePersistentState(
 					keyContent.key,
 				);
+
 				await storage.updateValue(keyContent.defaultValue);
 			}),
 		);
+
 		await this._globalKeysStorage.updateValue([]);
+
 		await this._workspaceKeysStorage.updateValue([]);
+
 		executeCommand("workbench.action.reloadWindow").then(noop);
 	}
 }
@@ -257,8 +273,10 @@ export function getGlobalStorage<T>(
 
 	if (!found) {
 		const newValue = [{ key, defaultValue }, ...globalKeysStorage.value];
+
 		ignoreErrors(globalKeysStorage.updateValue(newValue));
 	}
+
 	const raw = new PersistentState<T>(context.globalState, key, defaultValue);
 
 	return {

Source/extension/common/platform.ts

@@ -48,5 +48,6 @@ export function getUserHomeDir(): string | undefined {
 	if (getOSType() === OSType.Windows) {
 		return getEnvironmentVariable("USERPROFILE");
 	}
+
 	return getEnvironmentVariable("HOME") || getEnvironmentVariable("HOMEPATH");
 }