From 3ac6b42e16dca5a44ed3fec2c0314f1dbbc2322b Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Sun, 16 Jul 2023 06:02:12 +0000
Subject: [PATCH] finish path refactoring, add sourcemap + better trace support
---
quartz/plugins/transformers/links.ts | 75 +++++++++++++++++++------------------
1 files changed, 38 insertions(+), 37 deletions(-)
diff --git a/quartz/plugins/transformers/links.ts b/quartz/plugins/transformers/links.ts
index 3083ce7..da1c343 100644
--- a/quartz/plugins/transformers/links.ts
+++ b/quartz/plugins/transformers/links.ts
@@ -1,46 +1,59 @@
import { QuartzTransformerPlugin } from "../types"
-import { relative, relativeToRoot, slugify, trimPathSuffix } from "../../path"
+import { CanonicalSlug, RelativeURL, canonicalizeServer, joinSegments, pathToRoot, resolveRelative, splitAnchor, transformInternalLink } from "../../path"
import path from "path"
import { visit } from 'unist-util-visit'
import isAbsoluteUrl from "is-absolute-url"
interface Options {
/** How to resolve Markdown paths */
- markdownLinkResolution: 'absolute' | 'relative'
+ markdownLinkResolution: 'absolute' | 'relative' | 'shortest'
/** Strips folders from a link so that it looks nice */
prettyLinks: boolean
- indexAnchorLinks: boolean
- indexExternalLinks: boolean
}
const defaultOptions: Options = {
markdownLinkResolution: 'absolute',
prettyLinks: true,
- indexAnchorLinks: false,
- indexExternalLinks: false,
}
export const CrawlLinks: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
const opts = { ...defaultOptions, ...userOpts }
return {
name: "LinkProcessing",
- markdownPlugins() {
- return []
- },
htmlPlugins() {
return [() => {
return (tree, file) => {
- const curSlug = file.data.slug!
- const transformLink = (target: string) => {
- const targetSlug = slugify(decodeURI(target).trim())
- if (opts.markdownLinkResolution === 'relative' && !path.isAbsolute(targetSlug)) {
- return './' + relative(curSlug, targetSlug)
- } else {
- return './' + relativeToRoot(curSlug, targetSlug)
+ 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!
+
+ // 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)
}
+
+ // treat as absolute
+ return joinSegments(pathToRoot(curSlug), targetSlug) as RelativeURL
}
- const outgoing: Set<string> = new Set()
+ const outgoing: Set<CanonicalSlug> = new Set()
visit(tree, 'element', (node, _index, _parent) => {
// rewrite all links
if (
@@ -48,27 +61,15 @@
node.properties &&
typeof node.properties.href === 'string'
) {
- let dest = node.properties.href
+ 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("#"))) {
- node.properties.href = transformLink(dest)
- }
-
- dest = node.properties.href
- if (dest.startsWith(".")) {
- const normalizedPath = path.normalize(path.join(curSlug, dest))
- outgoing.add(trimPathSuffix(normalizedPath))
- } else if (dest.startsWith("#")) {
- if (opts.indexAnchorLinks) {
- outgoing.add(dest)
- }
- } else {
- if (opts.indexExternalLinks) {
- outgoing.add(dest)
- }
+ 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
@@ -77,9 +78,9 @@
}
}
- // transform all images
+ // transform all other resources that may use links
if (
- node.tagName === 'img' &&
+ ["img", "video", "audio", "iframe"].includes(node.tagName) &&
node.properties &&
typeof node.properties.src === 'string'
) {
@@ -99,6 +100,6 @@
declare module 'vfile' {
interface DataMap {
- links: string[]
+ links: CanonicalSlug[]
}
}
--
Gitblit v1.10.0