vowel 0.6.3 → 0.6.4

package/plugins/markdown/metadata.js

@@ -0,0 +1,147 @@
+import { toString as mdastToString } from 'mdast-util-to-string'
+import extractDate from "./../../extractDate.js"
+import { testURL, toTitleCase } from "./../../utils.js"
+import yaml from 'yaml'
+import path from "node:path"
+
+
+/**
+- menu_item: true | false
+- secret_url: true | false
+*/
+
+/**
+ * @param {object} tree
+ * @param {string} filePath
+ * @param {string} targetPath
+ */
+function getMetadata(tree, filePath, targetPath) {
+  const metadata = {}
+
+  for (let i = 0; i < tree.children.length; i++) {
+    const child = tree.children[i]
+    const text = mdastToString(child)
+    switch (child.type) {
+      case "paragraph":
+        if (child.children.length !== 1) {
+          if (!metadata.fm_description && !metadata.inferred_description) {
+            metadata.inferred_description = text
+          }
+          i = Infinity
+          break
+        } else if (child.children[0].type === "image") {
+          metadata.inferred_image = child.children[0].url
+          metadata.inferred_alt_text = child.children[0].alt
+          break
+        } else if (testURL(text)) {
+          const url = new URL(text)
+          if (text.match(/\.(jpeg|jpg|png)$/)) {
+            metadata.inferred_image = url
+            break
+          } else {
+            metadata.inferred_link = url
+            break
+          }
+        } else {
+          const inferred_date = extractDate(mdastToString(child))
+          if (inferred_date) {
+            metadata.inferred_date = inferred_date
+          } else {
+            if (!metadata.fm_description && !metadata.inferred_description) {
+              metadata.inferred_description = text
+            }
+            // tree.children.splice(0, i + 1)
+            i = Infinity
+          }
+          break
+        }
+      case "heading":
+        if (child.depth === 1) {
+          metadata.inferred_title = mdastToString(child) || toTitleCase(path.parse(filePath).name)
+          tree.children.splice(0, i + 1)
+        } else {
+          i = Infinity;
+        }
+        break
+      case "yaml":
+        const frontmatter = yaml.parse(child.value)
+        for (const key in frontmatter) {
+          const reservedProperties = ["rss_item", "sitemap_item", "html_file", "global_menu_item", "local_menu_item", "secret_key", "theme", "logo", "wordmark", "breadcrumb"]
+          if (reservedProperties.includes(key)) {
+            metadata[key] = frontmatter[key]
+          } else {
+            metadata["fm_" + key] = frontmatter[key]
+          }
+        }
+        break
+      default:
+        i = Infinity
+        break
+    }
+  }
+
+
+  const pathInfo = path.parse(filePath)
+
+  metadata.inferred_label = toTitleCase(pathInfo.name)
+
+  if (targetPath) {
+    const targetInfo = path.parse(targetPath)
+    const name = targetInfo.name === "index" ? "" : targetInfo.name
+    // FIXME the prettyURL should include the preceding slash
+    metadata.prettyURL = (new URL(`${targetInfo.dir}/${name}`, "thismessage:/")).pathname
+  }
+
+  selectMetadata(metadata)
+
+  return metadata
+}
+
+
+
+function selectMetadata(metadata) {
+  const date =
+    metadata.fm_date
+    || metadata.inferred_date
+
+  if (date) {
+    metadata.date = date
+  }
+
+  const title =
+    metadata.fm_title
+    || metadata.inferred_title
+    || metadata.inferred_label
+
+  if (title) {
+    metadata.title = title
+  }
+
+  const breadcrumb =
+    metadata.fm_breadcrumb
+    || metadata.title
+    || metadata.inferred_label
+
+  if (breadcrumb) {
+    metadata.breadcrumb = breadcrumb
+  }
+
+  const description =
+    metadata.fm_description
+    || metadata.tagline
+    || metadata.inferred_description
+
+  if (description) {
+    metadata.description = description
+  }
+
+  const image =
+    metadata.fm_image
+    || metadata.inferred_image
+
+  if (image) {
+    metadata.image = image
+  }
+}
+
+export default getMetadata

package/plugins/markdown/robots.js

@@ -0,0 +1,18 @@
+function generateRobots() {
+  return `User-agent: Google-Extended
+Allow: /
+
+User-agent: Googlebot-Image
+Disallow: /
+
+User-agent: GPTBot
+Disallow: /
+
+User-agent: ChatGPT-User
+Disallow: /
+
+User-agent: CCBot
+Disallow: /`
+}
+
+export default generateRobots

package/plugins/styles/index.js

@@ -1,13 +1,12 @@
-import path from "node:path"
 import { transform } from "lightningcss"
 
 /** @import * as Votive from "votive" */
 
 /** @type {Votive.ProcessorWrite} */
