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

121 lines
3.9 KiB
TypeScript
Raw Normal View History

import { QuartzTransformerPlugin } from "../types"
2023-07-23 00:27:41 +00:00
import {
FullSlug,
2023-07-23 00:27:41 +00:00
RelativeURL,
SimpleSlug,
TransformOptions,
_stripSlashes,
2023-07-23 00:27:41 +00:00
joinSegments,
simplifySlug,
2023-07-23 00:27:41 +00:00
splitAnchor,
transformLink,
} from "../../util/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 */
markdownLinkResolution: TransformOptions["strategy"]
/** 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 = simplifySlug(file.data.slug!)
const outgoing: Set<SimpleSlug> = new Set()
2023-07-10 02:32:24 +00:00
const transformOptions: TransformOptions = {
strategy: opts.markdownLinkResolution,
allSlugs: ctx.allSlugs,
}
2023-07-23 00:27:41 +00:00
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
2023-09-07 03:25:38 +00:00
const isInternal = !(isAbsoluteUrl(dest) || dest.startsWith("#"))
if (isInternal) {
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
2023-08-23 19:18:50 +00:00
const url = new URL(dest, `https://base.com/${curSlug}`)
2023-08-19 23:28:44 +00:00
const canonicalDest = url.pathname
2023-07-23 00:27:41 +00:00
const [destCanonical, _destAnchor] = splitAnchor(canonicalDest)
2023-08-22 16:16:55 +00:00
// need to decodeURIComponent here as WHATWG URL percent-encodes everything
const simple = decodeURIComponent(
simplifySlug(destCanonical as FullSlug),
) as SimpleSlug
outgoing.add(simple)
2023-07-23 00:27:41 +00:00
}
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 &&
2023-09-07 03:25:38 +00:00
isInternal &&
2023-07-23 00:27:41 +00:00
node.children.length === 1 &&
2023-08-12 06:40:06 +00:00
node.children[0].type === "text" &&
!node.children[0].value.startsWith("#")
2023-07-23 00:27:41 +00:00
) {
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)) {
let dest = node.properties.src as RelativeURL
dest = node.properties.src = transformLink(
file.data.slug!,
dest,
transformOptions,
)
node.properties.src = dest
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 {
links: SimpleSlug[]
2023-06-20 03:37:45 +00:00
}
}