util/update_lints.py

   1 #!/usr/bin/env python
   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.
   5
   6 import os
   7 import re
   8 import sys
   9
  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* [})]
  15 ''', re.X | re.S)
  16
  17 nl_escape_re = re.compile(r'\\\n\s*')
  18
  19 wiki_link = 'https://github.com/Manishearth/rust-clippy/wiki'
  20
  21 def collect(lints, fn):
  22     """Collect all lints from a file.
  23
  24     Adds entries to the lints list as `(module, name, level, desc)`.
  25     """
  26     with open(fn) as fp:
  27         code = fp.read()
  28     for match in declare_lint_re.finditer(code):
  29         # remove \-newline escapes from description string
  30         desc = nl_escape_re.sub('', match.group('desc'))
  31         lints.append((os.path.splitext(os.path.basename(fn))[0],
  32                       match.group('name').lower(),
  33                       match.group('level').lower(),
  34                       desc.replace('\\"', '"')))
  35
  36
  37 def gen_table(lints, link=None):
  38     """Write lint table in Markdown format."""
  39     if link:
  40         lints = [(p, '[%s](%s#%s)' % (l, link, l), lvl, d)
  41                     for (p, l, lvl, d) in lints]
  42     # first and third column widths
  43     w_name = max(len(l[1]) for l in lints)
  44     w_desc = max(len(l[3]) for l in lints)
  45     # header and underline
  46     yield '%-*s | default | meaning\n' % (w_name, 'name')
  47     yield '%s-|-%s-|-%s\n' % ('-' * w_name, '-' * 7, '-' * w_desc)
  48     # one table row per lint
  49     for (_, name, default, meaning) in sorted(lints, key=lambda l: l[1]):
  50         yield '%-*s | %-7s | %s\n' % (w_name, name, default, meaning)
  51
  52
  53 def gen_group(lints):
  54     """Write lint group (list of all lints in the form module::NAME)."""
  55     for (module, name, _, _) in sorted(lints):
  56         yield '        %s::%s,\n' % (module, name.upper())
  57
  58
  59 def replace_region(fn, region_start, region_end, callback,
  60                    replace_start=True, write_back=True):
  61     """Replace a region in a file delimited by two lines matching regexes.
  62
  63     A callback is called to write the new region.  If `replace_start` is true,
  64     the start delimiter line is replaced as well.  The end delimiter line is
  65     never replaced.
  66     """
  67     # read current content
  68     with open(fn) as fp:
  69         lines = list(fp)
  70
  71     # replace old region with new region
  72     new_lines = []
  73     in_old_region = False
  74     for line in lines:
  75         if in_old_region:
  76             if re.search(region_end, line):
  77                 in_old_region = False
  78                 new_lines.extend(callback())
  79                 new_lines.append(line)
  80         elif re.search(region_start, line):
  81             if not replace_start:
  82                 new_lines.append(line)
  83             # old region starts here
  84             in_old_region = True
  85         else:
  86             new_lines.append(line)
  87
  88     # write back to file
  89     if write_back:
  90         with open(fn, 'w') as fp:
  91             fp.writelines(new_lines)
  92
  93     # if something changed, return true
  94     return lines != new_lines
  95
  96
  97 def main(print_only=False, check=False):
  98     lints = []
  99
 100     # check directory
 101     if not os.path.isfile('src/lib.rs'):
 102         print('Error: call this script from clippy checkout directory!')
 103         return
 104
 105     # collect all lints from source files
 106     for root, dirs, files in os.walk('src'):
 107         for fn in files:
 108             if fn.endswith('.rs'):
 109                 collect(lints, os.path.join(root, fn))
 110
 111     if print_only:
 112         sys.stdout.writelines(gen_table(lints))
 113         return
 114
 115     # replace table in README.md
 116     changed = replace_region('README.md', r'^name +\|', '^$',
 117                              lambda: gen_table(lints, link=wiki_link),
 118                              write_back=not check)
 119
 120     changed |= replace_region('README.md',
 121         r'^There are \d+ lints included in this crate:', "",
 122         lambda: ['There are %d lints included in this crate:\n' % len(lints)],
 123         write_back=not check)
 124
 125     # same for "clippy" lint collection
 126     changed |= replace_region('src/lib.rs', r'reg.register_lint_group\("clippy"', r'\]\);',
 127                               lambda: gen_group(lints), replace_start=False,
 128                               write_back=not check)
 129
 130     if check and changed:
 131         print('Please run util/update_lints.py to regenerate lints lists.')
 132         return 1
 133
 134
 135 if __name__ == '__main__':
 136     sys.exit(main(print_only='-n' in sys.argv, check='-c' in sys.argv))