vimhelp: Add ability to export a tags.json file

This allows us to query the tags directly, and can potentially set up
redirect and also client-side tag searching.

Author: ychin

vimhelp/scripts/h2h.py

@@ -66,6 +66,12 @@ def main():
         action="store_true",
         help="Ignore any tags file, always recreate tags from scratch",
     )
+    parser.add_argument(
+        "--output-tags-json",
+        "-J",
+        action="store_true",
+        help="Output a tags.json file, used for client-side search (when not using online version)",
+    )
     parser.add_argument(
         "--profile", "-P", action="store_true", help="Profile performance"
     )
@@ -140,6 +146,14 @@ def run(args):
                 f.write(prelude)
                 f.write(html)
 
+    if args.output_tags_json:
+        print("Processing tags.json...")
+        json = h2h.gen_tags_json()
+        out_filename = "tags.json"
+        if args.out_dir is not None:
+            with (args.out_dir / out_filename).open("w") as f:
+                f.write(json)
+
     if args.out_dir is not None:
         print("Symlinking static files...")
         static_dir_rel = os.path.relpath(root_path / "static", args.out_dir)

vimhelp/vimhelp/vimh2h.py

@@ -4,6 +4,7 @@
 import flask
 import functools
 import html
+import json
 import re
 import urllib.parse
 
@@ -234,6 +235,11 @@ def xform(c):
     def prelude(theme):
         return flask.render_template("prelude.html", theme=theme)
 
+    def gen_tags_json(self):
+        obj = {tag: links.href(False) for (tag, links) in self._urls.items()}
+        return json.dumps(obj, sort_keys=True)
+        return out
+
     def to_html(self, filename, contents):
         is_help_txt = filename == "help.txt"
         lines = [line.rstrip("\r\n") for line in RE_NEWLINE.split(contents)]