feat: add project name window title variable

Register the project name against a VS Code context key when the host supports window title variables.

Keep current-project detection independent of status bar visibility and document the template.

Author: oiahoon

README.md

@@ -298,6 +298,14 @@ If you intend to _share_ projects between  **Stable** and **Insider** installati
     "projectManager.showProjectNameInStatusBar": true
 ```
 
+* Display the Project Name in the Window Title (VS Code 1.93 and newer)
+
+Project Manager exposes the `${projectName}` variable for use in the built-in `window.title` setting.
+
+```json
+    "window.title": "${projectName}${separator}${activeEditorShort}"
+```
+
 * Open projects in _New Window_ when clicking in status bar (`false` by default)
 
 ```json 

src/extension.ts

@@ -35,6 +35,7 @@ import { registerWalkthrough } from "./commands/walkthrough";
 import { registerSideBarDecorations } from "./sidebar/decoration";
 import { ProjectNode } from "./sidebar/nodes";
 import { Project } from "./core/project";
+import { registerProjectNameWindowTitleVariable, updateProjectNameWindowTitleVariable } from "./utils/windowTitle";
 
 let locators: Locators;
 
@@ -167,6 +168,8 @@ export async function activate(context: vscode.ExtensionContext) {
     // introduce issues.
     const currentProject = showStatusBar(projectStorage, locators);
     Container.currentProject = currentProject;
+    await registerProjectNameWindowTitleVariable();
+    await updateProjectNameWindowTitleVariable(currentProject);
 
     // // new place to register TreeView
     await providerManager.showTreeViewFromAllProviders();
@@ -319,7 +322,7 @@ export async function activate(context: vscode.ExtensionContext) {
                 vscode.window.showInformationMessage(l10n.t("Project saved!"));
                 if (!node) {
                     showStatusBar(projectStorage, locators, projectName);
-                    updateCurrentProject();
+                    await updateCurrentProject();
                 }
                 return true;
             } else {
@@ -426,7 +429,7 @@ export async function activate(context: vscode.ExtensionContext) {
         input.show();
     }
 
-    function updateCurrentProject() {
+    async function updateCurrentProject() {
         const workspace0 = vscode.workspace.workspaceFile ? vscode.workspace.workspaceFile :
             vscode.workspace.workspaceFolders ? vscode.workspace.workspaceFolders[ 0 ].uri :
                 undefined;
@@ -439,6 +442,7 @@ export async function activate(context: vscode.ExtensionContext) {
             foundProject = projectStorage.existsWithRootPath(currentProjectPath, true);
         }
         Container.currentProject = foundProject;
+        await updateProjectNameWindowTitleVariable(foundProject);
     }
 
     async function listProjects(forceNewWindow: boolean) {
@@ -529,7 +533,7 @@ export async function activate(context: vscode.ExtensionContext) {
             value: oldName
         };
 
-        vscode.window.showInputBox(ibo).then(newName => {
+        vscode.window.showInputBox(ibo).then(async newName => {
             if (typeof newName === "undefined" || newName === oldName) {
                 return;
             }
@@ -546,6 +550,10 @@ export async function activate(context: vscode.ExtensionContext) {
                 projectStorage.save();
                 vscode.window.showInformationMessage(l10n.t("Project renamed!"));
                 updateStatusBar(oldName, node.command.arguments[0], newName);
+                if (Container.currentProject?.name.toLowerCase() === oldName.toLowerCase()) {
+                    Container.currentProject.name = newName;
+                    await updateProjectNameWindowTitleVariable(Container.currentProject);
+                }
             } else {
                 vscode.window.showErrorMessage(l10n.t("Project already exists!"));
             }
@@ -606,4 +614,4 @@ export async function activate(context: vscode.ExtensionContext) {
 export function deactivate() {
 
     locators.dispose();
-}
+}

src/statusbar/statusBar.ts

@@ -26,7 +26,33 @@ export function showStatusBar(projectStorage: ProjectStorage, locators: Locators
             undefined;
     const currentProjectPath = workspace0 ? workspace0.fsPath : undefined;
 
-    if (!showStatusConfig || !currentProjectPath) { return; }
+    if (!currentProjectPath) { return; }
+
+    let foundProject: Project;
+    if (!projectName) {
+        if (isRemoteUri(workspace0)) {
+            foundProject = projectStorage.existsRemoteWithRootPath(workspace0);
+        } else {
+            foundProject = projectStorage.existsWithRootPath(currentProjectPath, true);
+            if (!foundProject) {
+                foundProject = locators.vscLocator.existsWithRootPath(currentProjectPath);
+            }
+            if (!foundProject) {
+                foundProject = locators.gitLocator.existsWithRootPath(currentProjectPath);
+            }
+            if (!foundProject) {
+                foundProject = locators.mercurialLocator.existsWithRootPath(currentProjectPath);
+            }
+            if (!foundProject) {
+                foundProject = locators.svnLocator.existsWithRootPath(currentProjectPath);
+            }
+            if (!foundProject) {
+                foundProject = locators.anyLocator.existsWithRootPath(currentProjectPath);
+            }
+        }
+    }
+
+    if (!showStatusConfig) { return foundProject; }
 
     if (!statusItem) {
         statusItem = window.createStatusBarItem("projectManager.statusBar", StatusBarAlignment.Left);
@@ -42,34 +68,12 @@ export function showStatusBar(projectStorage: ProjectStorage, locators: Locators
         statusItem.command = "projectManager.listProjects";
     }
 
-    // if we have a projectName, we don't need to search.
     if (projectName) {
         statusItem.text += projectName;
         statusItem.show();
         return undefined;
     }
 
-    let foundProject: Project;
-    if (isRemoteUri(workspace0)) {
-        foundProject = projectStorage.existsRemoteWithRootPath(workspace0);
-    } else {
-        foundProject = projectStorage.existsWithRootPath(currentProjectPath, true);
-        if (!foundProject) {
-            foundProject = locators.vscLocator.existsWithRootPath(currentProjectPath);
-        }
-        if (!foundProject) {
-            foundProject = locators.gitLocator.existsWithRootPath(currentProjectPath);
-        }
-        if (!foundProject) {
-            foundProject = locators.mercurialLocator.existsWithRootPath(currentProjectPath);
-        }
-        if (!foundProject) {
-            foundProject = locators.svnLocator.existsWithRootPath(currentProjectPath);
-        }
-        if (!foundProject) {
-            foundProject = locators.anyLocator.existsWithRootPath(currentProjectPath);
-        }
-    }
     if (foundProject) {
         statusItem.text += foundProject.name;
         statusItem.show();
@@ -81,4 +85,4 @@ export function updateStatusBar(oldName: string, oldPath: string, newName: strin
     if (statusItem.text === codicons.file_directory + " " + oldName && statusItem.tooltip === oldPath) {
         statusItem.text = codicons.file_directory + " " + newName;
     }
-}
+}

src/utils/windowTitle.ts

@@ -0,0 +1,27 @@
+/*---------------------------------------------------------------------------------------------
+*  Copyright (c) Alessandro Fragnani. All rights reserved.
+*  Licensed under the GPLv3 License. See License.md in the project root for license information.
+*--------------------------------------------------------------------------------------------*/
+
+import { commands } from "vscode";
+import { Project } from "../core/project";
+
+const PROJECT_NAME_CONTEXT_KEY = "projectManager.projectName";
+const REGISTER_WINDOW_TITLE_VARIABLE_COMMAND = "registerWindowTitleVariable";
+
+export async function registerProjectNameWindowTitleVariable(): Promise<void> {
+    const availableCommands = await commands.getCommands();
+    if (!availableCommands.includes(REGISTER_WINDOW_TITLE_VARIABLE_COMMAND)) {
+        return;
+    }
+
+    await commands.executeCommand(
+        REGISTER_WINDOW_TITLE_VARIABLE_COMMAND,
+        "projectName",
+        PROJECT_NAME_CONTEXT_KEY
+    );
+}
+
+export async function updateProjectNameWindowTitleVariable(project?: Project): Promise<void> {
+    await commands.executeCommand("setContext", PROJECT_NAME_CONTEXT_KEY, project?.name);
+}