Force remove worktree option

[elgar-groot]

It seems impossible to remove a worktree that contains submodules from within lazygit.

An option (perhaps capital D) to remove worktree with the --force flag.

Otherwise perhaps a prompt to force the remove when it fails without the --force flag.

[jstmrby]

It would be nice to have this feature implemented 🚀

However, I'd say there's no need to bind it to a key. If there's a way to determine the repo contains a submodule it could offer a Force remove prompt automatically.
If that's not possible/too much work a probably easier solution to offer the force prompt after a failure.

That being said having D force deleting might solve all future feature requests of similar nature.

[dessalines]

I'd love to see this also. If a project has submodules, then its impossible to easily remove the worktree.

[jamescrosswell]

Would love to see this. The repo I work with on a daily basis has loads of submodules... so I have to leave lazygit and use the command line to do this currently 😢

[mark2185]

so I have to leave lazygit and use the command line to do this currently

Would a custom command work for you?

[jamescrosswell]

Would a custom command work for you?

Awesome... thanks @mark2185 - this did the trick:

customCommands:
  - key: 'D'
    context: 'worktrees'
    description: 'Force remove selected worktree'
    prompts:
      - type: 'confirm'
        title: 'Force Remove Worktree'
        body: 'Are you sure you want to remove this worktree and any submodules?'
    command: 'git worktree remove -f {{ .SelectedWorktree.Path | quote }}'
    loadingText: 'Removing worktree...'
    output: log

As an aside, I'm not a go programmer but it looks like force remove for Worktrees is already supported but it's not triggered correctly by the specific error message that shows when the worktree contains submodules:

lazygit/pkg/gui/controllers/helpers/worktree_helper.go

Lines 190 to 201 in 3f30008

	if err := self.c.Git().Worktree.Delete(worktree.Path, force); err != nil {
	errMessage := err.Error()
	if !strings.Contains(errMessage, "--force") {
	return err
	}
	if !force {
	return self.Remove(worktree, true)
	}
	return err
	}
	self.c.Refresh(types.RefreshOptions{Mode: types.ASYNC, Scope: []types.RefreshableView{types.WORKTREES, types.BRANCHES, types.FILES}})

Here's the error that's showing for submodules:

[stefanhaller]

@jamescrosswell Great find, this is exactly the fix we need. See #4959 for the PR.