2 # Generate a Markdown table of all lints, and put it in README.md.
3 # With -n option, only print the new table to stdout.
4 # With -c option, print a warning and set exit status to 1 if a file would be
11 declare_lint_re = re.compile(r'''
12 declare_lint! \s* [{(] \s*
13 pub \s+ (?P<name>[A-Z_][A-Z_0-9]*) \s*,\s*
14 (?P<level>Forbid|Deny|Warn|Allow) \s*,\s*
15 " (?P<desc>(?:[^"\\]+|\\.)*) " \s* [})]
16 ''', re.VERBOSE | re.DOTALL)
18 declare_deprecated_lint_re = re.compile(r'''
19 declare_deprecated_lint! \s* [{(] \s*
20 pub \s+ (?P<name>[A-Z_][A-Z_0-9]*) \s*,\s*
21 " (?P<desc>(?:[^"\\]+|\\.)*) " \s* [})]
22 ''', re.VERBOSE | re.DOTALL)
24 declare_restriction_lint_re = re.compile(r'''
25 declare_restriction_lint! \s* [{(] \s*
26 pub \s+ (?P<name>[A-Z_][A-Z_0-9]*) \s*,\s*
27 " (?P<desc>(?:[^"\\]+|\\.)*) " \s* [})]
28 ''', re.VERBOSE | re.DOTALL)
30 nl_escape_re = re.compile(r'\\\n\s*')
32 wiki_link = 'https://github.com/Manishearth/rust-clippy/wiki'
35 def collect(lints, deprecated_lints, restriction_lints, fn):
36 """Collect all lints from a file.
38 Adds entries to the lints list as `(module, name, level, desc)`.
42 for match in declare_lint_re.finditer(code):
43 # remove \-newline escapes from description string
44 desc = nl_escape_re.sub('', match.group('desc'))
45 lints.append((os.path.splitext(os.path.basename(fn))[0],
46 match.group('name').lower(),
47 match.group('level').lower(),
48 desc.replace('\\"', '"')))
50 for match in declare_deprecated_lint_re.finditer(code):
51 # remove \-newline escapes from description string
52 desc = nl_escape_re.sub('', match.group('desc'))
53 deprecated_lints.append((os.path.splitext(os.path.basename(fn))[0],
54 match.group('name').lower(),
55 desc.replace('\\"', '"')))
57 for match in declare_restriction_lint_re.finditer(code):
58 # remove \-newline escapes from description string
59 desc = nl_escape_re.sub('', match.group('desc'))
60 restriction_lints.append((os.path.splitext(os.path.basename(fn))[0],
61 match.group('name').lower(),
63 desc.replace('\\"', '"')))
66 def gen_table(lints, link=None):
67 """Write lint table in Markdown format."""
69 lints = [(p, '[%s](%s#%s)' % (l, link, l), lvl, d)
70 for (p, l, lvl, d) in lints]
71 # first and third column widths
72 w_name = max(len(l[1]) for l in lints)
73 w_desc = max(len(l[3]) for l in lints)
74 # header and underline
75 yield '%-*s | default | meaning\n' % (w_name, 'name')
76 yield '%s-|-%s-|-%s\n' % ('-' * w_name, '-' * 7, '-' * w_desc)
77 # one table row per lint
78 for (_, name, default, meaning) in sorted(lints, key=lambda l: l[1]):
79 yield '%-*s | %-7s | %s\n' % (w_name, name, default, meaning)
82 def gen_group(lints, levels=None):
83 """Write lint group (list of all lints in the form module::NAME)."""
85 lints = [tup for tup in lints if tup[2] in levels]
86 for (module, name, _, _) in sorted(lints):
87 yield ' %s::%s,\n' % (module, name.upper())
93 for module in sorted(set(lint[0] for lint in lints)):
94 yield 'pub mod %s;\n' % module
97 def gen_deprecated(lints):
98 """Declare deprecated lints"""
101 yield ' store.register_removed("%s", "%s");\n' % (lint[1], lint[2])
104 def replace_region(fn, region_start, region_end, callback,
105 replace_start=True, write_back=True):
106 """Replace a region in a file delimited by two lines matching regexes.
108 A callback is called to write the new region. If `replace_start` is true,
109 the start delimiter line is replaced as well. The end delimiter line is
112 # read current content
116 # replace old region with new region
118 in_old_region = False
121 if re.search(region_end, line):
122 in_old_region = False
123 new_lines.extend(callback())
124 new_lines.append(line)
125 elif re.search(region_start, line):
126 if not replace_start:
127 new_lines.append(line)
128 # old region starts here
131 new_lines.append(line)
135 with open(fn, 'w') as fp:
136 fp.writelines(new_lines)
138 # if something changed, return true
139 return lines != new_lines
142 def main(print_only=False, check=False):
144 deprecated_lints = []
145 restriction_lints = []
148 if not os.path.isfile('clippy_lints/src/lib.rs'):
149 print('Error: call this script from clippy checkout directory!')
152 # collect all lints from source files
153 for root, _, files in os.walk('clippy_lints/src'):
155 if fn.endswith('.rs'):
156 collect(lints, deprecated_lints, restriction_lints,
157 os.path.join(root, fn))
160 sys.stdout.writelines(gen_table(lints + restriction_lints))
163 # replace table in README.md
164 changed = replace_region(
165 'README.md', r'^name +\|', '^$',
166 lambda: gen_table(lints + restriction_lints, link=wiki_link),
167 write_back=not check)
169 changed |= replace_region(
171 r'^There are \d+ lints included in this crate:', "",
172 lambda: ['There are %d lints included in this crate:\n' %
173 (len(lints) + len(restriction_lints))],
174 write_back=not check)
176 # update the links in the CHANGELOG
177 changed |= replace_region(
179 "<!-- begin autogenerated links to wiki -->",
180 "<!-- end autogenerated links to wiki -->",
181 lambda: ["[`{0}`]: {1}#{0}\n".format(l[1], wiki_link) for l in
182 sorted(lints + restriction_lints + deprecated_lints,
183 key=lambda l: l[1])],
184 replace_start=False, write_back=not check)
186 # update the `pub mod` list
187 changed |= replace_region(
188 'clippy_lints/src/lib.rs', r'begin lints modules', r'end lints modules',
189 lambda: gen_mods(lints + restriction_lints),
190 replace_start=False, write_back=not check)
192 # same for "clippy" lint collection
193 changed |= replace_region(
194 'clippy_lints/src/lib.rs', r'reg.register_lint_group\("clippy"', r'\]\);',
195 lambda: gen_group(lints, levels=('warn', 'deny')),
196 replace_start=False, write_back=not check)
198 # same for "deprecated" lint collection
199 changed |= replace_region(
200 'clippy_lints/src/lib.rs', r'let mut store', r'end deprecated lints',
201 lambda: gen_deprecated(deprecated_lints),
203 write_back=not check)
205 # same for "clippy_pedantic" lint collection
206 changed |= replace_region(
207 'clippy_lints/src/lib.rs', r'reg.register_lint_group\("clippy_pedantic"', r'\]\);',
208 lambda: gen_group(lints, levels=('allow',)),
209 replace_start=False, write_back=not check)
211 # same for "clippy_restrictions" lint collection
212 changed |= replace_region(
213 'clippy_lints/src/lib.rs', r'reg.register_lint_group\("clippy_restrictions"',
214 r'\]\);', lambda: gen_group(restriction_lints),
215 replace_start=False, write_back=not check)
217 if check and changed:
218 print('Please run util/update_lints.py to regenerate lints lists.')
222 if __name__ == '__main__':
223 sys.exit(main(print_only='-n' in sys.argv, check='-c' in sys.argv))