Add remoteBranchOrder config

[hosaka]

• PR Description
  As requested in Order remote branches by date of last commit #1412 and PR'd but abandoned in Add config to sort origin branches by last commit #2011. This PR takes the suggestions from @jesseduffield and makes the config prop an enum with alphabetical sort order being the default and an alternative lastCommit.

• Please check if the PR fulfills these requirements

• Cheatsheets are up-to-date (run 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

[hosaka]

Also worth noting that git branch --remote --sort=-authordate can be used to get the same output.

[stefanhaller]

This is a very welcome addition, I wanted this myself too. Thanks for the contribution.

However, I think it shouldn't be a config. I'd like us to move away from adding config options for things that we could also save in state.yml (see #3166 for more examples). So what I would like to have is a menu that lets users change the sort order at runtime, and then persist this in state.yml. It seems that s is still free in the branches panel, so this could bring up a "Sort order..." menu.

BTW, we also would like to have the sort order configurable for local branches (see here for some discussion about that; click "Load more" to see all of it). It's a little more involved there, as we're currently sorting by recency based on the local reflog, so we'd want three entries (recency, commit date, alphabetic). I'm not asking you to do that in this PR too, it could be a separate one later.

And finally, I think we should sort by committer date instead of author date. The rationale here is that any kind of activity on a branch should move it to the top, including rebasing it, amending commits, or rewording commit messages.

[hosaka]

Hi @stefanhaller thanks for your comment! A runtime option persistent in state.yml is a better approach to this, agree on that. I am not familiar with how the menus are managed in lazygit TUI but I can have a go at it.

s for Sort order in remote branches is what i'll start with, and I'll open a new PR instead, this one should be closed in that case

[stefanhaller]

Sounds good! Let me know if you need any help.

[hosaka]

Closing in favour of #3171