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 | 143 +++++++++++++++++++++++++++--------------------
1 files changed, 82 insertions(+), 61 deletions(-)
diff --git a/quartz/plugins/transformers/links.ts b/quartz/plugins/transformers/links.ts
index 04b26c6..da1c343 100644
--- a/quartz/plugins/transformers/links.ts
+++ b/quartz/plugins/transformers/links.ts
@@ -1,84 +1,105 @@
-import { PluggableList } from "unified"
import { QuartzTransformerPlugin } from "../types"
-import { remarkWikiLink } from "@flowershow/remark-wiki-link"
-import { relative, relativeToRoot, slugify } 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
}
const defaultOptions: Options = {
markdownLinkResolution: 'absolute',
- prettyLinks: true
+ prettyLinks: true,
}
-export class LinkProcessing extends QuartzTransformerPlugin {
- name = "LinkProcessing"
- opts: Options
+export const CrawlLinks: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
+ 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!
- constructor(opts?: Options) {
- super()
- this.opts = { ...defaultOptions, ...opts }
- }
+ // 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
+ })
- markdownPlugins(): PluggableList {
- return [[remarkWikiLink, {
- pathFormat: this.opts.markdownLinkResolution === "absolute" ? 'obsidian-absolute' : 'raw',
- }]]
- }
+ if (matchingFileNames.length === 1) {
+ const targetSlug = canonicalizeServer(matchingFileNames[0])
+ return resolveRelative(curSlug, targetSlug) + targetAnchor as RelativeURL
+ }
- htmlPlugins(): PluggableList {
- return [() => {
- return (tree, file) => {
- const curSlug = file.data.slug!
- const transformLink = (target: string) => {
- const targetSlug = slugify(decodeURI(target).trim())
- if (this.opts.markdownLinkResolution === 'relative' && !path.isAbsolute(targetSlug)) {
- return './' + relative(curSlug, targetSlug)
- } else {
- return './' + relativeToRoot(curSlug, targetSlug)
+ // 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<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]
}
+ }]
+ }
+ }
+}
- visit(tree, 'element', (node, _index, _parent) => {
- // rewrite all links
- if (
- node.tagName === 'a' &&
- node.properties &&
- typeof node.properties.href === 'string'
- ) {
- node.properties.className = isAbsoluteUrl(node.properties.href) ? "external" : "internal"
-
- // don't process external links or intra-document anchors
- if (!(isAbsoluteUrl(node.properties.href) || node.properties.href.startsWith("#"))) {
- node.properties.href = transformLink(node.properties.href)
- }
-
- // rewrite link internals if prettylinks is on
- if (this.opts.prettyLinks && node.children.length === 1 && node.children[0].type === 'text') {
- node.children[0].value = path.basename(node.children[0].value)
- }
- }
-
- // transform all images
- if (
- node.tagName === 'img' &&
- 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
- }
- }
- })
- }
- }]
+declare module 'vfile' {
+ interface DataMap {
+ links: CanonicalSlug[]
}
}
--
Gitblit v1.10.0