feat(branch): sanitize branch name (#44)

Author: cncolder

l10n/bundle.l10n.ja.json

@@ -15,6 +15,8 @@
     "Create Worktree": "ワークツリーを作成",
     "Create Worktree ({0})": "ワークツリーを作成 ({0})",
     "Choose a branch to create a new worktree from": "新しいワークツリーを作成するためのブランチを選択",
+    "The new branch will be \"{0}\"": "新しいブランチは \"{0}\" になります",
+    "Branch name needs to match regex: {0}": "ブランチ名は正規表現 {0} に一致する必要があります",
     "Checkout branch ( {0} )": "ブランチをチェックアウト ({0})",
     "Checkout branch ( {0} ) on {1}": "{1} でブランチ ({0}) をチェックアウト",
     "Checkout": "チェックアウト",

l10n/bundle.l10n.zh-cn.json

@@ -15,6 +15,8 @@
     "Create Worktree": "创建 Worktree",
     "Create Worktree ({0})": "创建 Worktree ({0})",
     "Choose a branch to create a new worktree from": "选择用于创建 Worktree 的分支",
+    "The new branch will be \"{0}\"": "新分支将为 \"{0}\"",
+    "Branch name needs to match regex: {0}": "分支名称必须匹配正则表达式: {0}",
     "Checkout branch ( {0} )": "签出分支 ({0})",
     "Checkout branch ( {0} ) on {1}": "签出分支 ({0}) 于 {1}",
     "Checkout": "签出分支",

l10n/bundle.l10n.zh-tw.json

@@ -15,6 +15,8 @@
     "Create Worktree": "建立 Worktree",
     "Create Worktree ({0})": "建立 Worktree ({0})",
     "Choose a branch to create a new worktree from": "選擇用於建立 Worktree 的分支",
+    "The new branch will be \"{0}\"": "新分支會是 \"{0}\"",
+    "Branch name needs to match regex: {0}": "分支名稱需要匹配 正規表達式: {0}",
     "Checkout branch ( {0} )": "切換分支 ({0})",
     "Checkout branch ( {0} ) on {1}": "在 {1} 切換分支 ({0})",
     "Checkout": "切換分支",

src/core/git/checkBranchNameValid.ts

@@ -1,7 +1,6 @@
 import * as vscode from 'vscode';
 import { withResolvers } from '@/core/util/promise';
-import { validateBranchInput } from '@/core/util/branch';
-import { debounce } from 'lodash-es';
+import { validateBranchName } from '@/core/util/branch';
 
 const backButton = vscode.QuickInputButtons.Back;
 
@@ -20,24 +19,22 @@ export const inputNewBranch = async (cwd: string, defaultValue?: string) => {
             inputBox.dispose();
         }
     });
-    inputBox.onDidAccept(async () => {
-        const errMsg = await validateBranchInput(cwd, inputBox.value);
-        if (errMsg) {
-            inputBox.validationMessage = errMsg;
+    inputBox.onDidAccept(() => {
+        const { sanitizedName, validationMessage } = validateBranchName(inputBox.value);
+        if (validationMessage && validationMessage.severity > vscode.InputBoxValidationSeverity.Info) {
+            inputBox.validationMessage = validationMessage;
             return;
         }
-        resolve(inputBox.value);
+        resolve(sanitizedName);
         inputBox.hide();
     });
     inputBox.onDidHide(() => {
         resolve(false);
     });
-    inputBox.onDidChangeValue(
-        debounce(async (value) => {
-            const errMsg = await validateBranchInput(cwd, value);
-            inputBox.validationMessage = errMsg;
-        }, 300),
-    );
+    inputBox.onDidChangeValue((value) => {
+        const { validationMessage } = validateBranchName(value);
+        inputBox.validationMessage = validationMessage;
+    });
     inputBox.show();
     return promise;
 };

src/core/ui/inputNewBranch.ts

@@ -1,13 +1,45 @@
 import * as vscode from 'vscode';
-import { checkBranchNameValid } from '@/core/git/checkBranchNameValid';
-
-export const validateBranchInput = async (cwd: string, value: string) => {
-    try {
-        if (!value) return vscode.l10n.t('Branch name cannot be empty');
-        const isValidBranchName = await checkBranchNameValid(cwd, value);
-        if (!isValidBranchName) return vscode.l10n.t('Branch name is invalid');
-        return '';
-    } catch (error) {
-        return String(error);
+
+/**
+ * Sanitize branch name similar to VSCode behavior. Removes or replaces invalid characters according to Git branch naming rules.
+ * @see https://github.com/microsoft/vscode/blob/1.107.1/extensions/git/src/commands.ts#L629
+ */
+export const sanitizeBranchName = (name: string, branchWhitespaceChar = '-') => {
+    if (!name) return name;
+
+    return name
+        .trim()
+        .replace(/^-+/, '')
+        .replace(/^\.|\/\.|\.\.|~|\^|:|\/$|\.lock$|\.lock\/|\\|\*|\s|^\s*$|\.$|\[|\]$/g, branchWhitespaceChar);
+};
+
+export const validateBranchName = (
+    name: string,
+): { sanitizedName?: string; validationMessage?: vscode.InputBoxValidationMessage } => {
+    const config = vscode.workspace.getConfiguration('git');
+    const branchWhitespaceChar = config.get<string>('branchWhitespaceChar')!;
+    const branchValidationRegex = config.get<string>('branchValidationRegex')!;
+    const validateName = new RegExp(branchValidationRegex);
+    const sanitizedName = sanitizeBranchName(name, branchWhitespaceChar);
+
+    if (validateName.test(sanitizedName)) {
+        if (name === sanitizedName) {
+            return { sanitizedName };
+        }
+        return {
+            sanitizedName,
+            validationMessage: {
+                message: vscode.l10n.t('The new branch will be "{0}"', sanitizedName),
+                severity: vscode.InputBoxValidationSeverity.Info,
+            },
+        };
     }
+
+    return {
+        sanitizedName,
+        validationMessage: {
+            message: vscode.l10n.t('Branch name needs to match regex: {0}', branchValidationRegex),
+            severity: vscode.InputBoxValidationSeverity.Error,
+        },
+    };
 };