Merge branch 'document-cli-commands'

* Branch commit log:
  doc/jj-fzf.1.md: describe how to run key binding commands via the CLI
  doc/jj-fzf.1.md: describe command-line options to jj-fzf
  jj-fzf: allow bookmark/push/rebase/reparent/oplog/evolog as CLI commands
  lib/setup.sh: jjfzf_run: support +x to skip command display
  README.md: add star history chart to README

Signed-off-by: Tim Janik <timj@gnu.org>

Author: tim-janik

README.md

@@ -137,6 +137,10 @@ This application is licensed under
 [MPL-2.0](https://github.com/tim-janik/jj-fzf/blob/master/LICENSE).
 
 
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=tim-janik/jj-fzf&type=Timeline)](https://star-history.com/#tim-janik/jj-fzf)
+
 <!-- MARKDOWN LINKS & IMAGES -->
 <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
 [irc-badge]: https://img.shields.io/badge/Live%20Chat-Libera%20IRC-blueviolet?style=for-the-badge

doc/jj-fzf.1.md

@@ -4,7 +4,31 @@
   jj-fzf - Terminal interface for the `jj` version control system based on fzf
 
 # SYNOPSIS
-  **jj-fzf** [*COMMAND*] [*ARGUMENTS*...]
+  **jj-fzf** [*OPTIONS*] \
+  **jj-fzf** *COMMAND* [*ARGUMENTS*...]
+
+# OPTIONS
+
+  **--version**
+  : Print version information.
+
+  **--help**
+  : Print brief usage information.
+
+  **--man**
+  : Browse this man page.
+
+  **--no-preview**
+  : Hide the preview window.
+
+  **-c**, **+c**
+  : Start as a commit picker, **-c** picks a single commit, **+c** picks multiple commits.
+
+  **-r**, **+r**
+  : Start as a revision (change ID) picker, **-r** picks a single revision, **+r** picks multiple revisions.
+
+  **-s**
+  : Start as a revset picker, returns the edited / current revset expression.
 
 # DESCRIPTION
 
@@ -16,8 +40,8 @@
   separate view for the operations log, `jj op log`, allows fast previews of
   diffs and commit histories of past operations and enabling undo of previous
   actions. The available hotkeys are displayed on-screen for easy
-  discoverability. The commands and key bindings can also be displayed with
-  `jj-fzf --help` and are documented in the **jj-fzf** wiki.
+  discoverability. The commands and key bindings can also be found in the man
+  page (displayed with `jj-fzf --man`) and are documented in the **jj-fzf** wiki.
 
 ## JJ LOG VIEW
 
@@ -93,10 +117,12 @@
 
   For all repository-modifying commands, **jj-fzf** prints the actual `jj` commands
   executed to stderr. The output aids users in learning how to use `jj` directly
-  to achieve the desired effects. It can also be useful when debugging and helps
-  users determine which actions they might wish to undo. Most commands can also
-  be run via the command line, using: \
-  `jj-fzf <command> <revision>`
+  to achieve the desired effects. This output can also be useful when debugging and
+  helps users determine which actions they might wish to undo.
+
+  Most commands can also be run directly from the command line. The supported
+  commands are the same as the key bindings listed below (e.g., `abandon`,
+  `squash`, etc.). The arguments are typically one or more commit or change IDs.
 
 # KEY BINDINGS
 

jj-fzf

@@ -78,7 +78,7 @@ DOC[commit]='Use `jj commit` to describe the currently selected revision and cre
 # Delete bookmarks & tags
 KEY[bookmark]="Alt-B"
 DOC[bookmark]='Create, move, delete jj bookmarks and git tags.'
-BINDINGS+=( --bind "alt-b:execute( '$JJFZF_ABSPATHLIB'/bookmarks.sh -m {2} ; jjfzf_load_and_status )+$RELOAD" )
+RUN[bookmark]="jjfzf_run +x +e '$JJFZF_ABSPATHLIB'/bookmarks.sh -m {2}"
 
 # Diffedit interactively
 KEY[diffedit]="Alt-E"
@@ -151,8 +151,8 @@ DOC[absorb]='Use `jj absorb` to split the content diff of the current revision a
 
 # Reparent Commits
 KEY[reparent]="Alt-P"
-BINDINGS+=( --bind "alt-p:execute( '$JJFZF_ABSPATHLIB'/reparent.sh {+2} ; jjfzf_load_and_status )+$RELOAD" )
 DOC[reparent]='Change parent(s) of the current revision by adding a new or removing an existing parent, and optionally simplify the parent list.'
+RUN[reparent]="jjfzf_run +x +e '$JJFZF_ABSPATHLIB'/reparent.sh {+2}"
 
 # Squash
 KEY[squash]="Alt-Q"
@@ -210,8 +210,8 @@ export -f jjfzf_restore
 
 # Rebase Commits
 KEY[rebase]="Alt-R"
-BINDINGS+=( --bind "alt-r:execute( '$JJFZF_ABSPATHLIB'/rebase.sh {+2} ; jjfzf_load_and_status )+$RELOAD" )
 DOC[rebase]='Use `jj rebase` or `jj duplicate` to move or copy a set of revisions (possibly with descendants), onto, before or after another revision. Also supports `jj simplify-parents` afterwards.'
+RUN[rebase]="jjfzf_run +x +e '$JJFZF_ABSPATHLIB'/rebase.sh {+2}"
 
 # Revert Commits
 KEY[revert]="Alt-V"	POST[revert]="+first"
@@ -314,12 +314,13 @@ DOC[new]='Use `jj new` to create a new revision on top of the currently selected
 
 # Oplog Commits
 KEY[oplog]="Ctrl-O"
-BINDINGS+=( --bind "ctrl-o:execute( '$JJFZF_ABSPATHLIB'/oplog.sh ; jjfzf_load_and_status )+$RELOAD" )
+RUN[oplog]="jjfzf_run +x +e '$JJFZF_ABSPATHLIB'/oplog.sh"
 DOC[oplog]='Use `jj operation log` to browse the recent operations log. Use hotkeys to view operation diffs and history. Undo operations or restore its working copy into a new commit.'
 
 # Push & fetch from remotes
 KEY[push]="Ctrl-P"	POST[new]="+first"
 DOC[push]='Use `jj git fetch` and `jj git push --tracked --deleted` to update the local and remote repositories. Pushing needs confirmation after a dry-run. Tries to push all refs if no revisions are currently selected.'
+RUN[push]="jjfzf_push {2} {+2}"
 jjfzf_push()
 (
   set -Eeuo pipefail
@@ -347,23 +348,22 @@ jjfzf_push()
   jjfzf_load_and_status
 )
 export -f jjfzf_push
-BINDINGS+=( --bind "ctrl-p:execute( jjfzf_push {2} {+2} )+$RELOAD" )
 
 # Evolog Commits
 KEY[evolog]="Ctrl-V"
-BINDINGS+=( --bind "ctrl-v:execute( '$JJFZF_ABSPATHLIB'/evolog.sh {2} ; jjfzf_load_and_status )+$RELOAD" )
 DOC[evolog]='Use `jj evolog` to browse the evolution of the selected revision. Inject historic commits into the ancestry without changing descendants.'
+RUN[evolog]="jjfzf_run +x +e '$JJFZF_ABSPATHLIB'/evolog.sh {2}"
 
 # Subshell
 KEY[shell]="Ctrl-Z"
-BINDINGS+=( --bind "ctrl-z:execute( jjfzf_exec_usershell )+execute( jjfzf_load_and_status )+$RELOAD+refresh-preview" )
 DOC[shell]='Start interactive subshell.'
+BINDINGS+=( --bind "ctrl-z:execute( jjfzf_exec_usershell )+execute( jjfzf_load_and_status )+$RELOAD+refresh-preview" )
 # This needs to run execute() twice, because of the exec in jjfzf_exec_usershell
 
 # Reload
 KEY[reload]="F5"
-BINDINGS+=( --bind "f5:execute( jjfzf_load_and_status )+$RELOAD+refresh-preview" )
 DOC[reload]='Reload the revset.'
+BINDINGS+=( --bind "f5:execute( jjfzf_load_and_status )+$RELOAD+refresh-preview" )
 
 # Interactive Revset
 BINDINGS+=( --bind 'change:reload: jjfzf_revset_log {q} ' )
@@ -430,7 +430,7 @@ export -f jjfzf_set_revset
 if [ -v "RUN[${1-}]" ]; then
   KEY="$1" && CMD="${RUN[$KEY]}" ; shift
   if [[ "$CMD" =~ \{ ]] ; then
-    CIDS=( $(jjfzf_list_change_ids "$@") )
+    CIDS=( $(jjfzf_list_change_ids "${@-@}") )
     test "${#CIDS[@]}" -lt 1 &&
       die "missing revisions for command: $KEY"
     # Placeholder replacments

lib/setup.sh

@@ -214,9 +214,10 @@ export -f jjfzf_load_and_status
 jjfzf_run()
 (
   set -Eeuo pipefail
-  IGNORE=false NOLOAD=false
+  IGNORE=false NOLOAD=false _X=-x
   while test $# -ne 0 ; do
     case "$1" in \
+      +x)	_X=+x ;;
       +e)	IGNORE=true ;;
       +n)	NOLOAD=true ;;
       +*)	true ;; # skip
@@ -226,13 +227,16 @@ jjfzf_run()
   done
   ERR=0
   if test -n "${1-}" ; then
-    ( set -x; "$@" ) || {
+    if ( set $_X; "$@" ) ; then
+      :
+    else
       ERR=$?
-      echo "jj-fzf: command exit_status=$ERR" >&2
-      $IGNORE ||
-	read -t 1 || :
-      $IGNORE && ERR=0
-    }
+      $IGNORE &&
+	ERR=0 || {
+	  echo "jj-fzf: command exit_status=$ERR" >&2
+	  read -t 1 || :	# pause
+	}
+    fi
   fi
   $NOLOAD || jjfzf_load_and_status
   exit $ERR