nnw-theme 2.3.0 → 2.5.0

package/dist/validate.js

@@ -2,7 +2,7 @@ import { existsSync, lstatSync, readdirSync, readFileSync, statSync } from "node
 import { dirname, join } from "node:path";
 import { Parser } from "htmlparser2";
 import { PlistReal, parsePlist } from "./plist.js";
-import { PLACEHOLDER_MARKER, REQUIRED_THEME_FILES, readPlist, ThemeError, themeStem, } from "./project.js";
+import { PLACEHOLDER_MARKER, REQUIRED_THEME_FILES, readPlist, TEMPLATE_7_3_FILE, ThemeError, themeStem, } from "./project.js";
 import { pyRepr } from "./pyformat.js";
 import { urlsplit } from "./urlparse.js";
 import { readZip } from "./zip.js";
@@ -67,6 +67,7 @@ function isRemote(value) {
 }
 function isAllowedFile(name) {
     return (REQUIRED_THEME_FILES.includes(name) ||
+        name === TEMPLATE_7_3_FILE ||
         OPTIONAL_THEME_FILE.test(name.toUpperCase()));
 }
 function isInt(value) {
@@ -148,38 +149,40 @@ export function validateSource(theme, { allowRemoteMedia = false } = {}) {
     const metadataReport = validateMetadata(readPlist(theme), stem);
     report.errors.push(...metadataReport.errors);
     report.warnings.push(...metadataReport.warnings);
-    const templatePath = join(theme, "template.html");
-    if (isRegularFile(templatePath)) {
-        const template = readFileSync(templatePath, "utf8");
-        if (!template.includes("[[")) {
-            report.warnings.push("template.html contains no NetNewsWire macros");
-        }
-        const commented = commentedMacros(template);
-        if (commented.length) {
-            report.errors.push(`template.html has macros inside an HTML comment (${commented[0]}` +
-                `${commented.length > 1 ? ` and ${commented.length - 1} more` : ""}). ` +
-                "NetNewsWire substitutes them there too, so an article containing --> " +
-                "ends the comment early and the rest shows as text; " +
-                "write macro names without double brackets");
-        }
-        const references = resourceReferences(template);
-        if (/<style\b[^>]*>[\s\S]*?@import\s/i.test(template)) {
-            report.errors.push("CSS @import is not allowed in template.html");
-        }
-        for (const [tag, attribute, value] of references) {
-            if (!value ||
-                ["data:", "#", "mailto:", "tel:"].some((prefix) => value.startsWith(prefix))) {
-                continue;
+    for (const templateName of ["template.html", TEMPLATE_7_3_FILE]) {
+        const templatePath = join(theme, templateName);
+        if (isRegularFile(templatePath)) {
+            const template = readFileSync(templatePath, "utf8");
+            if (!template.includes("[[")) {
+                report.warnings.push(`${templateName} contains no NetNewsWire macros`);
             }
-            if (tag === "script" || tag === "stylesheet") {
-                report.errors.push(`external ${tag} is not allowed: ${value}`);
+            const commented = commentedMacros(template);
+            if (commented.length) {
+                report.errors.push(`${templateName} has macros inside an HTML comment (${commented[0]}` +
+                    `${commented.length > 1 ? ` and ${commented.length - 1} more` : ""}). ` +
+                    "NetNewsWire substitutes them there too, so an article containing --> " +
+                    "ends the comment early and the rest shows as text; " +
+                    "write macro names without double brackets");
             }
-            else if (isRemote(value)) {
-                remoteMessage(report, `remote theme-owned ${tag} may not load in NetNewsWire: ${value}`, allowRemoteMedia);
+            const references = resourceReferences(template);
+            if (/<style\b[^>]*>[\s\S]*?@import\s/i.test(template)) {
+                report.errors.push(`CSS @import is not allowed in ${templateName}`);
             }
-            else if (!value.includes("[[")) {
-                report.errors.push("bundle-local resource references do not work in NetNewsWire: " +
-                    `${attribute}=${pyRepr(value)}`);
+            for (const [tag, attribute, value] of references) {
+                if (!value ||
+                    ["data:", "#", "mailto:", "tel:"].some((prefix) => value.startsWith(prefix))) {
+                    continue;
+                }
+                if (tag === "script" || tag === "stylesheet") {
+                    report.errors.push(`external ${tag} is not allowed: ${value}`);
+                }
+                else if (isRemote(value)) {
+                    remoteMessage(report, `remote theme-owned ${tag} may not load in NetNewsWire: ${value}`, allowRemoteMedia);
+                }
+                else if (!value.includes("[[")) {
+                    report.errors.push("bundle-local resource references do not work in NetNewsWire: " +
+                        `${attribute}=${pyRepr(value)}`);
+                }
             }
         }
     }

package/lldb/nnwdump.py

@@ -6,9 +6,11 @@ writes it as a TOML fixture. `npx nnw-theme@2 capture` prints the setup steps.
 
 NetNewsWire with enclosure support renders an article's enclosures into that
 dictionary: as `enclosures`, or appended to a wrapped `body` when the template has no
-[[enclosures]] macro. nnwdump keeps neither. It records the article's attachments
+[[enclosures]] macro, and 7.3b6 and later add `primary_media`. nnwdump keeps none of them. It records the article's attachments
 and image instead, as [[attachments]] tables and image_url/thumbnail_url, so nnw-theme
-renders them for whichever template previews the fixture.
+renders them for whichever template previews the fixture. When the page's base URL
+differs from the article's link, as for an article synced through the Reader API, it
+also records base_url.
 
 Values cross the debugger boundary base64-encoded, so nothing is truncated or
 mis-escaped. HTML values are written as '''literal''' strings, so fixtures stay
@@ -32,6 +34,7 @@ DEFAULT_OUTPUT = "fixtures/nnw-capture.toml"
 # Sorted last so the short metadata stays at the top of the file.
 _HTML_KEYS = {"body"}
 _ENCLOSURES_KEY = "enclosures"
+_PRIMARY_MEDIA_KEY = "primary_media"
 # ArticleRenderer's body for a template without [[enclosures]]: <div>BODY</div>ENCLOSURES.
 _WRAPPED_BODY_TAIL = '</div><div class="nnw-enclosures">'
 # Attachment's Codable keys, in fixture order, with their fixture names.
@@ -86,6 +89,7 @@ def without_enclosures(pairs: list[tuple[str, str]]) -> list[tuple[str, str]]:
         if body.startswith("<div>") and at != -1:
             values["body"] = body[len("<div>") : at]
     values.pop(_ENCLOSURES_KEY, None)
+    values.pop(_PRIMARY_MEDIA_KEY, None)
     return list(values.items())
 
 
@@ -103,6 +107,12 @@ def attachments_from_json(text: str) -> list[dict]:
     return tables
 
 
+def base_url_pairs(pairs: list[tuple[str, str]], base_url: str) -> list[tuple[str, str]]:
+    """base_url, when the rendered page's base differs from preferred_link."""
+    preferred = dict(pairs).get("preferred_link", "")
+    return [] if base_url == preferred else [("base_url", base_url)]
+
+
 def _toml_value_line(key: str, value) -> str:
     if isinstance(value, bool) or not isinstance(value, int):
         return toml_line(key, str(value))
@@ -194,6 +204,10 @@ def nnwdump(debugger, command, result, internal_dict):
         value, _ = _evaluate(interpreter, f'{options.article}.{link} ?? ""')
         if value:
             pairs.append((key, value))
+    # The renderer's own base: the article's link, else the feed's home page.
+    base_url, _ = _evaluate(interpreter, 'self.baseURL?.absoluteString ?? ""')
+    if base_url is not None:
+        pairs.extend(base_url_pairs(pairs, base_url))
 
     note = ""
     if attachments:

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "nnw-theme",
-	"version": "2.3.0",
+	"version": "2.5.0",
 	"description": "Create, preview, check, and publish a NetNewsWire theme.",
 	"license": "Apache-2.0",
 	"author": "Dave Marquard",