annotate contrib/editmerge @ 44717:3dc6a70779f2

phabricator: add an option to fold several commits into one review (issue6244)

Now that all of the pieces are in place, alter the user facing command to allow
it.  This is the default behavior when using `arc`, but I much prefer the 1:1
approach, and I'm tempted to mark this advanced to limit its abuse.  I started
out calling this `--no-stack` like the feature request suggested, but I found it
less obvious (especially when writing the code), so I went with the `hg fold`
analogue.

This will populate the `Commits` tab in the web UI with the hash of each commit
folded into the review.  From experimentation, it seems to list them in the
order they are received from the extension instead of the actual parent/child
relationship.  The extension sends them in sorted order, thanks to
`templatefilters.json()`.  Since there's enough info there for them to put
things in the right order, JSON is unordered aside from lists (IIUC), and there
doesn't seem to be any harmful side effects, I guess we write this off as their
bug.  It is simple enough to workaround by putting a check for `util.sortdict`
into `templatefilters.json()`, and don't resort in that case.

There are a handful of restrictions that are documented in the code, which
somebody could probably fix if they're interested.  Notably, this requires the
(default) `--amend` option, because there's not an easy way to apply a local tag
across several commits.  This also doesn't do preflight checking to ensure that
all previous commits that were part of a single review are selected when
updating.  That seems expensive.  What happens is the excluded commit is dropped
from the review, but it keeps the Differential Revision line in the commit
message.  Not everything can be edited, so it doesn't seem worth making the code
even more complicated to handle this edge case.

There are a couple of "obsolete feature not enabled but X markers found!"
messages that appeared on Windows but not macOS.  I have no idea what's going on
here, but that's an unrelated issue, so I conditionalized those lines.

Differential Revision: https://phab.mercurial-scm.org/D8314

#!/usr/bin/env bash
# A simple script for opening merge conflicts in the editor.
# Use the following Mercurial settings to enable it.
#
# [ui]
# merge = editmerge
#
# [merge-tools]
# editmerge.args=$output
# editmerge.check=changed
# editmerge.premerge=keep

FILE="$1"

getlines() {
  grep -n "^<<<<<<" "$FILE" | cut -f1 -d:
}

# editor preference loosely based on https://mercurial-scm.org/wiki/editor
# hg showconfig is at the bottom though, since it's slow to run (0.15 seconds)
ED="$HGEDITOR"
if [ "$ED" = "" ] ; then
  ED="$VISUAL"
fi
if [ "$ED" = "" ] ; then
  ED="$EDITOR"
fi
if [ "$ED" = "" ] ; then
  ED="$(hg showconfig ui.editor)"
fi
if [ "$ED" = "" ] ; then
  echo "merge failed - unable to find editor"
  exit 1
fi

if [ "$ED" = "emacs" ] || [ "$ED" = "nano" ] || [ "$ED" = "vim" ] ; then
  FIRSTLINE="$(getlines | head -n 1)"
  PREVIOUSLINE=""

  # open the editor to the first conflict until there are no more
  # or the user stops editing the file
  while [ ! "$FIRSTLINE" = "" ] && [ ! "$FIRSTLINE" = "$PREVIOUSLINE" ] ; do
    $ED "+$FIRSTLINE" "$FILE"
    PREVIOUSLINE="$FIRSTLINE"
    FIRSTLINE="$(getlines | head -n 1)"
  done
else
  $ED "$FILE"
fi

# get the line numbers of the remaining conflicts
CONFLICTS="$(getlines | sed ':a;N;$!ba;s/\n/, /g')"
if [ ! "$CONFLICTS" = "" ] ; then
  echo "merge failed - resolve the conflicts (line $CONFLICTS) then use 'hg resolve --mark'"
  exit 1
fi

exit 0