( )⚙ D9314 templates: define a {onelinesummary} keyword

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9314

templates: define a {onelinesummary} keyword
ClosedPublic

Authored by martinvonz on Nov 12 2020, 5:32 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHGf67741e8264b: templates: define a {onelinesummary} keyword
rHGdbc574726ea4: templates: define a {onelinesummary} keyword
Summary

It is sometimes useful to be able to use the configured
command-template.oneline-summary in higher-level templates. For
example, I would like to use it in an internal template that lists
commits in a "review unit" (kind of a pull request). This patch adds
support for that.

We may want to define a way of formatting a context using a
command-specific override (from
command-templates.oneline-summary.<command>), but that will have to
be a template function instead. I don't plan to do that, but I'm
mentioning it now in case reviewers would prefer that we usea no-arg
function (i.e. {onelinesummary()}) already today to prepare for
that.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

martinvonz created this revision.Nov 12 2020, 5:32 PM
martinvonz edited the summary of this revision. (Show Details)Nov 16 2020, 12:35 PM
martinvonz added a commit: rHGdbc574726ea4: templates: define a {onelinesummary} keyword.Nov 18 2020, 6:07 PM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHGdbc574726ea4: templates: define a {onelinesummary} keyword (authored by martinvonz). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/templatekw.py (13 lines)
Mtests/test-template-keywords.t (24 lines)

Diff 23552

mercurial/templatekw.py

def showobsolete(context, mapping): def showobsolete(context, mapping):
"""String. Whether the changeset is obsolete. (EXPERIMENTAL)""" """String. Whether the changeset is obsolete. (EXPERIMENTAL)"""
ctx = context.resource(mapping, b'ctx') ctx = context.resource(mapping, b'ctx')
if ctx.obsolete(): if ctx.obsolete():
return b'obsolete' return b'obsolete'
return b'' return b''
@templatekeyword(b'onelinesummary', requires={b'ui', b'ctx'})
def showonelinesummary(context, mapping):
"""String. A one-line summary for the ctx (not including trailing newline).
The default template be overridden in command-templates.oneline-summary."""
# Avoid cycle:
# mercurial.cmdutil -> mercurial.templatekw -> mercurial.cmdutil
from . import cmdutil
ui = context.resource(mapping, b'ui')
ctx = context.resource(mapping, b'ctx')
return cmdutil.format_changeset_summary(ui, ctx)
@templatekeyword(b'path', requires={b'fctx'}) @templatekeyword(b'path', requires={b'fctx'})
def showpath(context, mapping): def showpath(context, mapping):
"""String. Repository-absolute path of the current file. (EXPERIMENTAL)""" """String. Repository-absolute path of the current file. (EXPERIMENTAL)"""
fctx = context.resource(mapping, b'fctx') fctx = context.resource(mapping, b'fctx')
return fctx.path() return fctx.path()
@templatekeyword(b'peerurls', requires={b'repo'}) @templatekeyword(b'peerurls', requires={b'repo'})

tests/test-template-keywords.t

o 3 (public): 2 (public) -1 (public) o 3 (public): 2 (public) -1 (public)
| |
o 2 (public): 1 (public) -1 (public) o 2 (public): 1 (public) -1 (public)
| |
o 1 (public): 0 (public) -1 (public) o 1 (public): 0 (public) -1 (public)
| |
o 0 (public): -1 (public) -1 (public) o 0 (public): -1 (public) -1 (public)
Test {onelinesummary}
$ hg log -G -T '{onelinesummary}'
@ 8:95c24699272e tip "third"
|
o 7:29114dbae42b "second"
o 6:d41e714fe50d "merge"
|\
| o 5:13207e5a10d9 "new head"
| |
o | 4:bbe44766e73d "new branch"
|/
o 3:10e46f2dcbf4 "no user, no domain"
|
o 2:97054abb4ab8 "no person"
|
o 1:b608e9d1a3f0 "other 1"
|
o 0:1e4e1b8f71e0 "line 1"
$ hg log -T '{onelinesummary}' -r 0 \
> --config command-templates.oneline-summary='{rev} - {desc}'
0 - line 1 (no-eol)
Keys work: Keys work:
$ for key in author branch branches date desc file_adds file_dels file_mods \ $ for key in author branch branches date desc file_adds file_dels file_mods \
> file_copies file_copies_switch files \ > file_copies file_copies_switch files \
> manifest node parents rev tags diffstat extras \ > manifest node parents rev tags diffstat extras \
> p1rev p2rev p1node p2node user; do > p1rev p2rev p1node p2node user; do
> for mode in '' --verbose --debug; do > for mode in '' --verbose --debug; do