This is an archive of the discontinued Mercurial Phabricator instance.

Differential D1532

color: respect HGPLAINEXCEPT=color to allow colors while scripting (issue5749)
ClosedPublic

Authored by durin42 on Nov 28 2017, 1:28 PM.

Details

Reviewers
yuja
Group Reviewers
hg-reviewers
Commits
rHGd4805a5e7e70: color: respect HGPLAINEXCEPT=color to allow colors while scripting (issue5749)
Summary

I'd also like --color=always on the command-line to override HGPLAIN=1
et al, but that's more work, and this seems like a better fix. We've
got a fair number of programs that actually want to automate hg and
get colored output to users, so they should set HGPLAINEXCEPT=alias
(what we usually recommend), but this has been breaking them because
they then lose color.

.. feature::

The ``HGPLAINEXCEPT`` environment variable can now include ``color``
to allow automatic output colorization in otherwise automated
environments.

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

durin42 created this revision.Nov 28 2017, 1:28 PM
durin42 retitled this revision from color: respect HGPLAINEXCEPT=color to allow colors in otherwise-plain settings to color: respect HGPLAINEXCEPT=color to allow colors while scripting (issue5749).Nov 28 2017, 1:29 PM
xalep added a subscriber: xalep.Nov 29 2017, 3:35 AM

You could also add color to the list of values described for HGPLAINEXCEPT in mercurial/help/environment.txt

durin42 updated this revision to Diff 4018.Nov 30 2017, 4:26 PM
durin42 added a comment.Nov 30 2017, 4:26 PM
In D1532#26006, @xalep wrote:

You could also add color to the list of values described for HGPLAINEXCEPT in mercurial/help/environment.txt

Nice catch, thanks!

yuja accepted this revision.Dec 1 2017, 8:24 AM
This revision is now accepted and ready to land.Dec 1 2017, 8:24 AM
Closed by commit rHGd4805a5e7e70: color: respect HGPLAINEXCEPT=color to allow colors while scripting (issue5749) (authored by durin42). · Explain WhyDec 1 2017, 9:01 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 4046

mercurial/color.py

That function both set the colormode for the ui object and read That function both set the colormode for the ui object and read
the configuration looking for custom colors and effect definitions.""" the configuration looking for custom colors and effect definitions."""
mode = _modesetup(ui) mode = _modesetup(ui)
ui._colormode = mode ui._colormode = mode
if mode and mode != 'debug': if mode and mode != 'debug':
configstyles(ui) configstyles(ui)
def _modesetup(ui): def _modesetup(ui):
if ui.plain(): if ui.plain('color'):
return None return None
config = ui.config('ui', 'color') config = ui.config('ui', 'color')
if config == 'debug': if config == 'debug':
return 'debug' return 'debug'
auto = (config == 'auto') auto = (config == 'auto')
always = False always = False
if not auto and util.parsebool(config): if not auto and util.parsebool(config):

mercurial/help/environment.txt

variables are not overridden. variables are not overridden.
HGPLAINEXCEPT HGPLAINEXCEPT
This is a comma-separated list of features to preserve when This is a comma-separated list of features to preserve when
HGPLAIN is enabled. Currently the following values are supported: HGPLAIN is enabled. Currently the following values are supported:
``alias`` ``alias``
Don't remove aliases. Don't remove aliases.
``color``
Don't disable colored output.
``i18n`` ``i18n``
Preserve internationalization. Preserve internationalization.
``revsetalias`` ``revsetalias``
Don't remove revset aliases. Don't remove revset aliases.
``templatealias`` ``templatealias``
Don't remove template aliases. Don't remove template aliases.
``progress`` ``progress``
Don't hide progress output. Don't hide progress output.

tests/test-status-color.t

$ hg status --color=debug $ hg status --color=debug
[status.unknown|? ][status.unknown|a/1/in_a_1] [status.unknown|? ][status.unknown|a/1/in_a_1]
[status.unknown|? ][status.unknown|a/in_a] [status.unknown|? ][status.unknown|a/in_a]
[status.unknown|? ][status.unknown|b/1/in_b_1] [status.unknown|? ][status.unknown|b/1/in_b_1]
[status.unknown|? ][status.unknown|b/2/in_b_2] [status.unknown|? ][status.unknown|b/2/in_b_2]
[status.unknown|? ][status.unknown|b/in_b] [status.unknown|? ][status.unknown|b/in_b]
[status.unknown|? ][status.unknown|in_root] [status.unknown|? ][status.unknown|in_root]
HGPLAIN disables color
$ HGPLAIN=1 hg status --color=debug
? a/1/in_a_1
? a/in_a
? b/1/in_b_1
? b/2/in_b_2
? b/in_b
? in_root
HGPLAINEXCEPT=color does not disable color
$ HGPLAINEXCEPT=color hg status --color=debug
[status.unknown|? ][status.unknown|a/1/in_a_1]
[status.unknown|? ][status.unknown|a/in_a]
[status.unknown|? ][status.unknown|b/1/in_b_1]
[status.unknown|? ][status.unknown|b/2/in_b_2]
[status.unknown|? ][status.unknown|b/in_b]
[status.unknown|? ][status.unknown|in_root]
hg status with template hg status with template
$ hg status -T "{label('red', path)}\n" --color=debug $ hg status -T "{label('red', path)}\n" --color=debug
[red|a/1/in_a_1] [red|a/1/in_a_1]
[red|a/in_a] [red|a/in_a]
[red|b/1/in_b_1] [red|b/1/in_b_1]
[red|b/2/in_b_2] [red|b/2/in_b_2]
[red|b/in_b] [red|b/in_b]