( )⚙ D2609 templater: provide hint for multi-line templates with parse errors

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D2609

templater: provide hint for multi-line templates with parse errors
ClosedPublic

Authored by ryanmce on Mar 3 2018, 5:26 PM.

Details

Reviewers
durin42
Group Reviewers
hg-reviewers
Commits
rHG44048f1bcee5: templater: provide hint for multi-line templates with parse errors
rHG5d1bae328b7d: templater: provide hint for multi-line templates with parse errors
Summary

Previously, we punted. Now we "rewrite" the template's newlines to r'\n' and
offset the hint appropriately.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Revision Contents
Changeset List

PathPackages
Mmercurial/templater.py (18 lines)
Mtests/test-parse-errors.t (3 lines)

Diff 6487

mercurial/templater.py

raise error.ParseError(_("invalid token"), pos) raise error.ParseError(_("invalid token"), pos)
yield ('template', parseres, n) yield ('template', parseres, n)
if quote: if quote:
raise error.ParseError(_("unterminated string"), start) raise error.ParseError(_("unterminated string"), start)
except error.ParseError as inst: except error.ParseError as inst:
if len(inst.args) > 1: # has location if len(inst.args) > 1: # has location
loc = inst.args[1] loc = inst.args[1]
# TODO: Opportunity for improvement! If there is a newline in the # Offset the caret location by the number of newlines before the
# template, this hint does not point to the right place, so skip. # location of the error, since we will replace one-char newlines
if '\n' not in tmpl: # with the two-char literal r'\n'.
offset = tmpl[:loc].count('\n')
tmpl = tmpl.replace('\n', r'\n')
# We want the caret to point to the place in the template that # We want the caret to point to the place in the template that
# failed to parse, but in a hint we get a open paren at the # failed to parse, but in a hint we get a open paren at the
# start. Therefore, we print "loc" spaces (instead of "loc - 1") # start. Therefore, we print "loc" spaces (instead of "loc - 1")
# to line up the caret with the location of the error. # to line up the caret with the location of the error.
inst.hint = tmpl + '\n' + ' ' * (loc) + '^ ' + _('here') inst.hint = tmpl + '\n' + ' ' * (loc + offset) + '^ ' + _('here')
raise raise
yield ('end', None, pos) yield ('end', None, pos)
def _unnesttemplatelist(tree): def _unnesttemplatelist(tree):
"""Expand list of templates to node tuple """Expand list of templates to node tuple
>>> def f(tree): >>> def f(tree):
... print(pycompat.sysstr(prettyformat(_unnesttemplatelist(tree)))) ... print(pycompat.sysstr(prettyformat(_unnesttemplatelist(tree))))

tests/test-parse-errors.t

[255] [255]
multi-line multi-line
$ hg log -r . -T 'line 1 $ hg log -r . -T 'line 1
> line2 > line2
> {shortest(node} > {shortest(node}
> line4\nline5' > line4\nline5'
hg: parse error at 28: unexpected token: end hg: parse error at 28: unexpected token: end
(line 1\nline2\n{shortest(node}\nline4
^ here)
[255] [255]