mirror of
https://github.com/wesnoth/wesnoth
synced 2025-04-24 19:49:49 +00:00
49ebbb9709
Ensures that files either use tabs for indentation or spaces for indentation, but don't switch between the two within the same file. This doesn't fix the whitespace, it's a simple check to flag it up on the assumption that it's better to use an editor or code formatter to clean up the file. Elsewhere in the CI we use the luacheck tool - while that can detect mixing tabs and spaces in a single line's indent, it doesn't check for inconsistent indentation within a file.
63 lines
1.9 KiB
Python
Executable File
63 lines
1.9 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
# encoding: utf-8
|
|
"""
|
|
Flag an error if a single file uses both tabs and spaces for indenting.
|
|
|
|
This does not change files, on the assumption that the mess is better
|
|
handled with a text editor or a code reformatting tool.
|
|
"""
|
|
|
|
import argparse, re, sys
|
|
|
|
def check_indent(file):
|
|
has_tabs = False
|
|
with open(file, encoding="utf8") as lines:
|
|
for line in lines:
|
|
if re.match("\t", line):
|
|
has_tabs = True
|
|
break
|
|
|
|
if has_tabs:
|
|
lines.seek(0)
|
|
for line in lines:
|
|
if re.match(" ", line):
|
|
print("{file} uses both tabs and spaces for indents".format(file=file))
|
|
return False
|
|
|
|
# Only one type of indent appears at the start of each line, so this only needs to
|
|
# check one way round for mixtures on the same line.
|
|
if has_tabs:
|
|
mixed_line_re = re.compile("\t+ ")
|
|
else:
|
|
mixed_line_re = re.compile(" +\t")
|
|
lines.seek(0)
|
|
for line in lines:
|
|
if mixed_line_re.match(line):
|
|
print("{file} indents with tabs and spaces on the same line".format(file=file))
|
|
return False
|
|
|
|
return True
|
|
|
|
if __name__ == "__main__":
|
|
ap = argparse.ArgumentParser(usage=__doc__)
|
|
ap.add_argument("files", metavar="string", nargs="*", help="Read input from these files")
|
|
options = ap.parse_args()
|
|
|
|
all_files_ok = True
|
|
|
|
for file in options.files:
|
|
try:
|
|
if not check_indent(file):
|
|
all_files_ok = False
|
|
except UnicodeDecodeError:
|
|
all_files_ok = False
|
|
print("{file}: invalid utf-8".format(file=file))
|
|
except:
|
|
all_files_ok = False
|
|
print("{file}: raised exception {error}".format(file=file, error=sys.exc_info()[0]))
|
|
|
|
if not all_files_ok:
|
|
sys.exit(1)
|
|
|
|
sys.exit(0)
|