Script: add html-incremental target

Author: ascholerChemeketa

pretext/lib/pretext.py

@@ -4822,6 +4822,41 @@ def html(xml, pub_file, stringparams, xmlid_root, file_format, extra_xsl, out_fi
     time_logger.log("build completed")
 
 
+def html_incremental(xml, pub_file, stringparams, xmlid_root, extra_xsl, dest_dir):
+    """Update an HTML incrementally in place.
+       Depends on _static and generated files already being in the destination directory.
+       Caller must supply:
+       * stringparams supplemented with:
+          * rs-js, rs-css, and rs-version (can use _set_runestone_stringparams to set)
+          * publisher: path to publisher file for use by xsltproc
+    """
+    if not "rs-js" in stringparams:
+        log.error("Incremental build missing needed stringparam(s).  Unable to complete build.")
+        return False
+
+    # to ensure provided stringparams aren't mutated unintentionally
+    stringparams = stringparams.copy()
+
+    log_time_info = stringparams.get("profile-py", False) == "yes"
+    time_logger = Stopwatch("html_incremental()", log_time_info)
+
+    # support publisher file, and subtree argument
+    if pub_file:
+        stringparams["publisher"] = pub_file
+    if xmlid_root:
+        stringparams["subtree"] = xmlid_root
+
+    # Optional extra XSL could be None, or sanitized full filename
+    if extra_xsl:
+        extraction_xslt = extra_xsl
+    else:
+        extraction_xslt = os.path.join(get_ptx_xsl_path(), "pretext-html.xsl")
+
+    log.info("incremental convertsion of {} to HTML in {}".format(xml, dest_dir))
+    xsltproc(extraction_xslt, xml, None, dest_dir, stringparams)
+    time_logger.log("xsltproc complete")
+
+
 def revealjs(
     xml, pub_file, stringparams, xmlid_root, file_format, extra_xsl, out_file, dest_dir
 ):

pretext/pretext

@@ -783,6 +783,37 @@ def main():
                 dest_dir,
                 None
             )
+        elif args.format == "html-incremental":
+            # -----------------------------------------
+            # Setup - this work could be done one time in a frontend that is monitoring changes
+            # Force incremental build flag
+            stringparams["html.build-incremental"] = "yes"
+            
+            log_time_info = stringparams.get("profile-py", False) == "yes"
+            time_logger = ptx.Stopwatch("pretext:html-incremental", log_time_info)
+
+            # attempt to reuse RS services
+            if "debug.rs.dev" in stringparams:
+                rs_js, rs_css, rs_cdn_url, rs_version, services_xml = ptx._runestone_debug_service_info()
+            else:
+                rs_js, rs_css, rs_cdn_url, rs_version = ptx.query_existing_runestone_services(
+                    dest_dir=dest_dir,
+                    stringparams=stringparams
+                )
+            ptx._set_runestone_stringparams(stringparams, rs_js, rs_css, rs_version)
+            time_logger.log("runestone stringparams set")
+
+            # -----------------------------------------
+            # Actual incremental build, this is the only work done on each change
+            ptx.html_incremental(
+                xml=xml_source,
+                pub_file=publication_file,
+                stringparams=stringparams,
+                xmlid_root=args.xmlid,
+                extra_xsl=extra_stylesheet,
+                dest_dir=dest_dir,
+            )
+            time_logger.log("complete incremental build")
         elif args.format == "html-zip":
             # no "subtree root" build is possible
             ptx.html(