Enhance branch display #260

Yukaii · 2018-01-26T03:19:01Z

This implements #258

Add gitlens.gitExplorer.branches.layout config with three available option: list, tree, and mix-tree

list is the current behavior, would display all branches with full branch name:

tree organize branch name with slashes as folder:

mix-tree sort all branches alphabetically:

TODOs

Unexpected ordering with tree layout
Current branch within branch folder should be at first in tree layout
- and should be expanded by default
Detach state branch name shouldn't be parse as tree

- Add current getter method to BranchNode - Implment a recursive findCurrent method on BranchFolderNode

Yukaii · 2018-01-30T12:15:57Z

@eamodio I think it's ready for review 😄 Ping me if any change is needed.

eamodio · 2018-02-02T19:44:14Z

@Yukaii Awesome -- I'm starting to look at this. But first can you adapt this to target the develop branch? As that branch is what will become GitLens 8 -- which will be the next release. Thanks!

Yukaii · 2018-02-03T10:10:31Z

@eamodio I've merged the changes from develop branch 😸

eamodio · 2018-02-05T00:11:22Z

package.json

+                        "tree",
+                        "mix-tree"
+                    ],
+                    "description": "Specifies how the `Branches` view will display branches\n `list` - display all branches \n`tree` - organize branch as folder if branch name contains slashes \"\/\"\n `mix-tree` - display branch folders along with normal branch alphabetically",


Any objection to getting rid of mix-tree and just having tree behave this way (i.e. sorted naturally)?

Or if you'd like to keep the feature, can we change it to a different setting?

Like gitlens.gitExplorer.branches.sort = 'alphabetic' | 'foldersFirst' | 'foldersLast'

or

gitlens.gitExplorer.branches.folderGrouping = 'none' | 'start' | 'end'?

