More sanitized branch options

[Zombiefleischer]

• PR Description
  Added more sanitizing to branch names:

  • leading and trailing spaces will be removed
  • whitespaces and special chars (like *, \, etc.) will be replaced with an replacement char defined in the config (default: "-")

• Please check if the PR fulfills these requirements

• Cheatsheets are up-to-date (run go run scripts/cheatsheet/main.go generate)
• Code has been formatted (see here)
• Tests have been added/updated (see here for the integration test guide)
• Text is internationalised (see here)
• Docs (specifically docs/Config.md) have been updated if necessary
• You've read through your own file changes for silly mistakes etc

Closes #2663

[jesseduffield]

no need to pass this in because the config already lives in HelperCommon, so you can use self.c.UserConfig

[jesseduffield]

left a comment. Also, be sure to update the docs/Config.md doc

[jesseduffield]

Left another comment. Also, could we add an integration test for this? I.e. start a lazygit session, create a branch, observe that the created branch has the expected name.

[jesseduffield]

This regex feels like overkill to me. I would just have a slice of characters that we want to replace with hyphens one-to-one. The .lock thing is too presumptuous so let's remove that.

[Zombiefleischer]

I copied this regex from vscode, but I can remove that part.

[jesseduffield]

Sorry it's taken me so long to review this. I've taken a closer look and now understand why the original regex had .lock: git's docs explicitly call that out as invalid. I'm happy to use the vscode regex in that case, though the code can be cleaner i.e.:

func (self *RefsHelper) sanitizedBranchName(input string) string {
	leadingDashes := regexp.MustCompile(`^-+`)
	// See https://git-scm.com/docs/git-check-ref-format for the list of invalid strings.
	invalidStrings := regexp.MustCompile(`\.|\/\.|\.\.|~|\^|:|\/$|\.lock$|\.lock\/|\\|\*|\s|^\s*$|\.$|\[|\]$`)

	result := strings.TrimSpace(input)
	result = leadingDashes.ReplaceAllString(result, "")
	result = invalidStrings.ReplaceAllString(result, self.c.UserConfig.Gui.BranchWhitespaceChar)

	return result
}

Unfortunately the code has diverged quite a lot from the main branch. Would you still be open to continuing with this @Zombiefleischer ? If not, @raulhammerl offered to pick it up in the issue

[jesseduffield]

marking as changes requested for my own bookkeeping