-function writeCSS(destination, database, config) {
+function writeCSS(target, settings, api, config) {
   const { code, map } = transform({
-    filename: destination.path,
-    code: Buffer.from(destination.abstract.css),
+    filename: target.path,
+    code: Buffer.from(target.abstract.css),
     minify: true,
     targets: {
       chrome: 140 << 16,
@@ -27,15 +26,7 @@ function writeCSS(destination, database, config) {
 
 
 /** @type {Votive.ReadText} */
-function readCSS(text, filePath, destinationPath, database, config) {
-  const pathInfo = path.parse(filePath)
-
-  database.setting.create(
-    pathInfo.dir,
-    "stylesheets",
-    filePath
-  )
-
+function readCSS(text, filePath, targetPath, api, config) {
   const metadata = {}
   const abstract = {
     css: text
@@ -43,7 +34,8 @@ function readCSS(text, filePath, destinationPath, database, config) {
 
   return {
     metadata,
-    abstract
+    abstract,
+    settings: { stylesheets: [filePath] }
   }
 }
 

package/plugins/urls/index.js

@@ -0,0 +1,91 @@
+import { parseURLMetadata } from "votive/internals"
+
+/** @import * as Votive from "votive" */
+
+const EXTERNAL_LINK_RE = /^https?:\/\/\S+$/
+
+/**
+ * Matches a markdown paragraph whose only content is a bare URL - see
+ * CLAUDE.md: "a URL that is the only child of a paragraph" -
+ *   Dinosaurs lived 65,000,000 years ago.
+ *
+ *   https://dinosaurs.com/timeline
+ *
+ *   We still find their fossils today.
+ * Same shape html/index.js's own `testPaths` already matches for
+ * internal single-link paragraphs (one text-only child) - this is the
+ * external-URL counterpart.
+ * @param {any} node
+ */
+function isExternalLinkParagraph(node) {
+  if (node.type !== "element") return false
+  if (node.tagName !== "p") return false
+  if (node.children.length !== 1) return false
+  const [child] = node.children
+  if (!child || typeof child.value !== "string") return false
+  return EXTERNAL_LINK_RE.test(child.value)
+}
+
+/**
+ * Walks a target's abstract for link-preview paragraphs and queues one
+ * fetch task per URL found, so the write side (html/index.js) can render
+ * a preview card once the data is cached. Deliberately does not fetch
+ * anything itself - tasks are only ever run when the caller invokes
+ * runFetches() (see votive's fetchURLs.js), and a URL already cached
+ * (success or in a failure cooldown) is skipped automatically, so this
+ * never re-fetches the same link on every build.
+ * @type {Votive.ReadAbstract}
+ */
+function transformFile(abstract, settings, api, config, targetFilePath) {
+  const urls = []
+
+  function walk(node) {
+    if (!node || typeof node !== "object") return
+    if (isExternalLinkParagraph(node)) {
+      urls.push({
+        data: node.children[0].value,
+        runner: "text",
+        target: targetFilePath
+      })
+      return
+    }
+    if (Array.isArray(node.children)) node.children.forEach(walk)
+  }
+
+  walk(abstract)
+
+  return { abstract, urls }
+}
+
+/**
+ * Parses a fetched page into the flat shape link-preview rendering
+ * wants, preferring OpenGraph, then standard meta tags, then Twitter
+ * Card, for each field independently.
+ * @param {string} html
+ * @returns {{ title: string, description: string, image: string | undefined }}
+ */
+function parseLinkPreview(html) {
+  const meta = parseURLMetadata(html)
+  return {
+    title: meta.openGraph.title || meta.title || meta.twitterCard.title || "",
+    description: meta.openGraph.description || meta.description || meta.twitterCard.description || "",
+    image: meta.openGraph.image || meta.twitterCard.image || undefined
+  }
+}
+
+/** @type {Votive.VotiveProcessor} */
+const linkPreviewProcessor = {
+  extensions: [".html"],
+  format: "text",
+  transformFile,
+  readURL: parseLinkPreview
+}
+
+/** @type {Votive.VotivePlugin} */
+const vowelURLsPlugin = {
+  name: "vowel-urls",
+  processors: [linkPreviewProcessor]
+}
+
+export default vowelURLsPlugin
+export { isExternalLinkParagraph, parseLinkPreview }

package/plugins/vectors/index.js

@@ -14,7 +14,7 @@ async function writeFile(target) {
 const processor = {
   extensions: [".svg"],
   format: "text",
-  readFile: (text, filePath, destinationPath, database) => {
+  readFile: (text, filePath, targetPath, api) => {
     const monochrome = text.includes("currentColor") || Boolean(text.match(/#000\b/))
     return {
       abstract: { svg: text },

package/plugins/xml/index.js

@@ -7,18 +7,23 @@ import xml from "xml"
 const processor = {
   extensions: [".xml"],
   format: "text",
-  writeFile: (target, database) => {
+  writeFile: (target, settings, api) => {
     if (target.path === "sitemap.xml") {
-
       // FIXME move the filter to SQLite
-      const pages = database.target
-        .getManyWithTrackers({
+      const pages = api
+        .targets({
           folder: "",
           recursive: true,
-          query: {},
-          dependent: "sitemap.xml"
+          query: {
+            "!": {
+              "|": {
+                "sitemap_item": false,
+                "html_file": false
+              }
+            }
+          },
         })
-        .filter(a => a.syntax === ".html" && a.path)
+        .filter(a => a.extension === ".html" && a.path)
 
       const domain = target.metadata.domain
         && target.metadata.domain.startsWith("http")
@@ -58,19 +63,22 @@ const processor = {
 
       return {
         data: sitemap,
-        jobs: []
+        urls: []
       }
 
     } else if (target.path === "feed.xml") {
 
-      const pages = database.target.getManyWithTrackers({
-        query: {},
+      const pages = api.targets({
+        query: {
+          "!": {
+            rss_item: false
+          }
+        },
         folder: "",
         recursive: true,
-        dependent: "feed.xml"
+        orderBy: { property: "date", direction: "desc" }
       })
         .filter(a => a.metadata.date)
-        .sort((a, b) => b.metadata.date - a.metadata.date)
 
       const domain = target.metadata.domain
         && target.metadata.domain.startsWith("http")
@@ -87,7 +95,7 @@ const processor = {
         },
         {
           title: target.metadata.title
-        }
+        },
       )
 
 
@@ -119,7 +127,6 @@ const processor = {
         ...pages.map((page) => {
           const url = (new URL(page.path, domain)).href
 
-
           /** @type {object[]} */
           const entry = [
             {
@@ -151,6 +158,10 @@ const processor = {
             });
           }
 
+          entry.push({
+            content: page.data
+          })
+
           // TODO consider rendering full page in RSS
 
           /*

package/stylesheets/SyntaxHighlightingStyles.css

@@ -0,0 +1,237 @@
+/*
+ * Syntax highlighting theme for code blocks (rehype-highlight), based on
+ * highlight.js's GitHub theme. Light by default, dark under
+ * prefers-color-scheme - see highlight.js/styles/github.css and
+ * github-dark.css for the source themes this was combined from.
+ */
+pre code.hljs {
+  display: block;
+  overflow-x: auto;
+  padding: 1em
+}
+code.hljs {
+  padding: 3px 5px
+}
+/*!
+  Theme: GitHub
+  Description: Light theme as seen on github.com
+  Author: github.com
+  Maintainer: @Hirse
+  Updated: 2021-05-15
+
+  Outdated base version: https://github.com/primer/github-syntax-light
+  Current colors taken from GitHub's CSS
+*/
+.hljs {
+  color: #24292e;
+  background: #ffffff
+}
+.hljs-doctag,
+.hljs-keyword,
+.hljs-meta .hljs-keyword,
+.hljs-template-tag,
+.hljs-template-variable,
+.hljs-type,
+.hljs-variable.language_ {
+  /* prettylights-syntax-keyword */
+  color: #d73a49
+}
+.hljs-title,
+.hljs-title.class_,
+.hljs-title.class_.inherited__,
+.hljs-title.function_ {
+  /* prettylights-syntax-entity */
+  color: #6f42c1
+}
+.hljs-attr,
+.hljs-attribute,
+.hljs-literal,
+.hljs-meta,
+.hljs-number,
+.hljs-operator,
+.hljs-variable,
+.hljs-selector-attr,
+.hljs-selector-class,
+.hljs-selector-id {
+  /* prettylights-syntax-constant */
+  color: #005cc5
+}
+.hljs-regexp,
+.hljs-string,
+.hljs-meta .hljs-string {
+  /* prettylights-syntax-string */
+  color: #032f62
+}
+.hljs-built_in,
+.hljs-symbol {
+  /* prettylights-syntax-variable */
+  color: #e36209
+}
+.hljs-comment,
+.hljs-code,
+.hljs-formula {
+  /* prettylights-syntax-comment */
+  color: #6a737d
+}
+.hljs-name,
+.hljs-quote,
+.hljs-selector-tag,
+.hljs-selector-pseudo {
+  /* prettylights-syntax-entity-tag */
+  color: #22863a
+}
+.hljs-subst {
+  /* prettylights-syntax-storage-modifier-import */
+  color: #24292e
+}
+.hljs-section {
+  /* prettylights-syntax-markup-heading */
+  color: #005cc5;
+  font-weight: bold
+}
+.hljs-bullet {
+  /* prettylights-syntax-markup-list */
+  color: #735c0f
+}
+.hljs-emphasis {
+  /* prettylights-syntax-markup-italic */
+  color: #24292e;
+  font-style: italic
+}
+.hljs-strong {
+  /* prettylights-syntax-markup-bold */
+  color: #24292e;
+  font-weight: bold
+}
+.hljs-addition {
+  /* prettylights-syntax-markup-inserted */
+  color: #22863a;
+  background-color: #f0fff4
+}
+.hljs-deletion {
+  /* prettylights-syntax-markup-deleted */
+  color: #b31d28;
+  background-color: #ffeef0
+}
+.hljs-char.escape_,
+.hljs-link,
+.hljs-params,
+.hljs-property,
+.hljs-punctuation,
+.hljs-tag {
+  /* purposely ignored */
+  
+}
+
+@media (prefers-color-scheme: dark) {
+  /*!
+    Theme: GitHub Dark
+    Description: Dark theme as seen on github.com
+    Author: github.com
+    Maintainer: @Hirse
+    Updated: 2021-05-15
+
+    Outdated base version: https://github.com/primer/github-syntax-dark
+    Current colors taken from GitHub's CSS
+  */
+  .hljs {
+    color: #c9d1d9;
+    background: #0d1117
+  }
+  .hljs-doctag,
+  .hljs-keyword,
+  .hljs-meta .hljs-keyword,
+  .hljs-template-tag,
+  .hljs-template-variable,
+  .hljs-type,
+  .hljs-variable.language_ {
+    /* prettylights-syntax-keyword */
+    color: #ff7b72
+  }
+  .hljs-title,
+  .hljs-title.class_,
+  .hljs-title.class_.inherited__,
+  .hljs-title.function_ {
+    /* prettylights-syntax-entity */
+    color: #d2a8ff
+  }
+  .hljs-attr,
+  .hljs-attribute,
+  .hljs-literal,
+  .hljs-meta,
+  .hljs-number,
+  .hljs-operator,
+  .hljs-variable,
+  .hljs-selector-attr,
+  .hljs-selector-class,
+  .hljs-selector-id {
+    /* prettylights-syntax-constant */
+    color: #79c0ff
+  }
+  .hljs-regexp,
+  .hljs-string,
+  .hljs-meta .hljs-string {
+    /* prettylights-syntax-string */
+    color: #a5d6ff
+  }
+  .hljs-built_in,
+  .hljs-symbol {
+    /* prettylights-syntax-variable */
+    color: #ffa657
+  }
+  .hljs-comment,
+  .hljs-code,
+  .hljs-formula {
+    /* prettylights-syntax-comment */
+    color: #8b949e
+  }
+  .hljs-name,
+  .hljs-quote,
+  .hljs-selector-tag,
+  .hljs-selector-pseudo {
+    /* prettylights-syntax-entity-tag */
+    color: #7ee787
+  }
+  .hljs-subst {
+    /* prettylights-syntax-storage-modifier-import */
+    color: #c9d1d9
+  }
+  .hljs-section {
+    /* prettylights-syntax-markup-heading */
+    color: #1f6feb;
+    font-weight: bold
+  }
+  .hljs-bullet {
+    /* prettylights-syntax-markup-list */
+    color: #f2cc60
+  }
+  .hljs-emphasis {
+    /* prettylights-syntax-markup-italic */
+    color: #c9d1d9;
+    font-style: italic
+  }
+  .hljs-strong {
+    /* prettylights-syntax-markup-bold */
+    color: #c9d1d9;
+    font-weight: bold
+  }
+  .hljs-addition {
+    /* prettylights-syntax-markup-inserted */
+    color: #aff5b4;
+    background-color: #033a16
+  }
+  .hljs-deletion {
+    /* prettylights-syntax-markup-deleted */
+    color: #ffdcd7;
+    background-color: #67060c
+  }
+  .hljs-char.escape_,
+  .hljs-link,
+  .hljs-params,
+  .hljs-property,
+  .hljs-punctuation,
+  .hljs-tag {
+    /* purposely ignored */
+    
+  }
+}

package/utils.js

@@ -1,6 +1,5 @@
 import {fromMarkdown} from 'mdast-util-from-markdown'
 import {toHast} from 'mdast-util-to-hast'
-import {toHtml} from 'hast-util-to-html'
 import path from "node:path"
 import { randomUUID } from "node:crypto"
 
@@ -75,6 +74,7 @@ export function toTitleCase(string) {
 export function createHashtagPage(tag) {
   const markdown = `# ${toTitleCase(tag)}\n\n/**?tag=${tag}`
   const mdast = fromMarkdown(markdown)
+  const hast = toHast(mdast)
 
-  return mdast
+  return hast
 }