zulip/tools/lint

125 lines
4.6 KiB
Python
Executable File

#!/usr/bin/env python3
from __future__ import print_function
from __future__ import absolute_import
import os
import sys
import argparse
# check for the venv
from lib import sanity_check
sanity_check.check_venv(__file__)
from linter_lib.custom_check import python_rules, non_py_rules
from zulint import lister
from zulint.command import add_default_linter_arguments, LinterConfig
from typing import cast, Dict, List
import random
def run():
# type: () -> None
parser = argparse.ArgumentParser()
parser.add_argument('--force', default=False,
action="store_true",
help='Run tests despite possible problems.')
parser.add_argument('--full',
action='store_true',
help='Check some things we typically ignore')
limited_tests_group = parser.add_mutually_exclusive_group()
limited_tests_group.add_argument('--frontend',
action='store_true',
help='Only check files relevant to frontend')
limited_tests_group.add_argument('--backend',
action='store_true',
help='Only check files relevant to backend')
add_default_linter_arguments(parser)
args = parser.parse_args()
tools_dir = os.path.dirname(os.path.abspath(__file__))
root_dir = os.path.dirname(tools_dir)
sys.path.insert(0, root_dir)
from tools.linter_lib.exclude import EXCLUDED_FILES, PUPPET_CHECK_RULES_TO_EXCLUDE
from tools.linter_lib.pyflakes import check_pyflakes
from tools.linter_lib.pep8 import check_pep8
from tools.lib.test_script import (
assert_provisioning_status_ok,
)
os.chdir(root_dir)
assert_provisioning_status_ok(args.force)
backend_file_types = ['py', 'sh', 'pp', 'json', 'md', 'txt', 'text', 'yaml', 'rst']
frontend_file_types = ['js', 'ts', 'css', 'scss', 'handlebars', 'html']
file_types = backend_file_types + frontend_file_types
if args.backend:
file_types = backend_file_types
if args.frontend:
file_types = frontend_file_types
by_lang = cast(Dict[str, List[str]],
lister.list_files(args.targets, modified_only=args.modified,
ftypes=file_types,
use_shebang=True, group_by_ftype=True, exclude=EXCLUDED_FILES))
# Invoke the appropriate lint checker for each language,
# and also check files for extra whitespace.
linter_config = LinterConfig(args, by_lang)
linter_config.external_linter('add_class', ['tools/find-add-class'], ['js'])
linter_config.external_linter('css', ['node', 'node_modules/.bin/stylelint'], ['css', 'scss'])
linter_config.external_linter('eslint', ['node', 'node_modules/.bin/eslint',
'--quiet', '--cache', '--ext', '.js,.ts'], ['js', 'ts'])
linter_config.external_linter('puppet', ['puppet', 'parser', 'validate'], ['pp'])
linter_config.external_linter('puppet-lint',
['puppet-lint'] + PUPPET_CHECK_RULES_TO_EXCLUDE, ['pp'])
linter_config.external_linter('templates', ['tools/check-templates'], ['handlebars', 'html'])
linter_config.external_linter('swagger', ['node', 'tools/check-swagger'], ['yaml'])
linter_config.external_linter('shellcheck', ['shellcheck', '-x'], ['sh'])
command = ['tools/run-mypy']
if args.force:
command.append('--force')
linter_config.external_linter('mypy', command, ['py'], pass_targets=False)
linter_config.external_linter('gitlint', ['tools/commit-message-lint'])
@linter_config.lint
def custom_py():
# type: () -> int
failed = python_rules.check(by_lang)
return 1 if failed else 0
@linter_config.lint
def custom_nonpy():
# type: () -> int
failed = False
for rule in non_py_rules:
failed = failed or rule.check(by_lang)
return 1 if failed else 0
@linter_config.lint
def pyflakes():
# type: () -> int
failed = check_pyflakes(by_lang['py'], args)
return 1 if failed else 0
python_part1 = {x for x in by_lang['py'] if random.randint(0, 1) == 0}
python_part2 = {y for y in by_lang['py'] if y not in python_part1}
@linter_config.lint
def pep8_1of2():
# type: () -> int
failed = check_pep8(list(python_part1))
return 1 if failed else 0
@linter_config.lint
def pep8_2of2():
# type: () -> int
failed = check_pep8(list(python_part2))
return 1 if failed else 0
linter_config.do_lint()
if __name__ == '__main__':
run()