From dd10a5ebf2be29637f94f33260e5537b61faac5f Mon Sep 17 00:00:00 2001 From: "trop[bot]" <37223003+trop[bot]@users.noreply.github.com> Date: Thu, 9 Jun 2022 11:13:57 +0900 Subject: [PATCH] build: update clang-format script (#34479) * build: fix clang-format script * chore: remove python2 cases Co-authored-by: Shelley Vohr --- package.json | 5 ++- script/lint.js | 8 ++-- script/run-clang-format.py | 77 +++++++++++++++++++++++++------------- 3 files changed, 59 insertions(+), 31 deletions(-) diff --git a/package.json b/package.json index 2f2ba6fa35901..330146d31f80c 100644 --- a/package.json +++ b/package.json @@ -77,7 +77,7 @@ "scripts": { "asar": "asar", "generate-version-json": "node script/generate-version-json.js", - "lint": "node ./script/lint.js && npm run lint:clang-format && npm run lint:docs", + "lint": "node ./script/lint.js && npm run lint:docs", "lint:js": "node ./script/lint.js --js", "lint:clang-format": "python3 script/run-clang-format.py -r -c shell/ || (echo \"\\nCode not formatted correctly.\" && exit 1)", "lint:clang-tidy": "ts-node ./script/run-clang-tidy.ts", @@ -94,6 +94,7 @@ "gn-typescript-definitions": "npm run create-typescript-definitions && shx cp electron.d.ts", "pre-flight": "pre-flight", "gn-check": "node ./script/gn-check.js", + "gn-format": "python3 script/run-gn-format.py", "precommit": "lint-staged", "preinstall": "node -e 'process.exit(0)'", "prepack": "check-for-leaks", @@ -124,7 +125,7 @@ ], "*.{gn,gni}": [ "npm run gn-check", - "python3 script/run-gn-format.py" + "npm run gn-format" ], "*.py": [ "node script/lint.js --py --fix --only --" diff --git a/script/lint.js b/script/lint.js index e2735cee1a1c7..2047f02253d72 100755 --- a/script/lint.js +++ b/script/lint.js @@ -70,9 +70,9 @@ const LINTERS = [{ test: filename => filename.endsWith('.cc') || (filename.endsWith('.h') && !isObjCHeader(filename)), run: (opts, filenames) => { if (opts.fix) { - spawnAndCheckExitCode('python', ['script/run-clang-format.py', '--fix', ...filenames]); + spawnAndCheckExitCode('python3', ['script/run-clang-format.py', '-r', '--fix', ...filenames]); } else { - spawnAndCheckExitCode('python', ['script/run-clang-format.py', ...filenames]); + spawnAndCheckExitCode('python3', ['script/run-clang-format.py', '-r', ...filenames]); } cpplint(filenames); } @@ -82,9 +82,9 @@ const LINTERS = [{ test: filename => filename.endsWith('.mm') || (filename.endsWith('.h') && isObjCHeader(filename)), run: (opts, filenames) => { if (opts.fix) { - spawnAndCheckExitCode('python', ['script/run-clang-format.py', '--fix', ...filenames]); + spawnAndCheckExitCode('python3', ['script/run-clang-format.py', '-r', '--fix', ...filenames]); } else { - spawnAndCheckExitCode('python', ['script/run-clang-format.py', ...filenames]); + spawnAndCheckExitCode('python3', ['script/run-clang-format.py', '-r', ...filenames]); } const filter = [ '-readability/braces', diff --git a/script/run-clang-format.py b/script/run-clang-format.py index 33548391c23e1..345b504617697 100644 --- a/script/run-clang-format.py +++ b/script/run-clang-format.py @@ -1,6 +1,7 @@ #!/usr/bin/env python3 """A wrapper script around clang-format, suitable for linting multiple files and to use for continuous integration. + This is an alternative API for the clang-format command line. It runs over multiple files and directories in parallel. A diff output is produced and a sensible exit code is returned. @@ -11,6 +12,7 @@ import argparse import codecs import difflib +import errno import fnmatch import io import multiprocessing @@ -26,13 +28,28 @@ from lib.util import get_buildtools_executable DEFAULT_EXTENSIONS = 'c,h,C,H,cpp,hpp,cc,hh,c++,h++,cxx,hxx,mm' - +DEFAULT_CLANG_FORMAT_IGNORE = '.clang-format-ignore' class ExitStatus: SUCCESS = 0 DIFF = 1 TROUBLE = 2 +def excludes_from_file(ignore_file): + excludes = [] + try: + with io.open(ignore_file, 'r', encoding='utf-8') as f: + for line in f: + if line.startswith('#'): + continue + pattern = line.rstrip() + if not pattern: + continue + excludes.append(pattern) + except EnvironmentError as e: + if e.errno != errno.ENOENT: + raise + return excludes def list_files(files, recursive=False, extensions=None, exclude=None): if extensions is None: @@ -77,15 +94,13 @@ def make_diff(diff_file, original, reformatted): class DiffError(Exception): def __init__(self, message, errs=None): - # pylint: disable=R1725 - super(DiffError, self).__init__(message) + super().__init__(message) self.errs = errs or [] class UnexpectedError(Exception): def __init__(self, message, exc=None): - # pylint: disable=R1725 - super(UnexpectedError, self).__init__(message) + super().__init__(message) self.formatted_traceback = traceback.format_exc() self.exc = exc @@ -112,6 +127,11 @@ def run_clang_format_diff(args, file_name): invocation = [args.clang_format_executable, file_name] if args.fix: invocation.append('-i') + if args.style: + invocation.extend(['--style', args.style]) + if args.dry_run: + print(" ".join(invocation)) + return [], [] try: proc = subprocess.Popen( ' '.join(invocation), @@ -121,19 +141,13 @@ def run_clang_format_diff(args, file_name): shell=True) except OSError as exc: # pylint: disable=W0707 - raise DiffError(str(exc)) - proc_stdout = proc.stdout - proc_stderr = proc.stderr - if sys.version_info[0] == 3: - proc_stdout = proc_stdout.detach() - proc_stderr = proc_stderr.detach() - # make the pipes compatible with Python 3, - # reading lines should output unicode - encoding = 'utf-8' - proc_stdout = codecs.getreader(encoding)(proc_stdout) - proc_stderr = codecs.getreader(encoding)(proc_stderr) - outs = list(proc_stdout.readlines()) - errs = list(proc_stderr.readlines()) + raise DiffError( + "Command '{}' failed to start: {}".format( + subprocess.list2cmdline(invocation), exc + ) + ) + outs = list(proc.stdout.readlines()) + errs = list(proc.stderr.readlines()) proc.wait() if proc.returncode: raise DiffError("clang-format exited with status {}: '{}'".format( @@ -212,6 +226,11 @@ def main(): '--recursive', action='store_true', help='run recursively over directories') + parser.add_argument( + '-d', + '--dry-run', + action='store_true', + help='just print the list of files') parser.add_argument('files', metavar='file', nargs='+') parser.add_argument( '-q', @@ -242,6 +261,10 @@ def main(): default=[], help='exclude paths matching the given glob-like pattern(s)' ' from recursive search') + parser.add_argument( + '--style', + help='formatting style to apply ' + '(LLVM/Google/Chromium/Mozilla/WebKit)') args = parser.parse_args() @@ -269,13 +292,14 @@ def main(): parse_files = [] if args.changed: - popen = subprocess.Popen( - 'git diff --name-only --cached', + stdout = subprocess.Popen( + "git diff --name-only --cached", stdout=subprocess.PIPE, stderr=subprocess.STDOUT, - shell=True - ) - for line in popen.stdout: + shell=True, + universal_newlines=True + ).communicate()[0].split("\n") + for line in stdout: file_name = line.rstrip() # don't check deleted files if os.path.isfile(file_name): @@ -284,14 +308,17 @@ def main(): else: parse_files = args.files + excludes = excludes_from_file(DEFAULT_CLANG_FORMAT_IGNORE) + excludes.extend(args.exclude) + files = list_files( parse_files, recursive=args.recursive, - exclude=args.exclude, + exclude=excludes, extensions=args.extensions.split(',')) if not files: - return 0 + return ExitStatus.SUCCESS njobs = args.j if njobs == 0: