PR feedback

bobbrow · bobbrow · commit 98f430eceda2 · 2025-05-06T16:23:52.000-07:00
diff --git a/Extension/package.json b/Extension/package.json
@@ -3377,10 +3377,10 @@
                         "markdownDescription": "%c_cpp.configuration.copilotHover.markdownDescription%",
                         "scope": "window"
                     },
-                    "C_Cpp.persistVSDeveloperEnvironment": {
+                    "C_Cpp.persistVsDeveloperEnvironment": {
                         "type": "boolean",
                         "default": true,
-                        "markdownDescription": "%c_cpp.configuration.persistVSDeveloperEnvironment.markdownDescription%",
+                        "markdownDescription": "%c_cpp.configuration.persistVsDeveloperEnvironment.markdownDescription%",
                         "scope": "window"
                     }
                 }
@@ -3548,13 +3548,13 @@
                 "icon": "$(run)"
             },
             {
-                "command": "C_Cpp.SetVSDevEnvironment",
-                "title": "%c_cpp.command.SetVSDevEnvironment.title%",
+                "command": "C_Cpp.SetVsDeveloperEnvironment",
+                "title": "%c_cpp.command.SetVsDeveloperEnvironment.title%",
                 "category": "C/C++"
             },
             {
-                "command": "C_Cpp.ClearVSDevEnvironment",
-                "title": "%c_cpp.command.ClearVSDevEnvironment.title%",
+                "command": "C_Cpp.ClearVsDeveloperEnvironment",
+                "title": "%c_cpp.command.ClearVsDeveloperEnvironment.title%",
                 "category": "C/C++"
             },
             {
@@ -6029,11 +6029,11 @@
                     "when": "editorLangId =~ /^(c|(cuda-)?cpp)$/ && config.C_Cpp.debugShortcut && cpptools.buildAndDebug.isSourceFile"
                 },
                 {
-                    "command": "C_Cpp.SetVSDevEnvironment",
+                    "command": "C_Cpp.SetVsDeveloperEnvironment",
                     "when": "workspacePlatform == windows"
                 },
                 {
-                    "command": "C_Cpp.ClearVSDevEnvironment",
+                    "command": "C_Cpp.ClearVsDeveloperEnvironment",
                     "when": "workspacePlatform == windows"
                 },
                 {
@@ -6677,4 +6677,4 @@
         "postcss": "^8.4.31",
         "gulp-typescript/**/glob-parent": "^5.1.2"
     }
-}
+}
diff --git a/Extension/package.nls.json b/Extension/package.nls.json
@@ -37,8 +37,8 @@
     "c_cpp.command.RemoveAllCodeAnalysisProblems.title": "Clear All Code Analysis Problems",
     "c_cpp.command.BuildAndDebugFile.title": "Debug C/C++ File",
     "c_cpp.command.BuildAndRunFile.title": "Run C/C++ File",
-    "c_cpp.command.SetVSDevEnvironment.title": "Set Visual Studio Developer Environment",
-    "c_cpp.command.ClearVSDevEnvironment.title": "Clear Visual Studio Developer Environment",
+    "c_cpp.command.SetVsDeveloperEnvironment.title": "Set Visual Studio Developer Environment",
+    "c_cpp.command.ClearVsDeveloperEnvironment.title": "Clear Visual Studio Developer Environment",
     "c_cpp.command.AddDebugConfiguration.title": "Add Debug Configuration",
     "c_cpp.command.GenerateDoxygenComment.title": "Generate Doxygen Comment",
     "c_cpp.command.addSshTarget.title": "Add SSH target",
@@ -845,7 +845,7 @@
         ]
     },
     "c_cpp.configuration.debugShortcut.description": "Show the \"Run and Debug\" play button and \"Add Debug Configuration\" gear in the editor title bar for C++ files.",
