feat(config): add worktree subdirectory template configuration (#30)

* feat(config): add worktree subdirectory template configuration

- Introduced 'worktreeSubdirectoryTemplate' option in package.json for customizable worktree subdirectory names.
- Updated relevant localization files to include descriptions for the new configuration.
- Enhanced folder utility functions to support the new template and validate against invalid path characters.

* fix(config): update pattern error message for worktree subdirectory template

Author: 0skgc

package.json

@@ -943,6 +943,14 @@
             "type": "string",
             "default": "$BASE_PATH.worktree",
             "description": "%config.worktreePathTemplate.description%"
+          },
+          "git-worktree-manager.worktreeSubdirectoryTemplate": {
+            "order": 12,
+            "type": "string",
+            "default": "worktree$INDEX",
+            "pattern": "^[^/\\\\:*?\"<>|]+$",
+            "patternErrorMessage": "%config.worktreeSubdirectoryTemplate.patternErrorMessage%",
+            "description": "%config.worktreeSubdirectoryTemplate.description%"
           }
         }
       },
@@ -1153,6 +1161,7 @@
     "@typescript-eslint/eslint-plugin": "^5.59.1",
     "@typescript-eslint/parser": "^5.59.1",
     "@vscode/test-electron": "^2.3.0",
+    "@vscode/vsce": "^3.6.0",
     "eslint": "^8.39.0",
     "mocha": "^10.2.0",
     "typescript": "~5.0.4"

package.nls.ja.json

@@ -100,5 +100,7 @@
     "config.checkoutIgnoreOtherWorktree.description": "有効にすると、ブランチの切り替え時に他のワークツリーの状態を無視し、複数のワークツリーで同じブランチを使用できるようになります",
     "config.branchPick.showRenameBranch.description": "「ブランチを選択」の結果に「ブランチのリネーム」ボタンを表示",
     "config.treeView.toSCM.description": "ビューをソース管理コンテナに表示",
-    "config.worktreePathTemplate.description": "ワークツリーパスのテンプレートです。使用可能な変数：$BASE_PATH（リポジトリのルート）"
+    "config.worktreePathTemplate.description": "ワークツリーパスのテンプレートです。使用可能な変数：$BASE_PATH（リポジトリのルート）",
+    "config.worktreeSubdirectoryTemplate.description": "ワークツリーサブディレクトリ名のテンプレートです。使用可能な変数：$BASE_NAME（リポジトリフォルダ名）、$INDEX（増分番号）。使用できない文字: / \\ : * ? \" < > |",
+    "config.worktreeSubdirectoryTemplate.patternErrorMessage": "テンプレートに次の文字は使用できません: / \\ : * ? \" < > |"
 }

package.nls.json

@@ -100,5 +100,7 @@
     "config.checkoutIgnoreOtherWorktree.description": "When enabled, the state of other worktrees is ignored when switching branches, allowing multiple worktrees to use the same branch.",
     "config.branchPick.showRenameBranch.description": "Show the \"Rename Branch\" button on the results of \"Pick Branch\"",
     "config.treeView.toSCM.description": "Display views in the Source Control container",
-    "config.worktreePathTemplate.description": "Template for the worktree path. Available variables: $BASE_PATH (repo root)."
+    "config.worktreePathTemplate.description": "Template for the worktree path. Available variables: $BASE_PATH (repo root).",
+    "config.worktreeSubdirectoryTemplate.description": "Template for worktree subdirectory names. Available variables: $BASE_NAME (repo folder name), $INDEX (incrementing number). Cannot contain characters: / \\ : * ? \" < > |",
+    "config.worktreeSubdirectoryTemplate.patternErrorMessage": "Template cannot contain characters: / \\ : * ? \" < > |"
 }

package.nls.zh-cn.json

@@ -100,5 +100,7 @@
     "config.checkoutIgnoreOtherWorktree.description": "启用后，在切换分支时会忽略其他工作树的状态，允许多个工作树使用相同分支",
     "config.branchPick.showRenameBranch.description": "在 \"挑选分支\" 列表中展示 \"重命名分支\" 按钮",
     "config.treeView.toSCM.description": "视图展示在源代码管理容器中",
-    "config.worktreePathTemplate.description": "工作区路径的模板。可用的变量：$BASE_PATH（仓库根目录）"
+    "config.worktreePathTemplate.description": "工作区路径的模板。可用的变量：$BASE_PATH（仓库根目录）",
+    "config.worktreeSubdirectoryTemplate.description": "工作区子目录名称的模板。可用的变量：$BASE_NAME（仓库文件夹名称）、$INDEX（递增数字）。不能包含字符: / \\ : * ? \" < > |",
+    "config.worktreeSubdirectoryTemplate.patternErrorMessage": "模板不能包含以下字符: / \\ : * ? \" < > |"
 }

