#!/usr/bin/env python
+
+# Copyright 2014-2018 The Rust Project Developers. See the COPYRIGHT
+# file at the top-level directory of this distribution and at
+# http://rust-lang.org/COPYRIGHT.
+#
+# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+# http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+# <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+# option. This file may not be copied, modified, or distributed
+# except according to those terms.
+
+
# Build the gh-pages
-import json
-import os
import re
import sys
+import json
+from lintlib import parse_all, log
-level_re = re.compile(r'''(Forbid|Deny|Warn|Allow)''')
-conf_re = re.compile(r'''define_Conf! {\n([^}]*)\n}''', re.MULTILINE)
-confvar_re = re.compile(r'''/// Lint: (\w+). (.*).*\n *\("([^"]*)", (?:[^,]*), (.*) => (.*)\),''')
lint_subheadline = re.compile(r'''^\*\*([\w\s]+?)[:?.!]?\*\*(.*)''')
-conf_template = """
+CONF_TEMPLATE = """\
This lint has the following configuration variables:
-* `%s: %s`: %s (defaults to `%s`).
-"""
-
-
-# TODO: actual logging
-def warn(*args):
- print(args)
-
-
-def debug(*args):
- print(args)
-
-
-def info(*args):
- print(args)
-
-
-def parse_path(p="clippy_lints/src"):
- lints = []
- for f in os.listdir(p):
- if f.endswith(".rs"):
- parse_file(lints, os.path.join(p, f))
+* `%s: %s`: %s (defaults to `%s`)."""
- conf = parse_conf(p)
- info(conf)
- for lint_id in conf:
- lint = next(l for l in lints if l['id'] == lint_id)
- if lint:
- lint['docs']['Configuration'] = (conf_template % conf[lint_id]).strip()
-
- return lints
-
-
-def parse_conf(p):
- c = {}
- with open(p + '/utils/conf.rs') as f:
- f = f.read()
-
- m = re.search(conf_re, f)
- m = m.groups()[0]
-
- m = re.findall(confvar_re, m)
-
- for (lint, doc, name, default, ty) in m:
- c[lint.lower()] = (name, ty, doc, default)
-
- return c
-
-
-def parseLintDef(level, comment, name):
- lint = {}
- lint['id'] = name
- lint['level'] = level
- lint['docs'] = {}
+def parse_lint_def(lint):
+ lint_dict = {}
+ lint_dict['id'] = lint.name
+ lint_dict['group'] = lint.group
+ lint_dict['level'] = lint.level
+ lint_dict['docs'] = {}
last_section = None
- for line in comment:
- if len(line.strip()) == 0:
+ for line in lint.doc:
+ if len(line.strip()) == 0 and not last_section.startswith("Example"):
continue
match = re.match(lint_subheadline, line)
text = line
if not last_section:
- warn("Skipping comment line as it was not preceded by a heading")
- debug("in lint `%s`, line `%s`" % name, line)
-
- lint['docs'][last_section] = (lint['docs'].get(last_section, "") + "\n" + text).strip()
-
- return lint
-
-
-def parse_file(d, f):
- last_comment = []
- comment = True
-
- with open(f) as rs:
- for line in rs:
- if comment:
- if line.startswith("///"):
- if line.startswith("/// "):
- last_comment.append(line[4:])
- else:
- last_comment.append(line[3:])
- elif line.startswith("declare_lint!"):
- comment = False
- deprecated = False
- restriction = False
- elif line.startswith("declare_restriction_lint!"):
- comment = False
- deprecated = False
- restriction = True
- elif line.startswith("declare_deprecated_lint!"):
- comment = False
- deprecated = True
- else:
- last_comment = []
- if not comment:
- l = line.strip()
- m = re.search(r"pub\s+([A-Z_][A-Z_0-9]*)", l)
-
- if m:
- name = m.group(1).lower()
-
- # Intentionally either a never looping or infinite loop
- while not deprecated and not restriction:
- m = re.search(level_re, line)
- if m:
- level = m.group(0)
- break
-
- line = next(rs)
-
- if deprecated:
- level = "Deprecated"
- elif restriction:
- level = "Allow"
-
- info("found %s with level %s in %s" % (name, level, f))
- d.append(parseLintDef(level, last_comment, name=name))
- last_comment = []
- comment = True
- if "}" in l:
- warn("Warning: Missing Lint-Name in", f)
- comment = True
+ log.warn("Skipping comment line as it was not preceded by a heading")
+ log.debug("in lint `%s`, line `%s`", lint.name, line)
+
+ fragment = lint_dict['docs'].get(last_section, "")
+ if text == "\n":
+ line = fragment + text
+ else:
+ line = (fragment + "\n" + text).strip()
+
+ lint_dict['docs'][last_section] = line
+
+ return lint_dict
def main():
- lints = parse_path()
- info("got %s lints" % len(lints))
+ lintlist, configs = parse_all()
+ lints = {}
+ for lint in lintlist:
+ lints[lint.name] = parse_lint_def(lint)
+ if lint.name in configs:
+ lints[lint.name]['docs']['Configuration'] = \
+ CONF_TEMPLATE % configs[lint.name]
+
+ outfile = sys.argv[1] if len(sys.argv) > 1 else "util/gh-pages/lints.json"
+ with open(outfile, "w") as fp:
+ json.dump(list(lints.values()), fp, indent=2)
+ log.info("wrote JSON for great justice")
- outdir = sys.argv[1] if len(sys.argv) > 1 else "util/gh-pages/lints.json"
- with open(outdir, "w") as file:
- json.dump(lints, file, indent=2)
- info("wrote JSON for great justice")
if __name__ == "__main__":
main()
projects / rust.git / blobdiff