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
|
#!/usr/bin/python3
import argparse
import sys
import os
import re
import shutil
import subprocess
# ---------- actual list of lints to apply (or disapply) ----------
WANT_LINTS = """
#![deny(missing_docs)]
#![warn(noop_method_call)]
#![deny(unreachable_pub)]
#![warn(clippy::all)]
#![deny(clippy::await_holding_lock)]
#![deny(clippy::cargo_common_metadata)]
#![deny(clippy::cast_lossless)]
#![deny(clippy::checked_conversions)]
#![warn(clippy::cognitive_complexity)]
#![deny(clippy::debug_assert_with_mut_call)]
#![deny(clippy::exhaustive_enums)]
#![deny(clippy::exhaustive_structs)]
#![deny(clippy::expl_impl_clone_on_copy)]
#![deny(clippy::fallible_impl_from)]
#![deny(clippy::implicit_clone)]
#![deny(clippy::large_stack_arrays)]
#![warn(clippy::manual_ok_or)]
#![deny(clippy::missing_docs_in_private_items)]
#![deny(clippy::missing_panics_doc)]
#![warn(clippy::needless_borrow)]
#![warn(clippy::needless_pass_by_value)]
#![warn(clippy::option_option)]
#![warn(clippy::rc_buffer)]
#![deny(clippy::ref_option_ref)]
#![warn(clippy::semicolon_if_nothing_returned)]
#![warn(clippy::trait_duplication_in_bounds)]
#![deny(clippy::unnecessary_wraps)]
#![warn(clippy::unseparated_literal_suffix)]
#![deny(clippy::unwrap_used)]
#![allow(clippy::let_unit_value)] // This can reasonably be done for explicitness
"""
# ---------- some notes about lints we might use - NOT USED by any code here ----------
SOON="""
"""
WISH_WE_COULD = """
#![warn(unused_crate_dependencies)]
"""
DECIDED_NOT = """
#![deny(clippy::redundant_pub_crate)]
#![deny(clippy::future_not_send)]
#![deny(clippy::redundant_closure_for_method_calls)]
#![deny(clippy::panic)]
#![deny(clippy::if_then_some_else_none)]
#![deny(clippy::expect_used)]
#![deny(clippy::option_if_let_else)]
#![deny(missing_debug_implementations)]
#![deny(clippy::pub_enum_variant_names)]
"""
# ---------- code for autoprocessing Rust source files ----------
PAT = re.compile(r'^#!\[(allow|deny|warn)')
opts = None
deferred_errors = []
class ImproperFile(Exception):
def __init__(self, lno, message):
self.lno = lno
self.message = message
def filter_file(lints, inp, outp):
in_lint_list = False
found_lint_list = False
lno = 0
for line in inp.readlines():
lno += 1
if line.startswith("// @@ begin lint list"):
if in_lint_list:
raise ImproperFile(lno, 'found "@@ begin lint list" but inside lint list')
found_lint_list = True
in_lint_list = True
elif line.startswith("//! <!-- @@ end lint list"):
# End delimiter is Rustdoc containing an HTML comment, because rustfmt
# *really really* hates comments that come after things.
# Finishing the automaintained block with just a blank line is too much of a hazard.
# It does end up in the output HTML from Rustdoc, but it is harmless there.
if not in_lint_list:
raise ImproperFile(lno, 'found "@@ end lint list" but not inside lint list')
in_lint_list = False
outp.write(WANT_LINTS.strip())
outp.write("\n")
elif in_lint_list:
if not PAT.match(line):
raise ImproperFile(lno, 'entry in lint list does not look like a lint')
# do not send to output
continue
outp.write(line)
if in_lint_list:
raise ImproperFile(lno, 'missing "@@ lint list" delimiter, still in lint list at EOF')
if not found_lint_list:
raise ImproperFile(lno, 'standard lint list block seems to be missing (wrong delimiters?)')
def process(lints, fn):
print("{}...".format(fn))
tmp_name = fn+".tmp~"
outp = open(tmp_name,'w')
inp = open(fn,'r')
try:
filter_file(lints, inp, outp)
except ImproperFile as e:
print('%s:%d: %s' % (fn, e.lno, e.message), file=sys.stderr)
deferred_errors.append(fn)
os.remove(tmp_name) # this tmp file is probably partial
return
inp.close()
outp.close()
if opts.check:
if subprocess.run(['diff', '-u', '--', fn, tmp_name]).returncode != 0:
deferred_errors.append(fn)
else:
shutil.move(tmp_name, fn)
def main(lints,files):
if not os.path.exists("./crates/tor-proto/src/lib.rs"):
print("Run this from the top level of an arti repo.")
sys.exit(1)
if not files:
print("No files provided. Example usage:")
print(" ./maint/add_warning crates/*/src/{lib,main}.rs")
for fn in files:
process(lints, fn)
if len(deferred_errors) > 0:
print('\n' + sys.argv[0] + ': standard lint block mismatch in the following files:\n '
+ ', '.join(deferred_errors), file=sys.stderr)
print('Run ' + sys.argv[0] + ' (possibly after editing it) to fix.')
sys.exit(1)
if __name__ == '__main__':
parser = argparse.ArgumentParser('standardise Rust lint blocks')
parser.add_argument('--check')
parser.add_argument('file', nargs='+')
opts = parser.parse_args()
main(WANT_LINTS, opts.file)
|
