mirror of
https://github.com/facebook/sapling.git
synced 2024-10-09 16:31:02 +03:00
909411bb1c
Summary: Users get used to hints at the end of the output, not in a separate panel in streampager. Make it so. Reviewed By: andll Differential Revision: D29400532 fbshipit-source-id: 41dc5d20f44a315bc0235ca3cb7857ae8955d3ad
122 lines
3.6 KiB
Python
122 lines
3.6 KiB
Python
# Copyright (c) Facebook, Inc. and its affiliates.
|
|
#
|
|
# This software may be used and distributed according to the terms of the
|
|
# GNU General Public License version 2.
|
|
|
|
# hint.py - utilities to register hint messages
|
|
|
|
from __future__ import absolute_import
|
|
|
|
import os
|
|
|
|
from . import pycompat, rcutil, util
|
|
from .i18n import _
|
|
|
|
|
|
hinttable = {
|
|
"hgignore-deprecate": lambda path: (
|
|
(
|
|
"hgignore format is being deprecated. "
|
|
"Consider updating %s to gitignore format. "
|
|
"Check fburl.com/gitignore to learn more."
|
|
)
|
|
% path
|
|
),
|
|
"branch-command-deprecate": lambda: _(
|
|
"'hg branch' command does not do what you want, and is being removed. "
|
|
"It always prints 'default' for now. "
|
|
"Check fburl.com/why-no-named-branches for details."
|
|
),
|
|
"revnum-deprecate": lambda rev: _(
|
|
"Local revision numbers (ex. %s) are being deprecated and will stop working in the future. "
|
|
"Please use commit hashes instead."
|
|
)
|
|
% rev,
|
|
"metalog-root-override": lambda root: _(
|
|
"MetaLog root was overridden to %s by an environment variable. "
|
|
"This should only be used for debugging."
|
|
)
|
|
% root,
|
|
"old-version": lambda: _(
|
|
"WARNING! You are running an old version of Mercurial. Please upgrade your installation."
|
|
),
|
|
}
|
|
messages = []
|
|
triggered = set()
|
|
|
|
|
|
def loadhint(ui, extname, registrarobj):
|
|
for name, func in pycompat.iteritems(registrarobj._table):
|
|
hinttable[name] = func
|
|
|
|
|
|
def loadhintconfig(ui):
|
|
for name, message in ui.configitems("hint-definitions"):
|
|
hinttable[name] = lambda *args, **kwargs: message
|
|
|
|
|
|
def trigger(name, *args, **kwargs):
|
|
"""Trigger a hint message. It will be shown at the end of the command."""
|
|
func = hinttable.get(name)
|
|
if func and name not in triggered:
|
|
triggered.add(name)
|
|
msg = func(*args, **kwargs)
|
|
if msg:
|
|
messages.append((name, msg.rstrip()))
|
|
|
|
|
|
def show(ui):
|
|
"""Show all triggered hint messages"""
|
|
if ui.plain("hint"):
|
|
return
|
|
acked = ui.configlist("hint", "ack")
|
|
if acked == ["*"]:
|
|
|
|
def isacked(name):
|
|
return True
|
|
|
|
else:
|
|
acked = set(acked)
|
|
|
|
def isacked(name):
|
|
return name in acked or ui.configbool("hint", "ack-%s" % name)
|
|
|
|
names = []
|
|
if util.mainio.is_pager_active():
|
|
# For stream pager, people expect hints to be at the end, not in a
|
|
# separate panel. Make it so. When the pager is active, we know that the
|
|
# stdout is not being redirected to a file or pipe, so this won't affect
|
|
# automation reading stdout.
|
|
write = ui.write
|
|
else:
|
|
write = ui.write_err
|
|
for name, msg in messages:
|
|
if not isacked(name):
|
|
write("%s\n" % msg.rstrip(), notice=_("hint[%s]") % name)
|
|
names.append(name)
|
|
if names and not isacked("hint-ack"):
|
|
msg = _("use 'hg hint --ack %s' to silence these hints\n") % " ".join(names)
|
|
write(msg, notice=_("hint[%s]") % "hint-ack")
|
|
messages[:] = []
|
|
triggered.clear()
|
|
|
|
|
|
def silence(ui, names):
|
|
"""Silence given hints"""
|
|
paths = rcutil.userrcpath()
|
|
# In case there are multiple candidate paths, pick the one that exists.
|
|
# Otherwise, use the first one.
|
|
path = ([p for p in paths if os.path.exists(p)] + [paths[0]])[0]
|
|
acked = ui.configlist("hint", "ack")
|
|
for name in names:
|
|
if name not in acked:
|
|
acked.append(name)
|
|
value = " ".join(util.shellquote(w) for w in acked)
|
|
rcutil.editconfig(path, "hint", "ack", value)
|
|
|
|
|
|
def clear():
|
|
"""Clear all triggered hints"""
|
|
triggered.clear()
|
|
del messages[:]
|