quartz-research-note/quartz/plugins/transformers/links.ts

121 lines
4.3 KiB
TypeScript
Raw Normal View History

import { QuartzTransformerPlugin } from "../types"
2023-07-23 00:27:41 +00:00
import {
CanonicalSlug,
RelativeURL,
canonicalizeServer,
joinSegments,
pathToRoot,
resolveRelative,
splitAnchor,
transformInternalLink,
} from "../../path"
import path from "path"
2023-07-23 00:27:41 +00:00
import { visit } from "unist-util-visit"
import isAbsoluteUrl from "is-absolute-url"
interface Options {
/** How to resolve Markdown paths */
2023-07-23 00:27:41 +00:00
markdownLinkResolution: "absolute" | "relative" | "shortest"
/** Strips folders from a link so that it looks nice */
prettyLinks: boolean
}
const defaultOptions: Options = {
2023-07-23 00:27:41 +00:00
markdownLinkResolution: "absolute",
2023-06-20 03:37:45 +00:00
prettyLinks: true,
}
2023-06-20 03:37:45 +00:00
export const CrawlLinks: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
const opts = { ...defaultOptions, ...userOpts }
return {
name: "LinkProcessing",
2023-07-24 07:04:01 +00:00
htmlPlugins(ctx) {
2023-07-23 00:27:41 +00:00
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") {
// if the file name is unique, then it's just the filename
2023-07-24 07:04:01 +00:00
const matchingFileNames = ctx.allSlugs.filter((slug) => {
2023-07-23 00:27:41 +00:00
const parts = slug.split(path.posix.sep)
const fileName = parts.at(-1)
return targetCanonical === fileName
})
2023-07-10 02:32:24 +00:00
// only match, just use it
2023-07-23 00:27:41 +00:00
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)
2023-07-10 02:32:24 +00:00
}
2023-07-23 00:27:41 +00:00
// treat as absolute
return joinSegments(pathToRoot(curSlug), targetSlug) as RelativeURL
}
2023-07-23 00:27:41 +00:00
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
2023-07-23 21:02:57 +00:00
node.properties.className ??= []
node.properties.className.push(isAbsoluteUrl(dest) ? "external" : "internal")
2023-07-23 00:27:41 +00:00
// don't process external links or intra-document anchors
if (!(isAbsoluteUrl(dest) || dest.startsWith("#"))) {
dest = node.properties.href = transformLink(dest)
2023-08-03 06:04:26 +00:00
const canonicalDest = path.posix.normalize(joinSegments(curSlug, dest))
2023-07-23 00:27:41 +00:00
const [destCanonical, _destAnchor] = splitAnchor(canonicalDest)
outgoing.add(destCanonical as CanonicalSlug)
}
2023-06-20 03:37:45 +00:00
2023-07-23 00:27:41 +00:00
// 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)
}
}
2023-07-23 00:27:41 +00:00
// 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(joinSegments("assets", node.properties.src)) + ext
2023-07-23 00:27:41 +00:00
}
}
2023-07-23 00:27:41 +00:00
})
2023-07-23 00:27:41 +00:00
file.data.links = [...outgoing]
}
},
]
},
}
}
2023-06-20 03:37:45 +00:00
2023-07-23 00:27:41 +00:00
declare module "vfile" {
2023-06-20 03:37:45 +00:00
interface DataMap {
2023-07-13 07:19:35 +00:00
links: CanonicalSlug[]
2023-06-20 03:37:45 +00:00
}
}