Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

zulint: Print description of linter with it in `--list`.

This commit is contained in:
Aman Agrawal 2019-06-21 23:59:56 +05:30 committed by Tim Abbott
parent e236d39ef1
commit 6d42b2392b
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
tools/zulint/command.py
View File

@ -13,7 +13,7 @@ if False:
# See https://zulip.readthedocs.io/en/latest/testing/mypy.html#mypy-in-production-scripts # See https://zulip.readthedocs.io/en/latest/testing/mypy.html#mypy-in-production-scripts
from typing import Callable, Dict, List from typing import Callable, Dict, List
from zulint.printer import print_err, colors from zulint.printer import print_err, colors, BOLDRED, BLUE, GREEN, ENDC
from zulint import lister from zulint import lister
def add_default_linter_arguments(parser): def add_default_linter_arguments(parser):
@ -98,8 +98,9 @@ class LinterConfig:
self.lint_descriptions[func.__name__] = func.__doc__ if func.__doc__ else "External Linter" self.lint_descriptions[func.__name__] = func.__doc__ if func.__doc__ else "External Linter"
return func return func
def external_linter(self, name, command, target_langs=[], pass_targets=True, description="External Linter"): def external_linter(self, name, command, target_langs=[], pass_targets=True,
# type: (str, List[str], List[str], bool) -> None description="External Linter"):
# type: (str, List[str], List[str], bool, str) -> None
"""Registers an external linter program to be run as part of the """Registers an external linter program to be run as part of the
linter. This program will be passed the subset of files being linter. This program will be passed the subset of files being
linted that have extensions in target_langs. If there are no linted that have extensions in target_langs. If there are no
@ -155,7 +156,9 @@ class LinterConfig:
for linter in self.args.skip: for linter in self.args.skip:
del self.lint_functions[linter] del self.lint_functions[linter]
if self.args.list: if self.args.list:
print("\n".join(self.lint_functions.keys())) print("{}{:<15} {} {}".format(BOLDRED, 'Linter', 'Description', ENDC))
for linter, desc in self.lint_descriptions.items():
print("{}{:<15} {}{}".format(BLUE, linter, GREEN, desc, ENDC))
sys.exit() sys.exit()
self.set_logger() self.set_logger()