Squashed 'vimhelp/' content from commit b9410f6

git-subtree-dir: vimhelp
git-subtree-split: b9410f6b039500d0b96585d2b3af51c85a77e29c

Author: ychin

.flake8

@@ -0,0 +1,5 @@
+[flake8]
+max-line-length = 88
+extend-ignore = E203,W503
+per-file-ignores = vimhelp/vimh2h.py:E126,E201,E202,E221,E272,E501,E701,W504
+exclude = .venv

.gcloudignore

@@ -0,0 +1,9 @@
+/.git
+/.gitignore
+/.gcloudignore
+/.venv
+/scripts
+/README.md
+/LICENSE
+/tasks.py
+__pycache__/

.gitignore

@@ -0,0 +1,4 @@
+TODO
+/vimhelp/secret.py
+/.venv/
+__pycache__/

LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2016 Carlo Teubner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,29 @@
+# vimhelp.org
+
+This is the code behind the https://vimhelp.org website. It runs on
+[Google App Engine](https://cloud.google.com/appengine/).
+
+To make testing and deploying easier, a `tasks.py` file exists for use
+with the [_Invoke_](https://www.pyinvoke.org/) tool (which is similar in
+spirit to _Make_).
+
+## Generating static pages
+
+To generate static HTML pages instead of running on Google App Engine:
+
+- Create a virtualenv. If you have _Invoke_ installed, this is as easy as
+  `inv venv`. Alternatively:
+  ```
+  python3 -m venv --upgrade-deps .venv
+  .venv/bin/pip install -r requirements.txt
+  ```
+- Run the following (replace the `-i` parameter with the Vim documentation
+  location on your computer):
+  ```
+  scripts/h2h.py -i /usr/share/vim/vim90/doc/ -o html/
+  ```
+  The script offers a few options; run with `-h` to see what is available.
+
+## License
+
+This code is made freely available under the MIT License (see file LICENSE).

app.yaml

@@ -0,0 +1,40 @@
+runtime: python310
+
+automatic_scaling:
+  max_instances: 2
+  max_idle_instances: 1
+  target_cpu_utilization: 0.9
+  target_throughput_utilization: 0.9
+  max_concurrent_requests: 50
+  min_pending_latency: 500ms
+
+entrypoint: gunicorn -b :$PORT -k gevent -w 1 'vimhelp.webapp:create_app()'
+
+default_expiration: "1h"
+
+inbound_services:
+- warmup
+
+handlers:
+- url: /(?:.*\.html)?
+  script: auto
+  secure: always
+- url: /api/.+
+  script: auto
+  secure: always
+- url: /(?:robots|sitemap)\.txt
+  script: auto
+  secure: always
+- url: /favicon\.ico
+  script: auto
+  secure: always
+- url: /(?:enqueue_)?update
+  script: auto
+  secure: always
+- url: /_ah/warmup
+  script: auto
+  secure: always
+- url: /(.+)
+  static_files: static/\1
+  upload: static/(.*)
+  secure: always

cron.yaml

@@ -0,0 +1,7 @@
+cron:
+- description: fetch and process vim docs
+  url: /enqueue_update?project=vim
+  schedule: every 31 minutes
+- description: fetch and process neovim docs
+  url: /enqueue_update?project=neovim
+  schedule: every 32 minutes

gunicorn.conf.dev.py

@@ -0,0 +1,13 @@
+import traceback
+
+
+loglevel = "debug"
+reload = True
+reload_extra_files = ["static", "templates"]
+timeout = 15
+worker_class = "gevent"
+wsgi_app = "vimhelp.webapp:create_app()"
+
+
+def worker_abort(worker):
+    traceback.print_stack()

requirements.txt

@@ -0,0 +1,6 @@
+Flask ~= 2.2
+gevent ~= 22.10
+geventhttpclient ~= 2.0
+google-cloud-ndb ~= 2.1
+google-cloud-tasks ~= 2.12
+gunicorn ~= 20.1

scripts/h2h.py

@@ -0,0 +1,149 @@
+#!/usr/bin/env .venv/bin/python3
+
+# This script is meant to be run from the top-level directory of the
+# repository, as 'scripts/h2h.py'. The virtualenv must already exist
+# (use "inv venv" to create it).
+
+import argparse
+import os.path
+import pathlib
+import sys
+
+import flask
+
+root_path = pathlib.Path(__file__).parent.parent
+
+sys.path.append(str(root_path))
+
+from vimhelp.vimh2h import VimH2H  # noqa: E402
+
+
+def main():
+    parser = argparse.ArgumentParser(description="Convert Vim help files to HTML")
+    parser.add_argument(
+        "--in-dir",
+        "-i",
+        required=True,
+        type=pathlib.Path,
+        help="Directory of Vim doc files",
+    )
+    parser.add_argument(
+        "--out-dir",
+        "-o",
+        type=pathlib.Path,
+        help="Output directory (omit for no output)",
+    )
+    parser.add_argument(
+        "--project",
+        "-p",
+        choices=("vim", "neovim"),
+        default="vim",
+        help="Vim flavour (default: vim)",
+    )
+    parser.add_argument(
+        "--web-version",
+        "-w",
+        action="store_true",
+        help="Generate the web version of the files (default: offline version)",
+    )
+    parser.add_argument(
+        "--theme",
+        "-t",
+        choices=("light", "dark"),
+        help="Color theme (default: OS-native)",
+    )
+    parser.add_argument(
+        "--no-tags",
+        "-T",
+        action="store_true",
+        help="Ignore any tags file, always recreate tags from scratch",
+    )
+    parser.add_argument(
+        "--profile", "-P", action="store_true", help="Profile performance"
+    )
+    parser.add_argument(
+        "basenames", nargs="*", help="List of files to process (default: all)"
+    )
+    args = parser.parse_args()
+
+    app = flask.Flask(
+        __name__,
+        root_path=pathlib.Path(__file__).resolve().parent,
+        static_url_path="",
+        static_folder="../static",
+        template_folder="../templates",
+    )
+    app.jinja_options["trim_blocks"] = True
+    app.jinja_options["lstrip_blocks"] = True
+
+    with app.app_context():
+        if args.profile:
+            import cProfile
+            import pstats
+
+            with cProfile.Profile() as pr:
+                run(args)
+            stats = pstats.Stats(pr).sort_stats("cumulative")
+            stats.print_stats()
+        else:
+            run(args)
+
+
+def run(args):
+    if not args.in_dir.is_dir():
+        raise RuntimeError(f"{args.in_dir} is not a directory")
+
+    prelude = VimH2H.prelude(theme=args.theme)
+
+    mode = "hybrid" if args.web_version else "offline"
+
+    if not args.no_tags and (tags_file := args.in_dir / "tags").is_file():
+        print("Processing tags file...")
+        h2h = VimH2H(mode=mode, project=args.project, tags=tags_file.read_text())
+        faq = args.in_dir / "vim_faq.txt"
+        if faq.is_file():
+            print("Processing FAQ tags...")
+            h2h.add_tags(faq.name, faq.read_text())
+    else:
+        print("Initializing tags...")
+        h2h = VimH2H(mode=mode, project=args.project)
+        for infile in args.in_dir.iterdir():
+            if infile.suffix == ".txt":
+                h2h.add_tags(infile.name, infile.read_text())
+
+    if args.out_dir is not None:
+        args.out_dir.mkdir(exist_ok=True)
+
+    for infile in args.in_dir.iterdir():
+        if len(args.basenames) != 0 and infile.name not in args.basenames:
+            continue
+        if infile.suffix != ".txt" and infile.name != "tags":
+            print(f"Ignoring {infile}")
+            continue
+        content = infile.read_text()
+        print(f"Processing {infile}...")
+        html = h2h.to_html(infile.name, content)
+        if args.out_dir is not None:
+            with (args.out_dir / f"{infile.name}.html").open("w") as f:
+                f.write(prelude)
+                f.write(html)
+
+    if args.out_dir is not None:
+        print("Symlinking static files...")
+        static_dir_rel = os.path.relpath(root_path / "static", args.out_dir)
+        for target in (root_path / "static").iterdir():
+            target_name = target.name
+            if target_name == f"favicon-{args.project}.ico":
+                src_name = "favicon.ico"
+            elif target_name.startswith("favicon-"):
+                continue
+            else:
+                src_name = target_name
+            src = pathlib.Path(args.out_dir / src_name)
+            src.unlink(missing_ok=True)
+            src.symlink_to(f"{static_dir_rel}/{target_name}")
+
+    print("Done.")
+
+
+main()