feat: deploy librelingo tools output to github pages (#1946)

* feat: deploy librelingo tools output to github pages

* fix: enable autoescape in jinja templates

* fix(tools): add integrity checks for the jquery cdn link

apps/tools/generate.py → apps/tools/librelingo_tools/generate.py

@@ -21,7 +21,7 @@ def get_args():
 def generate_html(start_time, end_time, links, outdir):
     root = os.path.dirname(os.path.abspath(__file__))
     templates_dir = os.path.join(root, "templates")
-    env = Environment(loader=FileSystemLoader(templates_dir))
+    env = Environment(loader=FileSystemLoader(templates_dir), autoescape=True)
     template = env.get_template("courses.html")
     html = template.render(start_time=start_time, end_time=end_time, links=links)
 
@@ -51,7 +51,10 @@ def generate_course(sdir, outdir, tdir, course_dir):
     python = sys.executable
     cmd = f"{python} {lilipy} --course {course_dir} --html {docs_dir}"
     print(cmd)
-    success = os.system(cmd) == 0
+    success = (
+        os.system(cmd) == 0
+    )  # replace this arbitrary system call with a simple Python call
+    # {or refactor this file as a shell script. But Python code is preferable)
     os.chdir(current_dir)
     with open(os.path.join(docs_dir, "course.json")) as fh:
         count = json.load(fh)
@@ -100,7 +103,7 @@ def main():
     tdir = "basque-from-english"
     links.append(
         generate_course(
-            sdir="LibreLingo",
+            sdir=".",
             outdir=outdir,
             tdir=tdir,
             course_dir=f"courses/{tdir}",
@@ -109,12 +112,12 @@ def main():
     with open(os.path.join(outdir, tdir, "course.json")) as fh:
         courses_data[tdir] = json.load(fh)
 
-    for tdir in os.listdir("LibreLingo/temporarily_inactive_courses/"):
+    for tdir in os.listdir("./temporarily_inactive_courses/"):
         if tdir == "basque-from-english":
             continue
         links.append(
             generate_course(
-                sdir="LibreLingo",
+                sdir=".",
                 outdir=outdir,
                 tdir=tdir,
                 course_dir=f"temporarily_inactive_courses/{tdir}",

apps/tools/lili.py → apps/tools/librelingo_tools/lili.py

@@ -111,7 +111,7 @@ def guess_path_to_course(path_to_course):
 def render(template_file, **args):
     root = os.path.dirname(os.path.abspath(__file__))
     templates_dir = os.path.join(root, "templates")
-    env = Environment(loader=FileSystemLoader(templates_dir))
+    env = Environment(loader=FileSystemLoader(templates_dir), autoescape=True)
     template = env.get_template(template_file)
     html = template.render(**args)
     return html

apps/tools/templates/converter.html → apps/tools/librelingo_tools/templates/converter.html

@@ -26,7 +26,7 @@
 <div id="output">
 <div>
 
-<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
+<script src="https://code.jquery.com/jquery-3.6.0.min.js" integrity="sha256-/xUj+3OJU5yExlq6GSYGSHk7tPXikynS7ogEvDej/m4=" crossorigin="anonymous"></script>
 <script>
 $(document).ready(function(){
     var source_to_target = null;

apps/tools/templates/missing_words.html → apps/tools/librelingo_tools/templates/missing_words.html

@@ -23,7 +23,7 @@ <h2>Missing Words</h2>
 </div>
 
 
-<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
+<script src="https://code.jquery.com/jquery-3.6.0.min.js" integrity="sha256-/xUj+3OJU5yExlq6GSYGSHk7tPXikynS7ogEvDej/m4=" crossorigin="anonymous"></script>
 <script>
 $(document).ready(function(){
     //var source_to_target = null;

apps/tools/practice.py

@@ -2,7 +2,12 @@
 import argparse
 import random
 
-from lili import guess_path_to_course, collect_data, collect_words, collect_phrases
+from librelingo_tools.lili import (  # type: ignore
+    guess_path_to_course,
+    collect_data,
+    collect_words,
+    collect_phrases,
+)
 from librelingo_yaml_loader.yaml_loader import load_course
 
 

apps/tools/pyproject.toml

@@ -1,5 +1,5 @@
 [tool.poetry]
-name = "tools"
+name = "librelingo-tools"
 version = "0.1.0"
 description = ""
 authors = ["Your Name <you@example.com>"]

courses/basque-from-english/21-Because2/skills/21-Because2-3.yaml

@@ -1,6 +1,6 @@
 Skill:
-  Id: 212
-  Name: Because 2-2
+  Id: 213
+  Name: Because 2-3
   Thumbnails:
 
 New words:

package.json

@@ -3,7 +3,7 @@
   "private": true,
   "scripts": {
     "export:production": "yarn web installAllExternalCourses && yarn exportAllCourses && yarn web export && yarn docs:build && mv ./apps/web/__sapper__/ .",
-    "export": "yarn web export && mv ./apps/web/__sapper__/ .",
+    "export": "yarn web export && mv ./apps/web/__sapper__/ . && poetry run python apps/tools/librelingo_tools/generate.py --courses ./config/courses.json --outdir ./__sapper__/export/course-tools-legacy",
     "deploy": "echo 'librelingo.app' > __sapper__/export/CNAME && gh-pages -d __sapper__/export",
     "commit": "git-cz",
     "test": "jest",

pyproject.toml

@@ -16,6 +16,7 @@ librelingo-fakes = { path = "./apps/librelingo_fakes", develop = true }
 librelingo-utils = { path = "./apps/librelingo_utils", develop = true }
 librelingo-audios = { path = "./apps/librelingo_audios", develop = true }
 librelingo-types = { path = "./apps/librelingo_types", develop = true }
+librelingo-tools = { path = "./apps/tools", develop = true }
 pytest = "^6.2.2"
 pytest-mock = "^3.5.1"
 pytest-watch = "^4.2.0"