check-idl-files.py 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. #!/usr/bin/env python3
  2. import argparse
  3. import os
  4. import pathlib
  5. import re
  6. import subprocess
  7. import sys
  8. script_name = pathlib.Path(__file__).resolve().name
  9. lines_to_skip = re.compile(
  10. r"^($| *//|\};|#import |.+ includes .+|\[[^\]]+\]"
  11. r"|interface |dictionary |enum |namespace |typedef |callback )"
  12. )
  13. parser = argparse.ArgumentParser()
  14. parser.add_argument("--overwrite-inplace", action=argparse.BooleanOptionalAction)
  15. parser.add_argument('filenames', nargs='*')
  16. args = parser.parse_args()
  17. def find_files_here_or_argv():
  18. if args.filenames:
  19. raw_list = args.filenames
  20. else:
  21. process = subprocess.run(["git", "ls-files"], check=True, capture_output=True)
  22. raw_list = process.stdout.decode().strip("\n").split("\n")
  23. return filter(lambda filename: filename.endswith(".idl"), raw_list)
  24. def run():
  25. """Lint WebIDL files checked into git for four leading spaces on each line."""
  26. files_without_four_leading_spaces = set()
  27. did_fail = False
  28. for filename in find_files_here_or_argv():
  29. lines = []
  30. with open(filename, "r") as f:
  31. for line_number, line in enumerate(f, start=1):
  32. if lines_to_skip.match(line):
  33. lines.append(line)
  34. continue
  35. if not line.startswith(" "):
  36. if args.overwrite_inplace:
  37. line = " " + line.lstrip()
  38. lines.append(line)
  39. continue
  40. did_fail = True
  41. files_without_four_leading_spaces.add(filename)
  42. print(
  43. f"{filename}:{line_number} error: Line does not start with four spaces:{line.rstrip()}")
  44. lines.append(line)
  45. if args.overwrite_inplace:
  46. with open(filename, "w") as f:
  47. f.writelines(lines)
  48. if files_without_four_leading_spaces:
  49. print("\nWebIDL files that have lines without four leading spaces:",
  50. " ".join(files_without_four_leading_spaces))
  51. if not args.overwrite_inplace:
  52. print(
  53. f"\nTo fix the WebIDL files in place, run: ./Meta/{script_name} --overwrite-inplace")
  54. if did_fail:
  55. sys.exit(1)
  56. if __name__ == "__main__":
  57. os.chdir(os.path.dirname(__file__) + "/..")
  58. run()