docs(jj): compatibility with git async prompt (#13602)
Co-authored-by: Nicknames96 <nicknames96@users.noreply.github.com>
Diff
1diff --git a/plugins/jj/README.md b/plugins/jj/README.md
2index ad16dde89085bca4021e49f37f8b9f33780c0571..6f10b5b99cbb7b25d9929e6b2bc0a4ec15f62f12 100644
3--- a/plugins/jj/README.md
4+++ b/plugins/jj/README.md
5@@ -98,6 +98,25 @@ If you prefer to keep your prompt always up-to-date but still don't want to _fee
6 your prompt asynchronous. This plugin doesn't do this automatically so you'd have to hack your theme a bit for
7 that.
8 9+### Git async-prompt compatibility
10+
11+If you use a wrapper function that calls `git_prompt_info` (as shown above), it won't work with
12+the default git async-prompt mode. This is because async-prompt only registers its background worker
13+when it detects `$(git_prompt_info)` literally in your prompt variables. A wrapper like
14+`$(_my_theme_vcs_info)` won't match, so the async output stays empty.
15+
16+To fix this, add one of the following to your `.zshrc` **before** Oh My Zsh is sourced:
17+
18+```zsh
19+# Option 1: force async handlers to always register (recommended, keeps async behavior)
20+zstyle ':omz:alpha:lib:git' async-prompt force
21+
22+# Option 2: disable async-prompt entirely (simpler, but prompt may feel slower in large repos)
23+zstyle ':omz:alpha:lib:git' async-prompt no
24+```
25+
26+See [#13555](https://github.com/ohmyzsh/ohmyzsh/issues/13555) for details.
27+
28 ## See Also
2930 - [martinvonz/jj](https://github.com/martinvonz/jj)