paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-11 01:16:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

zulint: Add option to specify description of linter functions.

Browse Source 
Extract description of function from __doc__ if used as wrapper.
This commit is contained in:
Aman Agrawal
2019-06-21 23:23:22 +05:30
committed by Tim Abbott
parent e9ff9e34b3
commit e236d39ef1
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
tools/zulint/command.py
View File

@@ -71,6 +71,7 @@ def run_parallel(lint_functions):
class LinterConfig: class LinterConfig:
lint_functions = {} # type: Dict[str, Callable[[], int]] lint_functions = {} # type: Dict[str, Callable[[], int]]
lint_descriptions = {} # type: Dict[str, str]
def __init__(self, args): def __init__(self, args):
# type: (argparse.Namespace) -> None # type: (argparse.Namespace) -> None
@@ -94,9 +95,10 @@ class LinterConfig:
def lint(self, func): def lint(self, func):
# type: (Callable[[], int]) -> Callable[[], int] # type: (Callable[[], int]) -> Callable[[], int]
self.lint_functions[func.__name__] = func self.lint_functions[func.__name__] = func
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): def external_linter(self, name, command, target_langs=[], pass_targets=True, description="External Linter"):
# type: (str, List[str], List[str], bool) -> None # type: (str, List[str], List[str], bool) -> 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
@@ -105,6 +107,7 @@ class LinterConfig:
If target_langs is empty, just runs the linter unconditionally. If target_langs is empty, just runs the linter unconditionally.
""" """
self.lint_descriptions[name] = description
color = next(colors) color = next(colors)
def run_linter(): def run_linter():