Thoughts? (I think I'm leaning towards the latter -- as it is more explicit than just sort)

I think having only two options (list and tree) is fine and simpler for user too, actually current tree sort implementation (not the mix-tree one) calculates more. It runs a recursive function, marking the parent folder as current (BranchFolderNode#findCurrent)

If you think it's okay, I can drop those commits 😄

Ok let's drop it and just have the 2 options. Thanks!

eamodio · 2018-02-05T00:12:27Z

src/views/branchNode.ts

+        if (this.explorer.config.branches.layout === ExplorerBranchesLayout.List) {
+            return branchName;
+        } else {
+            return !!branchName.match(/\s/) ? branchName : this.branch.getBasename();


I'm not sure I understand the logic here. Why are you checking if the name contains any whitespace?

In some case like detached git state, the folder name will not be parsed correctly. So here I see any white space as invalid folder branch name, and choose not to handle them. Same logic appears in branchesNode.ts:38 and remoteNode.ts:39.

Ah ok, but why is it needed? A "branch" with spaces could be handled just the same as any other without '/' characters right? Was there an explicit case you were protecting against?

I encounter this issue with the branch name like " ✔️ (HEAD detached at xxxxxx/xxxxxx)", current implementation will split the name to

(HEAD detached at xxxxxx (branch folder)

xxxxxx) (sub-branch)

Ah -- ok, thanks

eamodio · 2018-02-06T04:10:47Z

@Yukaii I'm trying to finalize GitLens 8 for release and as I'd like to get this in, I'm planning on just getting this in and then remove the mix-tree option in a follow-on commit -- sound ok?

Yukaii · 2018-02-06T05:54:09Z

@eamodio Sure 👍

eamodio · 2018-02-06T18:38:53Z

This has been merged into develop and as long as GitLens 8 release candidate looks good this will ship in GitLens 8.

FYI, I made a bunch of changes to the behavior here: 112879d

I removed the mix-tree option and changed tree sorting to be similar to what mix-tree was. Although I pulled the current branch out of any nesting. Since I think it is important to keep the current branch at the top and stable.
I removed the folder icons in favor of using a new feature in vscode 1.20 (using the File Icon Theme). Unfortunately for vscode 1.19 there will be no icons at all, but since 1.20 is supposed to ship this week, I don't think it matters much.
I also added the new layout option to the new GitLens Settings page.

Thanks again for your awesome work! This is a great feature!

Add folder icon

0311cca

Yukaii force-pushed the improve-branch-folder branch from 5a600ce to 6e5403a Compare January 26, 2018 08:31

Yukaii changed the title ~~WIP: Enhance branch display~~ Enhance branch display Jan 29, 2018

Yukaii added 3 commits January 30, 2018 09:19

Implement branch folder

1e4854d

Implement branches.layout config option

c840753

Fix branch node ordering in Tree layout

57f12b0

Yukaii force-pushed the improve-branch-folder branch from c9fe1fb to 360bf2e Compare January 30, 2018 01:20

Yukaii added 3 commits January 30, 2018 11:16

Sort branch folder containing current branch correctly

e9dfcfd

- Add current getter method to BranchNode - Implment a recursive findCurrent method on BranchFolderNode

Do not parse invalid branch name as branch folder

eff10fb

Expand current branch folder

34172e4

Yukaii force-pushed the improve-branch-folder branch from c5ace7d to 34172e4 Compare January 30, 2018 03:16

eamodio self-requested a review February 2, 2018 19:37

eamodio added this to the Soon™ milestone Feb 2, 2018

eamodio changed the base branch from master to develop February 2, 2018 21:34

Merge branch 'develop' into improve-branch-folder

5a0b498

eamodio reviewed Feb 5, 2018

View reviewed changes

eamodio closed this Feb 6, 2018

eamodio removed this from the Soon™ milestone Jul 19, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhance branch display #260

Enhance branch display #260

Yukaii commented Jan 26, 2018 •

edited

Loading

Yukaii commented Jan 30, 2018

eamodio commented Feb 2, 2018 •

edited

Loading

Yukaii commented Feb 3, 2018

eamodio Feb 5, 2018

eamodio Feb 5, 2018 •

edited

Loading

Yukaii Feb 5, 2018 •

edited

Loading

eamodio Feb 5, 2018

eamodio Feb 5, 2018

Yukaii Feb 5, 2018

eamodio Feb 5, 2018

Yukaii Feb 6, 2018

eamodio Feb 6, 2018

eamodio commented Feb 6, 2018

Yukaii commented Feb 6, 2018

eamodio commented Feb 6, 2018 •

edited

Loading

Enhance branch display #260

Enhance branch display #260

Conversation

Yukaii commented Jan 26, 2018 • edited Loading

TODOs

Yukaii commented Jan 30, 2018

eamodio commented Feb 2, 2018 • edited Loading

Yukaii commented Feb 3, 2018

eamodio Feb 5, 2018

Choose a reason for hiding this comment

eamodio Feb 5, 2018 • edited Loading

Choose a reason for hiding this comment

Yukaii Feb 5, 2018 • edited Loading

Choose a reason for hiding this comment

eamodio Feb 5, 2018

Choose a reason for hiding this comment

eamodio Feb 5, 2018

Choose a reason for hiding this comment

Yukaii Feb 5, 2018

Choose a reason for hiding this comment

eamodio Feb 5, 2018

Choose a reason for hiding this comment

Yukaii Feb 6, 2018

Choose a reason for hiding this comment

eamodio Feb 6, 2018

Choose a reason for hiding this comment

eamodio commented Feb 6, 2018

Yukaii commented Feb 6, 2018

eamodio commented Feb 6, 2018 • edited Loading

Yukaii commented Jan 26, 2018 •

edited

Loading

eamodio commented Feb 2, 2018 •

edited

Loading

eamodio Feb 5, 2018 •

edited

Loading

Yukaii Feb 5, 2018 •

edited

Loading

eamodio commented Feb 6, 2018 •

edited

Loading