Author: Nikola Hristov

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

@@ -22,15 +22,21 @@ export async function openReportIssue(): Promise<void> {
 		"resources",
 		"report_issue_template.md",
 	);
+
 	const userDataTemplatePath = path.join(
 		EXTENSION_ROOT_DIR,
 		"resources",
 		"report_issue_user_data_template.md",
 	);
+
 	const template = await fs.readFile(templatePath, "utf8");
+
 	const userTemplate = await fs.readFile(userDataTemplatePath, "utf8");
+
 	const interpreterPath = await getActiveEnvironmentPath();
+
 	const interpreter = await resolveEnvironment(interpreterPath);
+
 	const virtualEnvKind = interpreter?.environment?.type || "Unknown";
 
 	const pythonVersion = getRawVersion(interpreter?.version);

Source/extension/common/application/debugSessionTelemetry.ts

@@ -31,6 +31,7 @@ class TelemetryTracker implements DebugAdapterTracker {
 
 	constructor(session: DebugSession) {
 		this.trigger = session.configuration.request as TriggerType;
+
 		const debugConfiguration = session.configuration as Partial<
 			LaunchRequestArguments & AttachRequestArguments
 		>;
@@ -83,6 +84,7 @@ export class DebugSessionTelemetry implements DebugAdapterTrackerFactory {
 		untrustedWorkspace: false,
 		virtualWorkspace: true,
 	};
+
 	constructor() {}
 
 	public createDebugAdapterTracker(

Source/extension/common/constants.ts

@@ -5,6 +5,7 @@
 import * as path from "path";
 
 export const PYTHON_LANGUAGE = "python";
+
 const folderName = path.basename(__dirname);
 export const EXTENSION_ROOT_DIR =
 	folderName === "common"
@@ -44,16 +45,26 @@ export function isUnitTestExecution(): boolean {
 
 export namespace Commands {
 	export const Debug_In_Terminal = "debugpy.debugInTerminal";
+
 	export const Debug_Using_Launch_Config = "debugpy.debugUsingLaunchConfig";
+
 	export const TriggerEnvironmentSelection = "debugpy.triggerEnvSelection";
+
 	export const PickLocalProcess = "debugpy.pickLocalProcess";
+
 	export const PickArguments = "debugpy.pickArgs";
+
 	export const ViewOutput = "debugpy.viewOutput";
+
 	export const ClearStorage = "debugpy.clearCacheAndReload";
+
 	export const Enable_SourceMap_Support = "debugpy.enableSourceMapSupport";
+
 	export const SelectDebugConfig =
 		"debugpy.SelectAndInsertDebugConfiguration";
+
 	export const Set_Interpreter = "python.setInterpreter";
+
 	export const ReportIssue = "debugpy.reportIssue";
 }
 

Source/extension/common/log/logging.ts

@@ -33,6 +33,7 @@ class OutputChannelLogger {
 let channel: OutputChannelLogger | undefined;
 export function registerLogger(logChannel: LogOutputChannel): Disposable {
 	channel = new OutputChannelLogger(logChannel);
+
 	return {
 		dispose: () => {
 			channel = undefined;

Source/extension/common/multiStepInput.ts

@@ -152,6 +152,7 @@ export class MultiStepInput<S> implements IMultiStepInput<S> {
 		initialize,
 	}: P): Promise<MultiStepInputQuickPickResponseType<T, P>> {
 		const disposables: Disposable[] = [];
+
 		const input = window.createQuickPick<T>();
 		input.title = title;
 		input.step = step;
@@ -162,6 +163,7 @@ export class MultiStepInput<S> implements IMultiStepInput<S> {
 		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];
@@ -171,6 +173,7 @@ export class MultiStepInput<S> implements IMultiStepInput<S> {
 			this.current.dispose();
 		}
 		this.current = input;
+
 		if (onChangeItem) {
 			disposables.push(
 				onChangeItem.event((e) => onChangeItem.callback(e, input)),
@@ -230,6 +233,7 @@ export class MultiStepInput<S> implements IMultiStepInput<S> {
 				}
 			}),
 		);
+
 		if (acceptFilterBoxTextAsSelection) {
 			disposables.push(
 				input.onDidAccept(() => {
@@ -270,6 +274,7 @@ export class MultiStepInput<S> implements IMultiStepInput<S> {
 		buttons,
 	}: P): Promise<MultiStepInputInputBoxResponseType<P>> {
 		const disposables: Disposable[] = [];
+
 		try {
 			return await new Promise<MultiStepInputInputBoxResponseType<P>>(
 				(resolve, reject) => {
@@ -287,6 +292,7 @@ export class MultiStepInput<S> implements IMultiStepInput<S> {
 							: []),
 						...(buttons || []),
 					];
+
 					let validating = validate("");
 					disposables.push(
 						input.onDidTriggerButton((item) => {
@@ -301,6 +307,7 @@ export class MultiStepInput<S> implements IMultiStepInput<S> {
 							const inputValue = input.value;
 							input.enabled = false;
 							input.busy = true;
+
 							if (!(await validate(inputValue))) {
 								resolve(inputValue);
 							}
@@ -310,7 +317,9 @@ export class MultiStepInput<S> implements IMultiStepInput<S> {
 						input.onDidChangeValue(async (text) => {
 							const current = validate(text);
 							validating = current;
+
 							const validationMessage = await current;
+
 							if (current === validating) {
 								input.validationMessage = validationMessage;
 							}
@@ -319,6 +328,7 @@ export class MultiStepInput<S> implements IMultiStepInput<S> {
 							resolve(undefined);
 						}),
 					);
+
 					if (this.current) {
 						this.current.dispose();
 					}
@@ -333,8 +343,10 @@ export class MultiStepInput<S> implements IMultiStepInput<S> {
 
 	private async stepThrough(start: InputStep<S>, state: S) {
 		let step: InputStep<S> | void = start;
+
 		while (step) {
 			this.steps.push(step);
+
 			if (this.current) {
 				this.current.enabled = false;
 				this.current.busy = true;
@@ -345,6 +357,7 @@ export class MultiStepInput<S> implements IMultiStepInput<S> {
 				if (err === InputFlowAction.back) {
 					this.steps.pop();
 					step = this.steps.pop();
+
 					if (step === undefined) {
 						throw err;
 					}

Source/extension/common/persistentState.ts

@@ -31,6 +31,7 @@ export class PersistentState<T> implements IPersistentState<T> {
 				this.key,
 				{ data: this.defaultValue! },
 			);
+
 			if (
 				!cachedData ||
 				!cachedData.expiry ||
@@ -69,6 +70,7 @@ export class PersistentState<T> implements IPersistentState<T> {
 				);
 				await this.updateValue(undefined as any, false);
 				await this.updateValue(newValue, false);
+
 				if (JSON.stringify(this.value) !== JSON.stringify(newValue)) {
 					traceWarn(
 						"Retry failed, storage update failed for key",
@@ -88,6 +90,7 @@ export const WORKSPACE_PERSISTENT_KEYS_DEPRECATED =
 	"PYTHON_EXTENSION_WORKSPACE_STORAGE_KEYS";
 
 const GLOBAL_PERSISTENT_KEYS = "PYTHON_GLOBAL_STORAGE_KEYS";
+
 const WORKSPACE_PERSISTENT_KEYS = "PYTHON_WORKSPACE_STORAGE_KEYS";
 type KeysStorageType = "global" | "workspace";
 export type KeysStorage = { key: string; defaultValue: unknown };
@@ -123,10 +126,12 @@ export class PersistentStateFactory implements IPersistentStateFactory {
 			Commands.ClearStorage,
 			this.cleanAllPersistentStates.bind(this),
 		);
+
 		const globalKeysStorageDeprecated = this.createGlobalPersistentState(
 			GLOBAL_PERSISTENT_KEYS_DEPRECATED,
 			[],
 		);
+
 		const workspaceKeysStorageDeprecated =
 			this.createWorkspacePersistentState(
 				WORKSPACE_PERSISTENT_KEYS_DEPRECATED,
@@ -148,6 +153,7 @@ export class PersistentStateFactory implements IPersistentStateFactory {
 		expiryDurationMs?: number,
 	): IPersistentState<T> {
 		ignoreErrors(this.addKeyToStorage("global", key, defaultValue));
+
 		return new PersistentState<T>(
 			this.globalState,
 			key,
@@ -162,6 +168,7 @@ export class PersistentStateFactory implements IPersistentStateFactory {
 		expiryDurationMs?: number,
 	): IPersistentState<T> {
 		ignoreErrors(this.addKeyToStorage("workspace", key, defaultValue));
+
 		return new PersistentState<T>(
 			this.workspaceState,
 			key,
@@ -184,7 +191,9 @@ export class PersistentStateFactory implements IPersistentStateFactory {
 			keyStorageType === "global"
 				? this._globalKeysStorage
 				: this._workspaceKeysStorage;
+
 		const found = storage.value.find((value) => value.key === key);
+
 		if (!found) {
 			await storage.updateValue([
 				{ key, defaultValue },
@@ -222,6 +231,7 @@ export class PersistentStateFactory implements IPersistentStateFactory {
 
 export interface IPersistentStorage<T> {
 	get(): T;
+
 	set(value: T): Promise<void>;
 }
 
@@ -238,14 +248,17 @@ export function getGlobalStorage<T>(
 		GLOBAL_PERSISTENT_KEYS,
 		[],
 	);
+
 	const found = globalKeysStorage.value.find(
 		(value) => value.key === key && value.defaultValue === defaultValue,
 	);
+
 	if (!found) {
 		const newValue = [{ key, defaultValue }, ...globalKeysStorage.value];
 		ignoreErrors(globalKeysStorage.updateValue(newValue));
 	}
 	const raw = new PersistentState<T>(context.globalState, key, defaultValue);
+
 	return {
 		// We adapt between PersistentState and IPersistentStorage.
 		get() {

Source/extension/common/process/decoder.ts

@@ -10,5 +10,6 @@ export function decodeBuffer(
 	encoding: string = DEFAULT_ENCODING,
 ): string {
 	encoding = iconv.encodingExists(encoding) ? encoding : DEFAULT_ENCODING;
+
 	return iconv.decode(Buffer.concat(buffers), encoding);
 }

Source/extension/common/process/logger.ts

@@ -26,7 +26,9 @@ export function logProcess(
 				.map((e) => toCommandArgumentForPythonExt(trimQuotes(e)))
 				.join(" ")
 		: fileOrCommand;
+
 	const info = [`> ${getDisplayCommands(command)}`];
+
 	if (options && options.cwd) {
 		info.push(
 			`${Logging.currentWorkingDirectory} ${getDisplayCommands(options.cwd as string)}`,
@@ -40,6 +42,7 @@ export function logProcess(
 
 function getDisplayCommands(command: string): string {
 	const workspaceFolders = getWorkspaceFolders();
+
 	if (workspaceFolders && workspaceFolders.length === 1) {
 		command = replaceMatchesWithCharacter(
 			command,
@@ -48,6 +51,7 @@ function getDisplayCommands(command: string): string {
 		);
 	}
 	const home = getUserHomeDir();
+
 	if (home) {
 		command = replaceMatchesWithCharacter(command, home, "~");
 	}
@@ -66,11 +70,13 @@ function replaceMatchesWithCharacter(
 	// we need to escape using an extra backlash so it's not considered special.
 	function getRegex(match: string) {
 		let pattern = escapeRegExp(match);
+
 		if (getOSType() === OSType.Windows) {
 			// Match both forward and backward slash versions of 'match' for Windows.
 			pattern = replaceAll(pattern, "\\\\", "(\\\\|/)");
 		}
 		let regex = new RegExp(pattern, "ig");
+
 		return regex;
 	}
 
@@ -82,9 +88,12 @@ function replaceMatchesWithCharacter(
 
 	for (let i = 0; i < chunked.length; i++) {
 		let regex = getRegex(match);
+
 		const regexResult = regex.exec(chunked[i]);
+
 		if (regexResult) {
 			const regexIndex = regexResult.index;
+
 			if (
 				regexIndex > 0 &&
 				isPrevioustoMatchRegexALetter(chunked[i], regexIndex - 1)