chore: update comments

Author: hverlin

src/utils/configureExtensionUtil.ts

@@ -15,8 +15,6 @@ export async function configureSimpleExtension(
 	{
 		configKey,
 		useShims,
-		// nodejs on windows default allow only `.exe`, no `.cmd`
-		// https://github.com/jdx/mise/discussions/4360
 		windowsShimOnlyEXE = true,
 		windowsExtOptional = false,
 		useSymLinks,
@@ -71,27 +69,27 @@ export async function getConfiguredBinPath(
 		binName = tool.name,
 	}: {
 		useShims: boolean;
-		// extension in windows, it only support `.exe`
+		// shims on windows which only support `.exe`
 		windowsShimOnlyEXE: boolean;
-		// extension in windows, the `.exe` ext is optional
-		// this help extension like `Deno` make no difference to linux/unix  in `settings.json`
+		// for some tools/extension on windows, the `.exe` ext might be optional
+		// this can help extensions like `Deno` where `mise which` returns `deno.exe` on windows
 		windowsExtOptional: boolean;
-
+		// if using useSymLinks, a side effect is that a symlink will be created in the `.vscode` directory
 		useSymLinks: boolean;
 		tool: MiseTool;
 		miseConfig: MiseConfig;
 		binName: string;
 	},
 ): Promise<string | undefined> {
-	let updatedPath = "";
+	let pathToReturn = "";
 
 	if (useShims) {
 		let shimPath = path.join(miseConfig.dirs.shims, binName);
 		if (isWindows) {
 			const mode = (await miseService.getSetting("windows_shim_mode"))?.trim();
 			if (mode === "file" && windowsShimOnlyEXE) {
 				logger.error(
-					`extension tool ${binName} only support \`exe\` in windows, change mise setting \`windows_shim_mode\` to \`symlink\` or \`hardlink\``,
+					`Extension tool ${binName} only support \`exe\` in windows, change mise setting \`windows_shim_mode\` to \`symlink\` or \`hardlink\``,
 				);
 				return undefined;
 			}
@@ -101,41 +99,36 @@ export async function getConfiguredBinPath(
 		if (!existsSync(shimPath)) {
 			return undefined;
 		}
-		updatedPath = shimPath;
+		pathToReturn = shimPath;
 	} else {
 		// let mise handle path
-		// python:
-		// 	 windows: `python.exe`
-		//   linux: `bin/python`
-		// ruff:
-		//   windows: `ruff.exe`
-		//   linux: `ruff-x86_64-unknown-linux-musl/ruff`
+		// node https://github.com/jdx/mise/blob/67f5ea8317bcf26755ef6ff65ed460fa272db9ff/src/plugins/core/node.rs#L217-L223
+		// python: windows: `python.exe` / linux: `bin/python` (https://github.com/jdx/mise/blob/67f5ea8317bcf26755ef6ff65ed460fa272db9ff/src/plugins/core/python.rs#L30-L36)
+		// ruff: windows: `ruff.exe / linux: `ruff-x86_64-unknown-linux-musl/ruff`
 		const binPath = await miseService.which(binName);
 		if (binPath === undefined) {
 			return undefined;
 		}
-		updatedPath = binPath;
+		pathToReturn = binPath;
 	}
 
 	if (useSymLinks) {
 		// some extension like `Deno` `Go` will add `.exe` to binName,
-		// cannot use `deno`, must `deno.exe`.
-		// shim name maybe `node.cmd`, keep `.cmd` suffix
-		// so keep ext same with target path
-		const ext = path.extname(updatedPath);
+		// For example, it's not possible to use `deno` in that path name. One must specify `deno.exe`.
+		// Shim name might end with `.cmd` (example: `node.cmd`), in this case, keep the `.cmd` suffix
+		// (so keep ext same with target path)
+		const ext = path.extname(pathToReturn);
 		const symName = isWindows ? `${binName}${ext}` : binName;
-		updatedPath = await miseService.createMiseToolSymlink(
+		pathToReturn = await miseService.createMiseToolSymlink(
 			symName,
-			updatedPath,
+			pathToReturn,
 			"file",
 		);
 	}
 
-	if (isWindows && windowsExtOptional) {
-		updatedPath = updatedPath.replace(/\.[^/\\.]+$/, "");
-	}
-
-	return updatedPath;
+	return isWindows && windowsExtOptional
+		? pathToReturn.replace(/\.[^/\\.]+$/, "")
+		: pathToReturn;
 }
 
 export async function configureExtension({

src/utils/supportedExtensions.ts

@@ -71,7 +71,7 @@ export const SUPPORTED_EXTENSIONS: Array<ConfigurableExtension> = [
 		}) => {
 			return configureSimpleExtension(miseService, {
 				configKey: "deno.path",
-				// if use `deno`，it will be `deno.exe` on windows
+				// extension is `deno.exe` on windows
 				windowsExtOptional: true,
 				useShims,
 				useSymLinks: false, // disabled until https://github.com/denoland/vscode_deno/pull/1245 is merged
@@ -223,7 +223,7 @@ export const SUPPORTED_EXTENSIONS: Array<ConfigurableExtension> = [
 			return configureSimpleExtension(miseService, {
 				configKey: "debug.javascript.defaultRuntimeExecutable",
 				useShims,
-				// support `.cmd`
+				// NodeJS on windows only allows `.exe`, no `.cmd` by default. See https://github.com/jdx/mise/discussions/4360
 				windowsShimOnlyEXE: false,
 				windowsExtOptional: true,
 				useSymLinks,