-    "c_cpp.configuration.persistVSDeveloperEnvironment.markdownDescription": "Remember the last used Visual Studio developer environment for the current workspace. This setting is only applicable for Windows.",
+    "c_cpp.configuration.persistVsDeveloperEnvironment.markdownDescription": "Remember the last used Visual Studio developer environment for the current workspace. This setting is only applicable for Windows.",
     "c_cpp.debuggers.pipeTransport.description": "When present, this tells the debugger to connect to a remote computer using another executable as a pipe that will relay standard input/output between VS Code and the MI-enabled debugger backend executable (such as gdb).",
     "c_cpp.debuggers.pipeTransport.default.pipeProgram": "enter the fully qualified path for the pipe program name, for example '/usr/bin/ssh'.",
     "c_cpp.debuggers.pipeTransport.default.debuggerPath": "The full path to the debugger on the target machine, for example /usr/bin/gdb.",
@@ -1034,9 +1034,9 @@
         ]
     },
     "c_cpp.walkthrough.command.prompt.description": {
-        "message": "When using the Microsoft Visual Studio C++ compiler, the Visual Studio Developer Environment must be present.\n\nFollow the instructions on the right to relaunch or click the button below.\n[Set Developer Environment](command:C_Cpp.SetVSDevEnvironment?%22walkthrough%22)",
+        "message": "When using the Microsoft Visual Studio C++ compiler, the Visual Studio Developer Environment must be present.\n\nFollow the instructions on the right to relaunch or click the button below.\n[Set Developer Environment](command:C_Cpp.SetVsDeveloperEnvironment?%22walkthrough%22)",
         "comment": [
-            "{Locked=\"Visual Studio\"} {Locked=\"C++\"} {Locked=\"\\\n[\"} {Locked=\"](C_Cpp.SetVSDevEnvironment?%22walkthrough%22)\"}"
+            "{Locked=\"Visual Studio\"} {Locked=\"C++\"} {Locked=\"\\\n[\"} {Locked=\"](C_Cpp.SetVsDeveloperEnvironment?%22walkthrough%22)\"}"
         ]
     },
     "c_cpp.walkthrough.run.debug.title": "Run and debug your C++ file",
