paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-04 22:13:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

linter: Add custom shebang rules section.

Browse Source 
Tweaked by tabbott for clarity and to use print_err.
This commit is contained in:
derAnfaenger
2017-10-12 18:40:45 +02:00
committed by Tim Abbott
parent 7deb698e02
commit e1660462e1
1 changed files with 20 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
tools/linter_lib/custom_check.py
View File

@@ -82,6 +82,10 @@ def custom_check_file(fn, identifier, rules, color, skip_rules=None, max_length=
if exclude_lines:
print('Please remove exclusions for file %s: %s' % (fn, exclude_lines))
# TODO: Move the below into more of a framework.
firstline = None
if line_tups:
firstline = line_tups[0][3] # line_fully_stripped for the first line.
lastLine = None
for (i, line, line_newline_stripped, line_fully_stripped) in line_tups:
if isinstance(line, bytes):
@@ -97,6 +101,22 @@ def custom_check_file(fn, identifier, rules, color, skip_rules=None, max_length=
failed = True
lastLine = line
if firstline:
if os.path.splitext(fn)[1] and 'zerver/' in fn:
shebang_rules = [{'pattern': '^#!',
'description': "zerver library code shouldn't have a shebang line."}]
else:
shebang_rules = [{'pattern': '#!/usr/bin/python',
'description': "Use `#!/usr/bin/env python3` instead of `#!/usr/bin/python`"},
{'pattern': '#!/usr/bin/env python$',
'description': "Use `#!/usr/bin/env python3` instead of `#!/usr/bin/env python`."}]
for rule in shebang_rules:
if re.search(rule['pattern'], firstline):
print_err(identifier, color,
'{} at {} line 1:'.format(rule['description'], fn))
print_err(identifier, color, firstline)
failed = True
if lastLine and ('\n' not in lastLine):
print("No newline at the end of file. Fix with `sed -i '$a\\' %s`" % (fn,))
failed = True
@@ -366,14 +386,6 @@ def build_custom_checkers(by_lang):
'description': "Logger.warn is a deprecated alias for Logger.warning; Use 'warning' instead of 'warn'.",
'good_lines': ["logging.warning('I am a warning.')", "logger.warning('warning')"],
'bad_lines': ["logging.warn('I am a warning.')", "logger.warn('warning')"]},
{'pattern': '#!/usr/bin/python',
'description': "Use `#!/usr/bin/env python3` instead of `#!/usr/bin/python`",
'good_lines': ['#!/usr/bin/env python3'],
'bad_lines': ['#!/usr/bin/python', '#!/usr/bin/python3']},
{'pattern': '#!/usr/bin/env python$',
'description': "Use `#!/usr/bin/env python3` instead of `#!/usr/bin/env python`.",
'good_lines': ["#!/usr/bin/env python3"],
'bad_lines': ["#!/usr/bin/env python"]},
{'pattern': '\.pk',
'exclude_pattern': '[.]_meta[.]pk',
'description': "Use `id` instead of `pk`.",