Auto-name worktrees after branch names

[pyxelr]

Feature description | 功能描述

Description

When creating a new worktree using the extension (using Git Worktree Manager pane > Add Worktree button), it suggests a generic folder name like worktree1 and then asks to pick up the branch name. This results in the VS Code window title showing worktree1 instead of something more meaningful like a branch name.

Desired Behavior

The worktree folder should automatically be named after the selected branch name, so the VS Code window title displays something like repository - branch-name or just branch-name instead of worktree1.

Suggested Implementation

• When prompting for a new worktree, either:
  • Pre-populate the folder name field with the branch name after the user selects/enters a branch
  • Add a setting to use a naming template (e.g., {branchName}, {repoName}-{branchName})
  • Add a checkbox option "Use branch name as folder name" (default: checked)

How would you use this feature? | 你希望如何使用此功能？

No response

Alternative solutions | 替代方案

Currently, users must manually replace the suggested "worktree1" with their desired folder name (typically the branch name).

Alternative option is to use CMD+SHIFT+P > Git: Create Worktree... option.

Additional context | 其他信息

No response

Would you like to work on this issue? | 你是否愿意参与此功能的开发？

None

[jackiotyu]

@pyxelr Thanks for your suggestion. You can try this configuration first.
I didn't strongly link the folder name to the branch name because a git worktree folder isn't necessarily tied to a specific branch. It can be reused and switched to other branches or commits at any time.

{ 
    "git-worktree-manager.worktreeSubdirectoryTemplate": "$BASE_NAME$INDEX" 
}

[pyxelr]

@pyxelr Thanks for your suggestion. You can try this configuration first. I didn't strongly link the folder name to the branch name because a git worktree folder isn't necessarily tied to a specific branch. It can be reused and switched to other branches or commits at any time.

{
"git-worktree-manager.worktreeSubdirectoryTemplate": "$BASE_NAME$INDEX"
}

Thanks, it's a bit better, although, it would be best to see the branch name for more context while switching VS Code windows:

[jackiotyu]

@pyxelr You can try Ctrl+Shift+R to load the worktree list. It's quite convenient - the branch information is displayed, and you can switch branches anytime by clicking the button.

[pyxelr]

@jackiotyu: It still does not really address the thing I am looking for. Anyway, I can live with it, and will most likely manage worktrees using CMD+SHIFT+P > Git: Create Worktree... option, while using your extension to quickly switch between them, which is really cool.

[jackiotyu]

@pyxelr I'll consider your suggestion, but this requires adjusting the workflow for creating worktrees. We'll need to select the branch first and then enter the folder name. I'll implement it within the next few days.

[pyxelr]

@jackiotyu Thanks, that would be lovely! Perhaps that could be a configurable option, as I am unsure if others would want it by default.

[jackiotyu]

@pyxelr Please try version v3.17.0. The workflow has been replaced with minimal impact, and configuration parameters have been added for flexible customization.

[pyxelr]

@jackiotyu: It’s working great now - you’re awesome!

Quick question: is it possible to exclude origin or origin/feature from the branch name when the branch hasn’t been pulled yet?

For example, instead of suggesting fastapi.origin/pre-commit-ci-update-config, it would suggest fastapi.pre-commit-ci-update-config.

[jackiotyu]

@pyxelr What if we convert fastapi.origin/pre-commit-ci-update-config to fastapi.origin-pre-commit-ci-update-config? I noticed that's how VSCode does it.

[pyxelr]

@jackiotyu: It is great now. Thanks for acting promptly!

I wonder if it would be a benefit to have an option to automatically hide origin from the name? Though, keeping it does help distinguish that it's a remote branch and not local.