package.nls.zh-tw.json

@@ -100,5 +100,7 @@
     "config.checkoutIgnoreOtherWorktree.description": "啟用後，在切換分支時會忽略其他工作樹的狀態，允許多個工作樹使用相同分支",
     "config.branchPick.showRenameBranch.description": "在「挑選分支」清單中顯示「重命名分支」按鈕",
     "config.treeView.toSCM.description": "視圖顯示在原始碼控制容器中",
-    "config.worktreePathTemplate.description": "工作區路徑的模板。可用的變數：$BASE_PATH（倉庫根目錄）"
+    "config.worktreePathTemplate.description": "工作區路徑的模板。可用的變數：$BASE_PATH（倉庫根目錄）",
+    "config.worktreeSubdirectoryTemplate.description": "工作區子目錄名稱的模板。可用的變數：$BASE_NAME（倉庫資料夾名稱）、$INDEX（遞增數字）。不能包含字元: / \\ : * ? \" < > |",
+    "config.worktreeSubdirectoryTemplate.patternErrorMessage": "範本不能包含以下字元: / \\ : * ? \" < > |"
 }

src/core/config/setting.ts

@@ -34,6 +34,7 @@ export class Config {
     static get(key: 'treeView.showFetchInTreeItem', defaultValue: true): boolean;
     static get(key: 'treeView.toSCM', defaultValue: false): boolean;
     static get(key: 'worktreePathTemplate', defaultValue: '$BASE_PATH.worktree'): string;
+    static get(key: 'worktreeSubdirectoryTemplate', defaultValue: 'worktree$INDEX'): string;
     static get<T>(key: string, defaultValue: T): T {
         return vscode.workspace.getConfiguration(APP_NAME).get(key, defaultValue);
     }

src/core/ui/inputWorktreeDir.ts

@@ -1,7 +1,7 @@
 import * as vscode from 'vscode';
 import path from 'path';
 import { checkExist, isDirEmpty } from '@/core/util/file';
-import { comparePath, getBaseWorktreeDir } from '@/core/util/folder';
+import { comparePath, getBaseWorktreeDir, getSubDir } from '@/core/util/folder';
 import { Alert } from '@/core/ui/message';
 import { withResolvers } from '@/core/util/promise';
 
@@ -43,8 +43,9 @@ export const inputWorktreeDir = async ({
     const { promise, resolve, reject } = withResolvers<string | undefined>();
     // 最终路径
     const workTreeDir = getBaseWorktreeDir(baseDir);
-    let finalWorktreeDir = path.join(workTreeDir, 'worktree1');
-    const dirReg = /worktree(\d+)/;
+    const baseName = path.basename(baseDir);
+    const dirReg = new RegExp(getSubDir(baseName, '(\\d+)'));
+    let finalWorktreeDir = path.join(workTreeDir, getSubDir(baseName, 1));
     const inputBox = vscode.window.createInputBox();
     // 传入的 baseWorktreeDir 有值，且和 workTreeDir 不同，说明是从已选择的 worktree 切换过来
     if (baseWorktreeDir && !comparePath(workTreeDir, baseWorktreeDir)) {
@@ -57,7 +58,7 @@ export const inputWorktreeDir = async ({
         if (worktreeDirList.length) {
             worktreeDirList.sort((a, b) => Number(b.replace(dirReg, '$1')) - Number(a.replace(dirReg, '$1')));
             const index = worktreeDirList[0].match(dirReg)![1];
-            finalWorktreeDir = path.join(workTreeDir, `worktree${Number(index) + 1}`);
+            finalWorktreeDir = path.join(workTreeDir, getSubDir(baseName, Number(index) + 1));
         }
     }
     const selectDirBtn: vscode.QuickInputButton = {

src/core/util/folder.ts

@@ -45,4 +45,26 @@ export const getBaseWorktreeDir = (baseDir: string) => {
     return worktreePathTemplate.replace('$BASE_PATH', baseDir);
 };
 
+// Validate template for invalid path characters
+export const validateSubdirectoryTemplate = (template: string): boolean => {
+    // Check for invalid path characters
+    const invalidChars = /[/\\:*?"<>|]/;
+    return !invalidChars.test(template);
+};
+
+// get worktree subdirectory name with baseName and index
+export const getSubDir = (baseName: string, index: string | number) => {
+    const template = Config.get('worktreeSubdirectoryTemplate', 'worktree$INDEX');
+    
+    // Validate template
+    if (!validateSubdirectoryTemplate(template)) {
+        console.warn('Invalid worktree subdirectory template, using default');
+        return `worktree${String(index)}`;
+    }
+    
+    return template
+        .replace('$BASE_NAME', baseName)
+        .replace('$INDEX', String(index));
+};
+
 export const getBaseBundleDir = (baseDir: string) => `${baseDir}.repoBackup`;