rust/util/export.py

83 lines
2.2 KiB
Python
Raw Normal View History

2016-07-12 14:11:18 +02:00
#!/usr/bin/env python
2018-10-06 18:23:54 +02:00
# 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.
2016-07-19 21:25:46 +02:00
# Build the gh-pages
2016-07-12 14:11:18 +02:00
import re
2016-07-19 21:25:46 +02:00
import sys
import json
2016-07-19 21:25:46 +02:00
from lintlib import parse_all, log
2016-07-12 14:11:18 +02:00
lint_subheadline = re.compile(r'''^\*\*([\w\s]+?)[:?.!]?\*\*(.*)''')
CONF_TEMPLATE = """\
This lint has the following configuration variables:
* `%s: %s`: %s (defaults to `%s`)."""
def parse_lint_def(lint):
lint_dict = {}
lint_dict['id'] = lint.name
2018-04-10 12:23:41 +02:00
lint_dict['group'] = lint.group
lint_dict['level'] = lint.level
lint_dict['docs'] = {}
2016-07-12 14:11:18 +02:00
last_section = None
for line in lint.doc:
if len(line.strip()) == 0 and not last_section.startswith("Example"):
2016-07-12 14:11:18 +02:00
continue
match = re.match(lint_subheadline, line)
if match:
last_section = match.groups()[0]
if match:
text = match.groups()[1]
else:
text = line
2016-07-12 14:11:18 +02:00
if not last_section:
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
2016-07-12 14:11:18 +02:00
2016-07-19 21:25:46 +02:00
2016-07-12 14:11:18 +02:00
def main():
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")
2016-07-19 21:25:46 +02:00
2016-07-12 14:11:18 +02:00
if __name__ == "__main__":
main()