diff --git a/Extension/src/Debugger/configurationProvider.ts b/Extension/src/Debugger/configurationProvider.ts
@@ -604,7 +604,7 @@ export class DebugConfigurationProvider implements vscode.DebugConfigurationProv
             cancel);
         if (response === applyDevEnv) {
             try {
-                await vscode.commands.executeCommand('C_Cpp.SetVSDevEnvironment', 'buildAndDebug');
+                await vscode.commands.executeCommand('C_Cpp.SetVsDeveloperEnvironment', 'buildAndDebug');
             } catch (e: any) {
                 // Ignore the error, the user will be prompted to apply the environment manually.
             }
diff --git a/Extension/src/LanguageServer/extension.ts b/Extension/src/LanguageServer/extension.ts
@@ -431,8 +431,8 @@ export async function registerCommands(enabled: boolean): Promise<void> {
     commandDisposables.push(vscode.commands.registerCommand('C_Cpp.ExtractToMemberFunction', enabled ? () => onExtractToFunction(false, true) : onDisabledCommand));
     commandDisposables.push(vscode.commands.registerCommand('C_Cpp.ExpandSelection', enabled ? (r: Range) => onExpandSelection(r) : onDisabledCommand));
     commandDisposables.push(vscode.commands.registerCommand('C_Cpp.ShowCopilotHover', enabled ? () => onCopilotHover() : onDisabledCommand));
-    commandDisposables.push(vscode.commands.registerCommand('C_Cpp.SetVSDevEnvironment', enabled ? onSetVSDevEnvironment : onDisabledCommand));
-    commandDisposables.push(vscode.commands.registerCommand('C_Cpp.ClearVSDevEnvironment', enabled ? onClearVSDevEnvironment : onDisabledCommand));
+    commandDisposables.push(vscode.commands.registerCommand('C_Cpp.SetVsDeveloperEnvironment', enabled ? onSetVsDeveloperEnvironment : onDisabledCommand));
+    commandDisposables.push(vscode.commands.registerCommand('C_Cpp.ClearVsDeveloperEnvironment', enabled ? onClearVsDeveloperEnvironment : onDisabledCommand));
 }
 
 function onDisabledCommand() {
@@ -1562,7 +1562,7 @@ async function showCopilotContent(copilotHoverProvider: CopilotHoverProvider, ho
     return true;
 }
 
-async function onSetVSDevEnvironment(sender?: any): Promise<void> {
+async function onSetVsDeveloperEnvironment(sender?: any): Promise<void> {
     let success: boolean = true;
     try {
         await setEnvironment(util.extensionContext);
@@ -1579,10 +1579,10 @@ async function onSetVSDevEnvironment(sender?: any): Promise<void> {
             void vscode.window.showErrorMessage(`Failed to apply VS developer environment: ${error.message}`);
         }
     }
-    telemetry.logLanguageServerEvent("SetVSDevEnvironment", { "sender": util.getSenderType(sender), "resultcode": success.toString() });
+    telemetry.logLanguageServerEvent("SetVsDeveloperEnvironment", { "sender": util.getSenderType(sender), "resultcode": success.toString() });
 }
 
-async function onClearVSDevEnvironment(): Promise<void> {
+async function onClearVsDeveloperEnvironment(): Promise<void> {
     util.extensionContext?.environmentVariableCollection.clear();
     await vscode.commands.executeCommand('setContext', 'cpptools.msvcEnvironmentFound', util.hasMsvcEnvironment());
 }
diff --git a/Extension/src/LanguageServer/settings.ts b/Extension/src/LanguageServer/settings.ts
@@ -549,7 +549,7 @@ export class CppSettings extends Settings {
             && this.intelliSenseEngine.toLowerCase() === "default" && vscode.workspace.getConfiguration("workbench").get<any>("colorTheme") !== "Default High Contrast";
     }
     public get sshTargetsView(): string { return this.getAsString("sshTargetsView"); }
-    public get persistDevEnvironment(): boolean { return this.getAsBoolean("persistVSDeveloperEnvironment"); }
+    public get persistDevEnvironment(): boolean { return this.getAsBoolean("persistVsDeveloperEnvironment"); }
 
     // Returns the value of a setting as a string with proper type validation and checks for valid enum values while returning an undefined value if necessary.
     private getAsStringOrUndefined(settingName: string): string | undefined {
diff --git a/Extension/test/scenarios/SimpleCppProject/tests/devEnvironment.test.ts b/Extension/test/scenarios/SimpleCppProject/tests/devEnvironment.test.ts
@@ -12,18 +12,23 @@ import { errorOperationCancelled } from '../../../../src/LanguageServer/devcmd';
 suite("set developer environment", () => {
     if (isWindows) {
         test("set developer environment (Windows)", async () => {
-            const promise = vscode.commands.executeCommand('C_Cpp.SetVSDevEnvironment', 'test');
+            const promise = vscode.commands.executeCommand('C_Cpp.SetVsDeveloperEnvironment', 'test');
             const timer = setInterval(() => {
                 void vscode.commands.executeCommand('workbench.action.acceptSelectedQuickOpenItem');
             }, 1000);
             await promise;
             clearInterval(timer);
             equal(util.hasMsvcEnvironment(), true, "MSVC environment not set correctly.");
         });
+
+        test("clear developer environment (Windows)", async () => {
+            await vscode.commands.executeCommand('C_Cpp.ClearVsDeveloperEnvironment');
+            equal(util.hasMsvcEnvironment(), false, "MSVC environment not cleared correctly.");
+        });
     } else {
-        test("set developer environment (Linux/macOS)", async () => {
+        test("should not be able to set developer environment (Linux/macOS)", async () => {
             try {
-                await vscode.commands.executeCommand('C_Cpp.SetVSDevEnvironment', 'test');
+                await vscode.commands.executeCommand('C_Cpp.SetVsDeveloperEnvironment', 'test');
                 equal(false, true, "Should not be able to set developer environment on non-Windows platform.");
             }
             catch (e) {

Original file line number	Diff line number	Diff line change
`@@ -3377,10 +3377,10 @@`
`3377`	`3377`	`"markdownDescription": "%c_cpp.configuration.copilotHover.markdownDescription%",`
`3378`	`3378`	`"scope": "window"`
`3379`	`3379`	`},`
`3380`		`- "C_Cpp.persistVSDeveloperEnvironment": {`
	`3380`	`+ "C_Cpp.persistVsDeveloperEnvironment": {`
`3381`	`3381`	`"type": "boolean",`
`3382`	`3382`	`"default": true,`
`3383`		`- "markdownDescription": "%c_cpp.configuration.persistVSDeveloperEnvironment.markdownDescription%",`
	`3383`	`+ "markdownDescription": "%c_cpp.configuration.persistVsDeveloperEnvironment.markdownDescription%",`
`3384`	`3384`	`"scope": "window"`
`3385`	`3385`	`}`
`3386`	`3386`	`}`
`@@ -3548,13 +3548,13 @@`
`3548`	`3548`	`"icon": "$(run)"`
`3549`	`3549`	`},`
`3550`	`3550`	`{`
`3551`		`- "command": "C_Cpp.SetVSDevEnvironment",`
`3552`		`- "title": "%c_cpp.command.SetVSDevEnvironment.title%",`
	`3551`	`+ "command": "C_Cpp.SetVsDeveloperEnvironment",`
	`3552`	`+ "title": "%c_cpp.command.SetVsDeveloperEnvironment.title%",`
`3553`	`3553`	`"category": "C/C++"`
`3554`	`3554`	`},`
`3555`	`3555`	`{`
`3556`		`- "command": "C_Cpp.ClearVSDevEnvironment",`
`3557`		`- "title": "%c_cpp.command.ClearVSDevEnvironment.title%",`
	`3556`	`+ "command": "C_Cpp.ClearVsDeveloperEnvironment",`
	`3557`	`+ "title": "%c_cpp.command.ClearVsDeveloperEnvironment.title%",`
`3558`	`3558`	`"category": "C/C++"`
`3559`	`3559`	`},`
`3560`	`3560`	`{`
`@@ -6029,11 +6029,11 @@`
`6029`	`6029`	`"when": "editorLangId =~ /^(c\|(cuda-)?cpp)$/ && config.C_Cpp.debugShortcut && cpptools.buildAndDebug.isSourceFile"`
`6030`	`6030`	`},`
`6031`	`6031`	`{`
`6032`		`- "command": "C_Cpp.SetVSDevEnvironment",`
	`6032`	`+ "command": "C_Cpp.SetVsDeveloperEnvironment",`
`6033`	`6033`	`"when": "workspacePlatform == windows"`
`6034`	`6034`	`},`
`6035`	`6035`	`{`
`6036`		`- "command": "C_Cpp.ClearVSDevEnvironment",`
	`6036`	`+ "command": "C_Cpp.ClearVsDeveloperEnvironment",`
`6037`	`6037`	`"when": "workspacePlatform == windows"`
`6038`	`6038`	`},`
`6039`	`6039`	`{`
`@@ -6677,4 +6677,4 @@`
`6677`	`6677`	`"postcss": "^8.4.31",`
`6678`	`6678`	`"gulp-typescript/**/glob-parent": "^5.1.2"`
`6679`	`6679`	`}`
`6680`		`-}`
	`6680`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -604,7 +604,7 @@ export class DebugConfigurationProvider implements vscode.DebugConfigurationProv`
`604`	`604`	`cancel);`
`605`	`605`	`if (response === applyDevEnv) {`
`606`	`606`	`try {`
`607`		`- await vscode.commands.executeCommand('C_Cpp.SetVSDevEnvironment', 'buildAndDebug');`
	`607`	`+ await vscode.commands.executeCommand('C_Cpp.SetVsDeveloperEnvironment', 'buildAndDebug');`
`608`	`608`	`} catch (e: any) {`
`609`	`609`	`// Ignore the error, the user will be prompted to apply the environment manually.`
`610`	`610`	`}`
Original file line number	Diff line number	Diff line change
`@@ -431,8 +431,8 @@ export async function registerCommands(enabled: boolean): Promise<void> {`
`431`	`431`	`commandDisposables.push(vscode.commands.registerCommand('C_Cpp.ExtractToMemberFunction', enabled ? () => onExtractToFunction(false, true) : onDisabledCommand));`
`432`	`432`	`commandDisposables.push(vscode.commands.registerCommand('C_Cpp.ExpandSelection', enabled ? (r: Range) => onExpandSelection(r) : onDisabledCommand));`
`433`	`433`	`commandDisposables.push(vscode.commands.registerCommand('C_Cpp.ShowCopilotHover', enabled ? () => onCopilotHover() : onDisabledCommand));`
`434`		`- commandDisposables.push(vscode.commands.registerCommand('C_Cpp.SetVSDevEnvironment', enabled ? onSetVSDevEnvironment : onDisabledCommand));`
`435`		`- commandDisposables.push(vscode.commands.registerCommand('C_Cpp.ClearVSDevEnvironment', enabled ? onClearVSDevEnvironment : onDisabledCommand));`
	`434`	`+ commandDisposables.push(vscode.commands.registerCommand('C_Cpp.SetVsDeveloperEnvironment', enabled ? onSetVsDeveloperEnvironment : onDisabledCommand));`
	`435`	`+ commandDisposables.push(vscode.commands.registerCommand('C_Cpp.ClearVsDeveloperEnvironment', enabled ? onClearVsDeveloperEnvironment : onDisabledCommand));`
`436`	`436`	`}`
`437`	`437`
`438`	`438`	`function onDisabledCommand() {`
`@@ -1562,7 +1562,7 @@ async function showCopilotContent(copilotHoverProvider: CopilotHoverProvider, ho`
`1562`	`1562`	`return true;`
`1563`	`1563`	`}`
`1564`	`1564`
`1565`		`-async function onSetVSDevEnvironment(sender?: any): Promise<void> {`
	`1565`	`+async function onSetVsDeveloperEnvironment(sender?: any): Promise<void> {`
`1566`	`1566`	`let success: boolean = true;`
`1567`	`1567`	`try {`
`1568`	`1568`	`await setEnvironment(util.extensionContext);`
`@@ -1579,10 +1579,10 @@ async function onSetVSDevEnvironment(sender?: any): Promise<void> {`
`1579`	`1579`	void vscode.window.showErrorMessage(`Failed to apply VS developer environment: ${error.message}`);
`1580`	`1580`	`}`
`1581`	`1581`	`}`
`1582`		`- telemetry.logLanguageServerEvent("SetVSDevEnvironment", { "sender": util.getSenderType(sender), "resultcode": success.toString() });`
	`1582`	`+ telemetry.logLanguageServerEvent("SetVsDeveloperEnvironment", { "sender": util.getSenderType(sender), "resultcode": success.toString() });`
`1583`	`1583`	`}`
`1584`	`1584`
`1585`		`-async function onClearVSDevEnvironment(): Promise<void> {`
	`1585`	`+async function onClearVsDeveloperEnvironment(): Promise<void> {`
`1586`	`1586`	`util.extensionContext?.environmentVariableCollection.clear();`
`1587`	`1587`	`await vscode.commands.executeCommand('setContext', 'cpptools.msvcEnvironmentFound', util.hasMsvcEnvironment());`
`1588`	`1588`	`}`
Original file line number	Diff line number	Diff line change
`@@ -549,7 +549,7 @@ export class CppSettings extends Settings {`
`549`	`549`	`&& this.intelliSenseEngine.toLowerCase() === "default" && vscode.workspace.getConfiguration("workbench").get<any>("colorTheme") !== "Default High Contrast";`
`550`	`550`	`}`
`551`	`551`	`public get sshTargetsView(): string { return this.getAsString("sshTargetsView"); }`
`552`		`- public get persistDevEnvironment(): boolean { return this.getAsBoolean("persistVSDeveloperEnvironment"); }`
	`552`	`+ public get persistDevEnvironment(): boolean { return this.getAsBoolean("persistVsDeveloperEnvironment"); }`
`553`	`553`
`554`	`554`	`// Returns the value of a setting as a string with proper type validation and checks for valid enum values while returning an undefined value if necessary.`
`555`	`555`	`private getAsStringOrUndefined(settingName: string): string \| undefined {`