show: new extension for displaying various repository data Currently, Mercurial has a number of commands to show information. And, there are features coming down the pipe that will introduce more commands for showing information. Currently, when introducing a new class of data or a view that we wish to expose to the user, the strategy is to introduce a new command or overload an existing command, sometimes both. For example, there is a desire to formalize the wip/smartlog/underway/mine functionality that many have devised. There is also a desire to introduce a "topics" concept. Others would like views of "the current stack." In the current model, we'd need a new command for wip/smartlog/etc (that behaves a lot like a pre-defined alias of `hg log`). For topics, we'd likely overload `hg topic[s]` to both display and manipulate topics. Adding new commands for every pre-defined query doesn't scale well and pollutes `hg help`. Overloading commands to perform read-only and write operations is arguably an UX anti-pattern: while having all functionality for a given concept in one command is nice, having a single command doing multiple discrete operations is not. Furthermore, a user may be surprised that a command they thought was read-only actually changes something. We discussed this at the Mercurial 4.0 Sprint in Paris and decided that having a single command where we could hang pre-defined views of various data would be a good idea. Having such a command would: * Help prevent an explosion of new query-related commands * Create a clear separation between read and write operations (mitigates footguns) * Avoids overloading the meaning of commands that manipulate data (bookmark, tag, branch, etc) (while we can't take away the existing behavior for BC reasons, we now won't introduce this behavior on new commands) * Allows users to discover informational views more easily by aggregating them in a single location * Lowers the barrier to creating the new views (since the barrier to creating a top-level command is relatively high) So, this commit introduces the `hg show` command via the "show" extension. This command accepts a positional argument of the "view" to show. New views can be registered with a decorator. To prove it works, we implement the "bookmarks" view, which shows a table of bookmarks and their associated nodes. We introduce a new style to hold everything used by `hg show`. For our initial bookmarks view, the output varies from `hg bookmarks`: * Padding is performed in the template itself as opposed to Python * Revision integers are not shown * shortest() is used to display a 5 character node by default (as opposed to static 12 characters) I chose to implement the "bookmarks" view first because it is simple and shouldn't invite too much bikeshedding that detracts from the evaluation of `hg show` itself. But there is an important point to consider: we now have 2 ways to show a list of bookmarks. I'm not a fan of introducing multiple ways to do very similar things. So it might be worth discussing how we wish to tackle this issue for bookmarks, tags, branches, MQ series, etc. I also made the choice of explicitly declaring the default show template not part of the standard BC guarantees. History has shown that we make mistakes and poor choices with output formatting but can't fix these mistakes later because random tools are parsing output and we don't want to break these tools. Optimizing for human consumption is one of my goals for `hg show`. So, by not covering the formatting as part of BC, the barrier to future change is much lower and humans benefit. There are some improvements that can be made to formatting. For example, we don't yet use label() in the templates. We obviously want this for color. But I'm not sure if we should reuse the existing log.* labels or invent new ones. I figure we can punt that to a follow-up. At the aforementioned Sprint, we discussed and discarded various alternatives to `hg show`. We considered making `hg log <view>` perform this behavior. The main reason we can't do this is because a positional argument to `hg log` can be a file path and if there is a conflict between a path name and a view name, behavior is ambiguous. We could have introduced `hg log --view` or similar, but we felt that required too much typing (we don't want to require a command flag to show a view) and wasn't very discoverable. Furthermore, `hg log` is optimized for showing changelog data and there are things that `hg display` could display that aren't changelog centric. There were concerns about using "show" as the command name. Some users already have a "show" alias that is similar to `hg export`. There were also concerns that Git users adapted to `git show` would be confused by `hg show`'s different behavior. The main difference here is `git show` prints an `hg export` like view of the current commit by default and `hg show` requires an argument. `git show` can also display any Git object. `git show` does not support displaying more complex views: just single objects. If we implemented `hg show <hash>` or `hg show <identifier>`, `hg show` would be a superset of `git show`. Although, I'm hesitant to do that at this time because I view `hg show` as a higher-level querying command and there are namespace collisions between valid identifiers and registered views. There is also a prefix collision with `hg showconfig`, which is an alias of `hg config`. We also considered `hg view`, but that is already used by the "hgk" extension. `hg display` was also proposed at one point. It has a prefix collision with `hg diff`. General consensus was "show" or "view" are the best verbs. And since "view" was taken, "show" was chosen. There are a number of inline TODOs in this patch. Some of these represent decisions yet to be made. Others represent features requiring non-trivial complexity. Rather than bloat the patch or invite additional bikeshedding, I figured I'd document future enhancements via TODO so we can get a minimal implmentation landed. Something is better than nothing.

     1

  $ cat >> $HGRCPATH << EOF

     2

  > [extensions]

     3

  > show =

     4

  > EOF

     5

     6

No arguments shows available views

     7

     8

  $ hg init empty

     9

  $ cd empty

    10

  $ hg show

    11

  available views:

    12

    13

  bookmarks -- bookmarks and their associated changeset

    14

    15

  abort: no view requested

    16

  (use "hg show VIEW" to choose a view)

    17

  [255]

    18

    19

`hg help show` prints available views

    20

    21

  $ hg help show

    22

  hg show VIEW

    23

    24

  show various repository information

    25

    26

      A requested view of repository data is displayed.

    27

    28

      If no view is requested, the list of available views is shown and the

    29

      command aborts.

    30

    31

      Note:

    32

         There are no backwards compatibility guarantees for the output of this

    33

         command. Output may change in any future Mercurial release.

    34

    35

         Consumers wanting stable command output should specify a template via

    36

         "-T/--template".

    37

    38

      List of available views:

    39

    40

       bookmarks   bookmarks and their associated changeset

    41

    42

  (use 'hg help -e show' to show help for the show extension)

    43

    44

  options:

    45

    46

  (some details hidden, use --verbose to show complete help)

    47

    48

Unknown view prints error

    49

    50

  $ hg show badview

    51

  abort: unknown view: badview

    52

  (run "hg show" to see available views)

    53

  [255]

    54

    55

HGPLAIN results in abort

    56

    57

  $ HGPLAIN=1 hg show bookmarks

    58

  abort: "hg show" cannot be used in plain mode because output is not stable

    59

  (unset HGPLAIN and invoke with -T/--template to control output)

    60

  [255]

    61

    62

But not if a template is specified

    63

    64

  $ HGPLAIN=1 hg show bookmarks -T '{bookmark}\n'

    65

  (no bookmarks set)

    66

    67

  $ cd ..

    68

    69

bookmarks view with no bookmarks prints empty message

    70

    71

  $ hg init books

    72

  $ cd books

    73

  $ touch f0

    74

  $ hg -q commit -A -m initial

    75

    76

  $ hg show bookmarks

    77

  (no bookmarks set)

    78

    79

bookmarks view shows bookmarks in an aligned table

    80

    81

  $ echo book1 > f0

    82

  $ hg commit -m 'commit for book1'

    83

  $ echo book2 > f0

    84

  $ hg commit -m 'commit for book2'

    85

    86

  $ hg bookmark -r 1 book1

    87

  $ hg bookmark a-longer-bookmark

    88

    89

  $ hg show bookmarks

    90

  * a-longer-bookmark    7b570

    91

    book1                b757f

    92

    93

A custom bookmarks template works

    94

    95

  $ hg show bookmarks -T '{node} {bookmark} {active}\n'

    96

  7b5709ab64cbc34da9b4367b64afff47f2c4ee83 a-longer-bookmark True

    97

  b757f780b8ffd71267c6ccb32e0882d9d32a8cc0 book1 False

    98

    99

bookmarks JSON works

   100

   101

  $ hg show bookmarks -T json

   102

  [

   103

   {

   104

    "active": true,

   105

    "bookmark": "a-longer-bookmark",

   106

    "longestbookmarklen": 17,

   107

    "node": "7b5709ab64cbc34da9b4367b64afff47f2c4ee83"

   108

   },

   109

   {

   110

    "active": false,

   111

    "bookmark": "book1",

   112

    "longestbookmarklen": 17,

   113

    "node": "b757f780b8ffd71267c6ccb32e0882d9d32a8cc0"

   114

   }

   115

  ]

   116

   117

  $ cd ..