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 changed.
10 declare_lint_re = re.compile(r'''
11 declare_lint! \s* [{(] \s*
12 pub \s+ (?P<name>[A-Z_]+) \s*,\s*
13 (?P<level>Forbid|Deny|Warn|Allow) \s*,\s*
14 " (?P<desc>(?:[^"\\]+|\\.)*) " \s* [})]
17 nl_escape_re = re.compile(r'\\\n\s*')
20 def collect(lints, fn):
21 """Collect all lints from a file.
23 Adds entries to the lints list as `(module, name, level, desc)`.
27 for match in declare_lint_re.finditer(code):
28 # remove \-newline escapes from description string
29 desc = nl_escape_re.sub('', match.group('desc'))
30 lints.append((os.path.splitext(os.path.basename(fn))[0],
31 match.group('name').lower(),
32 match.group('level').lower(),
33 desc.replace('\\"', '"')))
37 """Write lint table in Markdown format."""
38 # first and third column widths
39 w_name = max(len(l[1]) for l in lints)
40 w_desc = max(len(l[3]) for l in lints)
41 # header and underline
42 yield '%-*s | default | meaning\n' % (w_name, 'name')
43 yield '%s-|-%s-|-%s\n' % ('-' * w_name, '-' * 7, '-' * w_desc)
44 # one table row per lint
45 for (_, name, default, meaning) in sorted(lints, key=lambda l: l[1]):
46 yield '%-*s | %-7s | %s\n' % (w_name, name, default, meaning)
50 """Write lint group (list of all lints in the form module::NAME)."""
51 for (module, name, _, _) in sorted(lints):
52 yield ' %s::%s,\n' % (module, name.upper())
55 def replace_region(fn, region_start, region_end, callback,
56 replace_start=True, write_back=True):
57 """Replace a region in a file delimited by two lines matching regexes.
59 A callback is called to write the new region. If `replace_start` is true,
60 the start delimiter line is replaced as well. The end delimiter line is
63 # read current content
67 # replace old region with new region
72 if re.search(region_end, line):
74 new_lines.extend(callback())
75 new_lines.append(line)
76 elif re.search(region_start, line):
78 new_lines.append(line)
79 # old region starts here
82 new_lines.append(line)
86 with open(fn, 'w') as fp:
87 fp.writelines(new_lines)
89 # if something changed, return true
90 return lines != new_lines
93 def main(print_only=False, check=False):
97 if not os.path.isfile('src/lib.rs'):
98 print('Error: call this script from clippy checkout directory!')
101 # collect all lints from source files
102 for root, dirs, files in os.walk('src'):
104 if fn.endswith('.rs'):
105 collect(lints, os.path.join(root, fn))
108 sys.stdout.writelines(gen_table(lints))
111 # replace table in README.md
112 changed = replace_region('README.md', r'^name +\|', '^$',
113 lambda: gen_table(lints),
114 write_back=not check)
116 changed |= replace_region('README.md',
117 r'^There are \d+ lints included in this crate:', "",
118 lambda: ['There are %d lints included in this crate:\n' % len(lints)],
119 write_back=not check)
121 # same for "clippy" lint collection
122 changed |= replace_region('src/lib.rs', r'reg.register_lint_group\("clippy"', r'\]\);',
123 lambda: gen_group(lints), replace_start=False,
124 write_back=not check)
126 if check and changed:
127 print('Please run util/update_lints.py to regenerate lints lists.')
131 if __name__ == '__main__':
132 sys.exit(main(print_only='-n' in sys.argv, check='-c' in sys.argv))