fix: process comments at a text level rather than a markdown level

Jacky Zhao

2024-01-22 cd826fb4774795004bfba1b5edd0f2fc8b4b435c

 quartz/plugins/transformers/ofm.ts

@@ -1,10 +1,10 @@
import { QuartzTransformerPlugin } from "../types"
import { Root, Html, BlockContent, DefinitionContent, Paragraph, Code } from "mdast"
import { Root, Html, Image, BlockContent, DefinitionContent, Paragraph, Code } from "mdast"
import { Element, Literal, Root as HtmlRoot } from "hast"
import { ReplaceFunction, findAndReplace as mdastFindReplace } from "mdast-util-find-and-replace"
import { slug as slugAnchor } from "github-slugger"
import rehypeRaw from "rehype-raw"
import { visit } from "unist-util-visit"
import { SKIP, visit } from "unist-util-visit"
import path from "path"
import { JSResource } from "../../util/resources"
// @ts-ignore
@@ -23,6 +23,7 @@
  callouts: boolean
  mermaid: boolean
  parseTags: boolean
  parseArrows: boolean
  parseBlockReferences: boolean
  enableInHtmlEmbed: boolean
  enableYouTubeEmbed: boolean
@@ -36,10 +37,11 @@
  callouts: true,
  mermaid: true,
  parseTags: true,
  parseArrows: true,
  parseBlockReferences: true,
  enableInHtmlEmbed: false,
  enableYouTubeEmbed: true,
  enableVideoEmbed: false,
  enableVideoEmbed: true,
}

const icons = {
@@ -111,6 +113,8 @@

export const externalLinkRegex = /^https?:\/\//i

export const arrowRegex = new RegExp(/-{1,2}>/, "g")

// !?               -> optional embedding
// \[\[             -> open brace
// ([^\[\]\|\#]+)   -> one or more non-special characters ([,],|, or #) (name)
@@ -130,7 +134,7 @@
// (?:[-_\p{L}\d\p{Z}])+       -> non-capturing group, non-empty string of (Unicode-aware) alpha-numeric characters and symbols, hyphens and/or underscores
// (?:\/[-_\p{L}\d\p{Z}]+)*)   -> non-capturing group, matches an arbitrary number of tag strings separated by "/"
const tagRegex = new RegExp(/(?:^| )#((?:[-_\p{L}\p{Emoji}\d])+(?:\/[-_\p{L}\p{Emoji}\d]+)*)/, "gu")
const blockReferenceRegex = new RegExp(/\^([A-Za-z0-9]+)$/, "g")
const blockReferenceRegex = new RegExp(/\^([-_A-Za-z0-9]+)$/, "g")
const ytLinkRegex = /^.*(youtu.be\/|v\/|u\/\w\/|embed\/|watch\?v=|\&v=)([^#\&\?]*).*/
const videoExtensionRegex = new RegExp(/\.(mp4|webm|ogg|avi|mov|flv|wmv|mkv|mpg|mpeg|3gp|m4v)$/)

@@ -159,6 +163,14 @@
        })
      }

      // do comments at text level
      if (opts.comments) {
        if (src instanceof Buffer) {
          src = src.toString()
        }
        src.replace(commentRegex, "")
      }

      // pre-transform wikilinks (fix anchors to things that may contain illegal syntax e.g. codeblocks, latex)
      if (opts.wikilinks) {
        if (src instanceof Buffer) {
@@ -282,13 +294,13 @@
            ])
          }

          if (opts.comments) {
          if (opts.parseArrows) {
            replacements.push([
              commentRegex,
              arrowRegex,
              (_value: string, ..._capture: string[]) => {
                return {
                  type: "text",
                  value: "",
                  type: "html",
                  value: `<span>&rarr;</span>`,
                }
              },
            ])
@@ -357,17 +369,14 @@
        plugins.push(() => {
          return (tree: Root, _file) => {
            visit(tree, "image", (node, index, parent) => {
              const match = node.url.match(videoExtensionRegex)
              if (parent && match) {
                const htmlNode: PhrasingContent = {
              if (parent && index != undefined && videoExtensionRegex.test(node.url)) {
                const newNode: Html = {
                  type: "html",
                  value: `<video controls src="${node.url}" controls></video>`,
                  value: `<video controls src="${node.url}"></video>`,
                }
                if (index && index >= 0 && index < parent.children.length) {
                  parent.children.splice(index, 1, htmlNode)
                } else {
                  console.warn("Warning: Invalid index, htmlNode not added")
                }

                parent.children.splice(index, 1, newNode)
                return SKIP
              }
            })
          }