Skip to content
Navigation Menu
{{ message }}
forked from signalapp/Signal-iOS
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathprecommit.py
More file actions
executable file
·389 lines (316 loc) · 11.1 KB
/
Copy pathprecommit.py
File metadata and controls
executable file
·389 lines (316 loc) · 11.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
#!/usr/bin/env python3
import os
import sys
import subprocess
import argparse
from typing import Iterable
from pathlib import Path
from lint.util import EXTENSIONS_TO_CHECK
git_repo_path = os.path.abspath(
subprocess.check_output(["git", "rev-parse", "--show-toplevel"], text=True).strip()
)
def sort_forward_decl_statement_block(text, filepath, filename, file_extension):
lines = text.split("\n")
lines = [line.strip() for line in lines if line.strip()]
lines = list(set(lines))
lines.sort()
return "\n" + "\n".join(lines) + "\n"
def find_matching_section(text, match_test):
lines = text.split("\n")
first_matching_line_index = None
for index, line in enumerate(lines):
if match_test(line):
first_matching_line_index = index
break
if first_matching_line_index is None:
return None
# Absorb any leading empty lines.
while first_matching_line_index > 0:
prev_line = lines[first_matching_line_index - 1]
if prev_line.strip():
break
first_matching_line_index = first_matching_line_index - 1
first_non_matching_line_index = None
for index, line in enumerate(lines[first_matching_line_index:]):
if not line.strip():
# Absorb any trailing empty lines.
continue
if not match_test(line):
first_non_matching_line_index = index + first_matching_line_index
break
text0 = "\n".join(lines[:first_matching_line_index])
if first_non_matching_line_index is None:
text1 = "\n".join(lines[first_matching_line_index:])
text2 = None
else:
text1 = "\n".join(
lines[first_matching_line_index:first_non_matching_line_index]
)
text2 = "\n".join(lines[first_non_matching_line_index:])
return text0, text1, text2
def sort_matching_blocks(
sort_name, filepath, filename, file_extension, text, match_func, sort_func
):
unprocessed = text
processed = None
while True:
section = find_matching_section(unprocessed, match_func)
# print '\t', 'sort_matching_blocks', section
if not section:
if processed:
processed = "\n".join(
(
processed,
unprocessed,
)
)
else:
processed = unprocessed
break
text0, text1, text2 = section
if processed:
processed = "\n".join(
(
processed,
text0,
)
)
else:
processed = text0
# print 'before:'
# temp_lines = text1.split('\n')
# for index, line in enumerate(temp_lines):
# if index < 3 or index + 3 >= len(temp_lines):
# print '\t', index, line
# # print text1
# print
text1 = sort_func(text1, filepath, filename, file_extension)
# print 'after:'
# # print text1
# temp_lines = text1.split('\n')
# for index, line in enumerate(temp_lines):
# if index < 3 or index + 3 >= len(temp_lines):
# print '\t', index, line
# print
processed = "\n".join(
(
processed,
text1,
)
)
if text2:
unprocessed = text2
else:
break
if text != processed:
print(sort_name, filepath)
return processed
def find_forward_class_statement_section(text):
def is_forward_class_statement(line):
return line.strip().startswith("@class ")
return find_matching_section(text, is_forward_class_statement)
def find_forward_protocol_statement_section(text):
def is_forward_protocol_statement(line):
return line.strip().startswith("@protocol ") and line.strip().endswith(";")
return find_matching_section(text, is_forward_protocol_statement)
def sort_forward_class_statements(filepath, filename, file_extension, text):
# print 'sort_class_statements', filepath
if file_extension not in (".h", ".m", ".mm"):
return text
return sort_matching_blocks(
"sort_class_statements",
filepath,
filename,
file_extension,
text,
find_forward_class_statement_section,
sort_forward_decl_statement_block,
)
def sort_forward_protocol_statements(filepath, filename, file_extension, text):
# print 'sort_class_statements', filepath
if file_extension not in (".h", ".m", ".mm"):
return text
return sort_matching_blocks(
"sort_forward_protocol_statements",
filepath,
filename,
file_extension,
text,
find_forward_protocol_statement_section,
sort_forward_decl_statement_block,
)
def get_ext(file: str) -> str:
return os.path.splitext(file)[1]
def process(filepath):
short_filepath = filepath[len(git_repo_path) :]
if short_filepath.startswith(os.sep):
short_filepath = short_filepath[len(os.sep) :]
filename = os.path.basename(filepath)
if filename.startswith("."):
raise Exception("shouldn't call process with dotfile")
file_ext = get_ext(filename)
with open(filepath, "rt") as f:
text = f.read()
original_text = text
text = sort_forward_class_statements(filepath, filename, file_ext, text)
text = sort_forward_protocol_statements(filepath, filename, file_ext, text)
text = text.strip() + "\n"
if original_text == text:
return
print("Updating:", short_filepath)
with open(filepath, "wt") as f:
f.write(text)
def get_file_paths_in(path: str) -> Iterable[str]:
for rootdir, _, filenames in os.walk(path):
for filename in filenames:
yield os.path.abspath(os.path.join(rootdir, filename))
def get_file_paths_for_commands(commands: Iterable[list[str]]) -> Iterable[str]:
for command in commands:
lines = subprocess.check_output(command, text=True).split("\n")
for line in lines:
file_path = os.path.abspath(os.path.join(git_repo_path, line))
if os.path.exists(file_path):
yield file_path
def should_process_file(file_path: str) -> bool:
if get_ext(file_path) not in EXTENSIONS_TO_CHECK:
return False
for component in Path(file_path).parts:
if component.startswith("."):
return False
if component.endswith(".framework"):
return False
if component in (
"Pods",
"ThirdParty",
"Carthage",
):
return False
return True
def lint_swift_files(file_paths: set[str]) -> bool:
swift_file_paths = list(filter(lambda f: get_ext(f) == ".swift", file_paths))
file_count = len(swift_file_paths)
if file_count < 1:
return True
env = os.environ.copy()
env["SCRIPT_INPUT_FILE_COUNT"] = str(file_count)
for i, file_path in enumerate(swift_file_paths):
env[f"SCRIPT_INPUT_FILE_{i}"] = file_path
subprocess.run(
["swiftlint", "lint", "--fix", "--use-script-input-files"],
env=env,
)
proc = subprocess.run(
["swiftlint", "lint", "--strict", "--use-script-input-files"],
env=env,
)
return proc.returncode == 0
def check_diff_for_keywords():
objc_keywords = [
"OWSAbstractMethod\(",
"OWSAssert\(",
"OWSCAssert\(",
"OWSFail\(",
"OWSCFail\(",
"ows_add_overflow\(",
"ows_sub_overflow\(",
]
swift_keywords = [
"owsFail\(",
"precondition\(",
"fatalError\(",
"dispatchPrecondition\(",
"preconditionFailure\(",
"notImplemented\(",
]
keywords = objc_keywords + swift_keywords
matching_expression = "|".join(keywords)
command_line = (
'git diff --staged | grep --color=always -C 3 -E "%s"' % matching_expression
)
try:
output = subprocess.check_output(command_line, shell=True, text=True)
except subprocess.CalledProcessError as e:
# > man grep
# EXIT STATUS
# The grep utility exits with one of the following values:
# 0 One or more lines were selected.
# 1 No lines were selected.
# >1 An error occurred.
if e.returncode == 1:
# no keywords in diff output
return
else:
# some other error - bad grep expression?
raise e
if len(output) > 0:
print("⚠️ keywords detected in diff:")
print(output)
if __name__ == "__main__":
parser = argparse.ArgumentParser(description="Precommit script.")
parser.add_argument(
"--all", action="store_true", help="process all files in or below current dir"
)
parser.add_argument("--path", help="used to specify a path to process.")
parser.add_argument(
"--ref", help="process all files that have changed since the given ref"
)
parser.add_argument(
"--skip_license_header_checks",
action="store_true",
help="A temporary flag that will skip license header checks. We plan to remove this flag soon.",
)
args = parser.parse_args()
all_file_paths: Iterable[str] = []
clang_format_commit = "HEAD"
if args.all:
all_file_paths = get_file_paths_in(git_repo_path)
elif args.path:
all_file_paths = get_file_paths_in(args.path)
elif args.ref:
all_file_paths = get_file_paths_for_commands(
[["git", "diff", "--name-only", "--diff-filter=ACMR", args.ref, "HEAD"]]
)
clang_format_commit = args.ref
else:
all_file_paths = get_file_paths_for_commands(
[
["git", "diff", "--cached", "--name-only", "--diff-filter=ACMR"],
["git", "diff", "--name-only", "--diff-filter=ACMR"],
]
)
file_paths = set(filter(should_process_file, all_file_paths))
result = True
if not args.skip_license_header_checks:
proc = subprocess.run(["Scripts/lint/lint-license-headers", "--fix"])
if proc.returncode != 0:
result = False
print("Running SwiftLint...", flush=True)
if not lint_swift_files(file_paths):
result = False
print("")
print("Sorting forward declarations...", flush=True)
for file_path in file_paths:
process(file_path)
print("")
print("Sorting Xcode project...", flush=True)
subprocess.run(["Scripts/sort-Xcode-project-file", "Signal.xcodeproj"])
print("")
print("Running clang-format...", flush=True)
# we don't want to format .proto files, so we specify every other supported extension
subprocess.run(
[
"git",
"clang-format",
"--extensions",
"c,h,m,mm,cc,cp,cpp,c++,cxx,hh,hxx,cu,java,js,ts,cs",
"--commit",
clang_format_commit,
]
)
print("")
print("Checking for keywords...", flush=True)
check_diff_for_keywords()
print("")
if not result:
print("Some errors couldn't be fixed automatically.")
sys.exit(1)
You can’t perform that action at this time.