jj log ignores local_bookmarks/remote_bookmarks colors

[vvuk]

Description

jj log seems to ignore colors configured by local_bookmarks and remote_bookmarks. The default colors config has:

"bookmark" = "magenta"
"bookmarks" = "magenta"
"local_bookmarks" = "magenta"
"remote_bookmarks" = "magenta"

so this wouldn't be visible, but changing this to:

"bookmark" = "yellow"
"bookmarks" = "green"
"local_bookmarks" = "red"
"remote_bookmarks" = "blue"

has every bookmark (remote or local) showing up as green.

Expected Behavior

Somewhat unclear, given the ambiguity between "bookmarks" (and "bookmark"?) and local/remote bookmarks. But I'd expect local bookmarks to be red, and remote bookmarks to be blue.

Actual Behavior

Every bookmark is green.

Specifications

• Platform: macOS
• Version: jj 0.43.0-89f62ede8c1c611eaf134c0c49252efd65c7945d

[josephlou5]

I suspect you are referring to commit.bookmarks() resulting in no difference of colors. That's intentional; if you use --color=debug you can see that they do not get local_bookmarks or remote_bookmarks labels. These labels are only actually added if you use the commit.remote_bookmarks() or commit.local_bookmarks() methods directly. So I don't think this is a bug, but it could be documented better I suppose.

[josephlou5]

Also unfortunately you can't necessarily tell if a bookmark is remote or local from only iterating through commit.bookmarks(). For example, if you have a synced remote bookmark, then the CommitRef object in commit.bookmarks() will NOT return anything for .remote().

$ jj log -r main -T 'bookmarks.map(|b| b.remote())'
◆
│
~
$ jj log -r main -T 'remote_bookmarks.map(|b| b.remote())'
◆  origin
│
~
$ jj log -r main -T 'remote_bookmarks.map(|b| b.remote())' --color=debug
<<log commit node immutable::◆>>  <<log commit remote_bookmarks map remote::origin>>
│
~
$ jj log -r main -T 'local_bookmarks.map(|b| b.remote())'
◆
│
~
$ jj log -r main -T local_bookmarks
◆  main
│
~

So I usually have to use jj bookmark list --tracked to actually figure it out in scripts.

[vvuk]

Ahhh. Hmm. Would something like this work? -T 'local_bookmarks.map(|b| b) ++ remote_bookmarks.map(|b| b)'? That seems to get me close-ish:

> jj log -r 'main | main@origin' -T 'local_bookmarks.map(|b| b) ++ remote_bookmarks.map(|b| b)' --color=debug
<<log commit node immutable::◆>>  <<log commit remote_bookmarks map name::main>><<log commit remote_bookmarks map::@>><<log commit remote_bookmarks map remote::origin>>
<<log commit node elided::~>>  <<elided::(elided revisions)>>
<<log commit node immutable::◆>>  <<log commit local_bookmarks map name::main>><<log commit remote_bookmarks map name::main>><<log commit remote_bookmarks map::@>><<log commit remote_bookmarks map remote::git>>

But I need to pull out the @git entry that shows up in this case.

Either way, thanks, this makes sense. It would be nice maybe to tag everything that does have a non-empty remote() when a bookmark name is printed as remote_bookmarks, regardless if remote_bookmarks is used, but this at least explains the current behavour.

[josephlou5]

Yeah that sounds right. Note that a List<CommitRef> will automatically join its elements with a space, so your final template might be something like:

[template-aliases]
'format_bookmarks(commit)' = '''
commit.bookmarks()
  .filter(|b| b.remote() != "git")
  .map(|b| if(b.remote(), label("remote_bookmarks", b), b))
'''

Note that if you do separate(" ", local_bookmarks, remote_bookmarks), then you'll see main main@origin if the remote bookmarks is synced. So that's probably not what you want, unless you want to actually filter it out with something like:

[template-aliases]
'format_bookmarks(commit)' = '''
separate(" ",
  commit.local_bookmarks(),
  commit.remote_bookmarks().filter(|b|
    b.remote() != "git" &&
    !commit.local_bookmarks().any(|lb| lb.name() == b.name())
  ),
)
'''

There might be other edge cases I'm missing too.

FWIW I have something like this in my config, which doesn't use remote_bookmarks at all:

[template-aliases]
"format_bookmarks(commit)" = """
commit.bookmarks()
  .map(|b| label(if(b.remote() && !b.synced(), "remote_unsynced"), b))
"""

[colors]
"bookmarks remote_unsynced" = { fg = "cyan", italic = true }

[josephlou5]

Also just thought I'd note that jj show uses local_bookmarks and remote_bookmarks, so with jj show main you'll see both main and main@origin and different colors if configured.

[josephlou5]

Closed by #10082.