Jacky Zhao
2023-08-23 eed4472aeecdcb0f2b233df69884f03bd45fc293
quartz/plugins/transformers/links.ts
@@ -1,18 +1,28 @@
import { QuartzTransformerPlugin } from "../types"
import { CanonicalSlug, RelativeURL, canonicalizeServer, joinSegments, pathToRoot, resolveRelative, splitAnchor, transformInternalLink } from "../../path"
import {
  FullSlug,
  RelativeURL,
  SimpleSlug,
  TransformOptions,
  _stripSlashes,
  joinSegments,
  simplifySlug,
  splitAnchor,
  transformLink,
} from "../../util/path"
import path from "path"
import { visit } from 'unist-util-visit'
import { visit } from "unist-util-visit"
import isAbsoluteUrl from "is-absolute-url"
interface Options {
  /** How to resolve Markdown paths */
  markdownLinkResolution: 'absolute' | 'relative' | 'shortest'
  markdownLinkResolution: TransformOptions["strategy"]
  /** Strips folders from a link so that it looks nice */
  prettyLinks: boolean
}
const defaultOptions: Options = {
  markdownLinkResolution: 'absolute',
  markdownLinkResolution: "absolute",
  prettyLinks: true,
}
@@ -20,86 +30,89 @@
  const opts = { ...defaultOptions, ...userOpts }
  return {
    name: "LinkProcessing",
    htmlPlugins() {
      return [() => {
        return (tree, file) => {
          const curSlug = canonicalizeServer(file.data.slug!)
          const transformLink = (target: string): RelativeURL => {
            const targetSlug = transformInternalLink(target).slice("./".length)
            let [targetCanonical, targetAnchor] = splitAnchor(targetSlug)
            if (opts.markdownLinkResolution === 'relative') {
              return targetSlug as RelativeURL
            } else if (opts.markdownLinkResolution === 'shortest') {
              // https://forum.obsidian.md/t/settings-new-link-format-what-is-shortest-path-when-possible/6748/5
              const allSlugs = file.data.allSlugs!
    htmlPlugins(ctx) {
      return [
        () => {
          return (tree, file) => {
            const curSlug = simplifySlug(file.data.slug!)
            const outgoing: Set<SimpleSlug> = new Set()
              // if the file name is unique, then it's just the filename
              const matchingFileNames = allSlugs.filter(slug => {
                const parts = slug.split(path.posix.sep)
                const fileName = parts.at(-1)
                return targetCanonical === fileName
              })
              if (matchingFileNames.length === 1) {
                const targetSlug = canonicalizeServer(matchingFileNames[0])
                return resolveRelative(curSlug, targetSlug) + targetAnchor as RelativeURL
              }
              // if it's not unique, then it's the absolute path from the vault root
              // (fall-through case)
            const transformOptions: TransformOptions = {
              strategy: opts.markdownLinkResolution,
              allSlugs: ctx.allSlugs,
            }
            // treat as absolute
            return joinSegments(pathToRoot(curSlug), targetSlug) as RelativeURL
            visit(tree, "element", (node, _index, _parent) => {
              // rewrite all links
              if (
                node.tagName === "a" &&
                node.properties &&
                typeof node.properties.href === "string"
              ) {
                let dest = node.properties.href as RelativeURL
                node.properties.className ??= []
                node.properties.className.push(isAbsoluteUrl(dest) ? "external" : "internal")
                // don't process external links or intra-document anchors
                if (!(isAbsoluteUrl(dest) || dest.startsWith("#"))) {
                  dest = node.properties.href = transformLink(
                    file.data.slug!,
                    dest,
                    transformOptions,
                  )
                  // url.resolve is considered legacy
                  // WHATWG equivalent https://nodejs.dev/en/api/v18/url/#urlresolvefrom-to
                  const url = new URL(dest, `https://base.com/${curSlug}`)
                  const canonicalDest = url.pathname
                  const [destCanonical, _destAnchor] = splitAnchor(canonicalDest)
                  // need to decodeURIComponent here as WHATWG URL percent-encodes everything
                  const simple = decodeURIComponent(
                    simplifySlug(destCanonical as FullSlug),
                  ) as SimpleSlug
                  outgoing.add(simple)
                }
                // rewrite link internals if prettylinks is on
                if (
                  opts.prettyLinks &&
                  node.children.length === 1 &&
                  node.children[0].type === "text" &&
                  !node.children[0].value.startsWith("#")
                ) {
                  node.children[0].value = path.basename(node.children[0].value)
                }
              }
              // transform all other resources that may use links
              if (
                ["img", "video", "audio", "iframe"].includes(node.tagName) &&
                node.properties &&
                typeof node.properties.src === "string"
              ) {
                if (!isAbsoluteUrl(node.properties.src)) {
                  let dest = node.properties.src as RelativeURL
                  dest = node.properties.src = transformLink(
                    file.data.slug!,
                    dest,
                    transformOptions,
                  )
                  node.properties.src = dest
                }
              }
            })
            file.data.links = [...outgoing]
          }
          const outgoing: Set<CanonicalSlug> = new Set()
          visit(tree, 'element', (node, _index, _parent) => {
            // rewrite all links
            if (
              node.tagName === 'a' &&
              node.properties &&
              typeof node.properties.href === 'string'
            ) {
              let dest = node.properties.href as RelativeURL
              node.properties.className = isAbsoluteUrl(dest) ? "external" : "internal"
              // don't process external links or intra-document anchors
              if (!(isAbsoluteUrl(dest) || dest.startsWith("#"))) {
                dest = node.properties.href = transformLink(dest)
                const canonicalDest = path.normalize(joinSegments(curSlug, dest))
                const [destCanonical, _destAnchor] = splitAnchor(canonicalDest)
                outgoing.add(destCanonical as CanonicalSlug)
              }
              // rewrite link internals if prettylinks is on
              if (opts.prettyLinks && node.children.length === 1 && node.children[0].type === 'text') {
                node.children[0].value = path.basename(node.children[0].value)
              }
            }
            // transform all other resources that may use links
            if (
              ["img", "video", "audio", "iframe"].includes(node.tagName) &&
              node.properties &&
              typeof node.properties.src === 'string'
            ) {
              if (!isAbsoluteUrl(node.properties.src)) {
                const ext = path.extname(node.properties.src)
                node.properties.src = transformLink(path.join("assets", node.properties.src)) + ext
              }
            }
          })
          file.data.links = [...outgoing]
        }
      }]
    }
        },
      ]
    },
  }
}
declare module 'vfile' {
declare module "vfile" {
  interface DataMap {
    links: CanonicalSlug[]
    links: SimpleSlug[]
  }
}