From cf6ab9e9333b5f76cb9e06f6687f2b4f8fbe91bd Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Sun, 12 Nov 2023 22:27:53 +0000
Subject: [PATCH] feat: option to specify npx quartz sync message (closes #583)
---
quartz/plugins/transformers/links.ts | 91 ++++++++++++++++++++++++---------------------
1 files changed, 49 insertions(+), 42 deletions(-)
diff --git a/quartz/plugins/transformers/links.ts b/quartz/plugins/transformers/links.ts
index 7e8a278..8d16136 100644
--- a/quartz/plugins/transformers/links.ts
+++ b/quartz/plugins/transformers/links.ts
@@ -1,28 +1,30 @@
import { QuartzTransformerPlugin } from "../types"
import {
- CanonicalSlug,
+ FullSlug,
RelativeURL,
- canonicalizeServer,
- joinSegments,
- pathToRoot,
- resolveRelative,
+ SimpleSlug,
+ TransformOptions,
+ _stripSlashes,
+ simplifySlug,
splitAnchor,
- transformInternalLink,
-} from "../../path"
+ transformLink,
+} from "../../util/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" | "shortest"
+ markdownLinkResolution: TransformOptions["strategy"]
/** Strips folders from a link so that it looks nice */
prettyLinks: boolean
+ openLinksInNewTab: boolean
}
const defaultOptions: Options = {
markdownLinkResolution: "absolute",
prettyLinks: true,
+ openLinksInNewTab: false,
}
export const CrawlLinks: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
@@ -33,34 +35,14 @@
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
- const matchingFileNames = ctx.allSlugs.filter((slug) => {
- const parts = slug.split(path.posix.sep)
- const fileName = parts.at(-1)
- return targetCanonical === fileName
- })
+ const curSlug = simplifySlug(file.data.slug!)
+ const outgoing: Set<SimpleSlug> = new Set()
- 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 transformOptions: TransformOptions = {
+ strategy: opts.markdownLinkResolution,
+ allSlugs: ctx.allSlugs,
}
- const outgoing: Set<CanonicalSlug> = new Set()
visit(tree, "element", (node, _index, _parent) => {
// rewrite all links
if (
@@ -72,19 +54,40 @@
node.properties.className ??= []
node.properties.className.push(isAbsoluteUrl(dest) ? "external" : "internal")
+ if (opts.openLinksInNewTab) {
+ node.properties.target = "_blank"
+ }
+
// 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 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
+ const url = new URL(dest, `https://base.com/${curSlug}`)
+ const canonicalDest = url.pathname
const [destCanonical, _destAnchor] = splitAnchor(canonicalDest)
- outgoing.add(destCanonical as CanonicalSlug)
+
+ // need to decodeURIComponent here as WHATWG URL percent-encodes everything
+ const simple = decodeURIComponent(
+ simplifySlug(destCanonical as FullSlug),
+ ) as SimpleSlug
+ outgoing.add(simple)
+ node.properties["data-slug"] = simple
}
// rewrite link internals if prettylinks is on
if (
opts.prettyLinks &&
+ isInternal &&
node.children.length === 1 &&
- node.children[0].type === "text"
+ node.children[0].type === "text" &&
+ !node.children[0].value.startsWith("#")
) {
node.children[0].value = path.basename(node.children[0].value)
}
@@ -97,9 +100,13 @@
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
+ let dest = node.properties.src as RelativeURL
+ dest = node.properties.src = transformLink(
+ file.data.slug!,
+ dest,
+ transformOptions,
+ )
+ node.properties.src = dest
}
}
})
@@ -114,6 +121,6 @@
declare module "vfile" {
interface DataMap {
- links: CanonicalSlug[]
+ links: SimpleSlug[]
}
}
--
Gitblit v1.10.0