From ef72f1bf707dca363cdab84da91e2acfaef8f276 Mon Sep 17 00:00:00 2001
From: Ammar Alakkad <am.alakkad@gmail.com>
Date: Mon, 30 Dec 2024 16:03:57 +0000
Subject: [PATCH] Fix ObsidianFlavoredMarkdown source link (#1694)
---
quartz/util/path.ts | 88 ++++++++++++++++++++++++++------------------
1 files changed, 52 insertions(+), 36 deletions(-)
diff --git a/quartz/util/path.ts b/quartz/util/path.ts
index 5cf54b8..c02bfb1 100644
--- a/quartz/util/path.ts
+++ b/quartz/util/path.ts
@@ -1,5 +1,9 @@
-import { slug } from "github-slugger"
+import { slug as slugAnchor } from "github-slugger"
import type { Element as HastElement } from "hast"
+import rfdc from "rfdc"
+
+export const clone = rfdc()
+
// this file must be isomorphic so it can't use node libs (e.g. path)
export const QUARTZ = "quartz"
@@ -19,22 +23,22 @@
export function isFullSlug(s: string): s is FullSlug {
const validStart = !(s.startsWith(".") || s.startsWith("/"))
const validEnding = !s.endsWith("/")
- return validStart && validEnding && !_containsForbiddenCharacters(s)
+ return validStart && validEnding && !containsForbiddenCharacters(s)
}
/** Shouldn't be a relative path and shouldn't have `/index` as an ending or a file extension. It _can_ however have a trailing slash to indicate a folder path. */
export type SimpleSlug = SlugLike<"simple">
export function isSimpleSlug(s: string): s is SimpleSlug {
const validStart = !(s.startsWith(".") || (s.length > 1 && s.startsWith("/")))
- const validEnding = !(s.endsWith("/index") || s === "index")
- return validStart && !_containsForbiddenCharacters(s) && validEnding && !_hasFileExtension(s)
+ const validEnding = !endsWith(s, "index")
+ return validStart && !containsForbiddenCharacters(s) && validEnding && !_hasFileExtension(s)
}
/** Can be found on `href`s but can also be constructed for client-side navigation (e.g. search and graph) */
export type RelativeURL = SlugLike<"relative">
export function isRelativeURL(s: string): s is RelativeURL {
const validStart = /^\.{1,2}/.test(s)
- const validEnding = !(s.endsWith("/index") || s === "index")
+ const validEnding = !endsWith(s, "index")
return validStart && validEnding && ![".md", ".html"].includes(_getFileExtension(s) ?? "")
}
@@ -43,22 +47,33 @@
return res
}
+function sluggify(s: string): string {
+ return s
+ .split("/")
+ .map((segment) =>
+ segment
+ .replace(/\s/g, "-")
+ .replace(/&/g, "-and-")
+ .replace(/%/g, "-percent")
+ .replace(/\?/g, "")
+ .replace(/#/g, ""),
+ )
+ .join("/") // always use / as sep
+ .replace(/\/$/, "")
+}
+
export function slugifyFilePath(fp: FilePath, excludeExt?: boolean): FullSlug {
- fp = _stripSlashes(fp) as FilePath
+ fp = stripSlashes(fp) as FilePath
let ext = _getFileExtension(fp)
const withoutFileExt = fp.replace(new RegExp(ext + "$"), "")
if (excludeExt || [".md", ".html", undefined].includes(ext)) {
ext = ""
}
- let slug = withoutFileExt
- .split("/")
- .map((segment) => segment.replace(/\s/g, "-").replace(/%/g, "-percent").replace(/\?/g, "-q")) // slugify all segments
- .join("/") // always use / as sep
- .replace(/\/$/, "") // remove trailing slash
+ let slug = sluggify(withoutFileExt)
// treat _index as index
- if (_endsWith(slug, "_index")) {
+ if (endsWith(slug, "_index")) {
slug = slug.replace(/_index$/, "index")
}
@@ -66,21 +81,21 @@
}
export function simplifySlug(fp: FullSlug): SimpleSlug {
- const res = _stripSlashes(_trimSuffix(fp, "index"), true)
+ const res = stripSlashes(trimSuffix(fp, "index"), true)
return (res.length === 0 ? "/" : res) as SimpleSlug
}
export function transformInternalLink(link: string): RelativeURL {
let [fplike, anchor] = splitAnchor(decodeURI(link))
- const folderPath = _isFolderPath(fplike)
+ const folderPath = isFolderPath(fplike)
let segments = fplike.split("/").filter((x) => x.length > 0)
- let prefix = segments.filter(_isRelativeSegment).join("/")
- let fp = segments.filter((seg) => !_isRelativeSegment(seg) && seg !== "").join("/")
+ let prefix = segments.filter(isRelativeSegment).join("/")
+ let fp = segments.filter((seg) => !isRelativeSegment(seg) && seg !== "").join("/")
// manually add ext here as we want to not strip 'index' if it has an extension
const simpleSlug = simplifySlug(slugifyFilePath(fp as FilePath))
- const joined = joinSegments(_stripSlashes(prefix), _stripSlashes(simpleSlug))
+ const joined = joinSegments(stripSlashes(prefix), stripSlashes(simpleSlug))
const trail = folderPath ? "/" : ""
const res = (_addRelativeToStart(joined) + trail + anchor) as RelativeURL
return res
@@ -117,7 +132,8 @@
}
}
-export function normalizeHastElement(el: HastElement, curBase: FullSlug, newBase: FullSlug) {
+export function normalizeHastElement(rawEl: HastElement, curBase: FullSlug, newBase: FullSlug) {
+ const el = clone(rawEl) // clone so we dont modify the original page
_rebaseHastElement(el, "src", curBase, newBase)
_rebaseHastElement(el, "href", curBase, newBase)
if (el.children) {
@@ -152,18 +168,17 @@
export function splitAnchor(link: string): [string, string] {
let [fp, anchor] = link.split("#", 2)
+ if (fp.endsWith(".pdf")) {
+ return [fp, anchor === undefined ? "" : `#${anchor}`]
+ }
anchor = anchor === undefined ? "" : "#" + slugAnchor(anchor)
return [fp, anchor]
}
-export function slugAnchor(anchor: string) {
- return slug(anchor)
-}
-
export function slugTag(tag: string) {
return tag
.split("/")
- .map((tagSegment) => slug(tagSegment))
+ .map((tagSegment) => sluggify(tagSegment))
.join("/")
}
@@ -194,8 +209,8 @@
if (opts.strategy === "relative") {
return targetSlug as RelativeURL
} else {
- const folderTail = _isFolderPath(targetSlug) ? "/" : ""
- const canonicalSlug = _stripSlashes(targetSlug.slice(".".length))
+ const folderTail = isFolderPath(targetSlug) ? "/" : ""
+ const canonicalSlug = stripSlashes(targetSlug.slice(".".length))
let [targetCanonical, targetAnchor] = splitAnchor(canonicalSlug)
if (opts.strategy === "shortest") {
@@ -218,28 +233,29 @@
}
}
-function _isFolderPath(fplike: string): boolean {
+// path helpers
+function isFolderPath(fplike: string): boolean {
return (
fplike.endsWith("/") ||
- _endsWith(fplike, "index") ||
- _endsWith(fplike, "index.md") ||
- _endsWith(fplike, "index.html")
+ endsWith(fplike, "index") ||
+ endsWith(fplike, "index.md") ||
+ endsWith(fplike, "index.html")
)
}
-function _endsWith(s: string, suffix: string): boolean {
+export function endsWith(s: string, suffix: string): boolean {
return s === suffix || s.endsWith("/" + suffix)
}
-function _trimSuffix(s: string, suffix: string): string {
- if (_endsWith(s, suffix)) {
+function trimSuffix(s: string, suffix: string): string {
+ if (endsWith(s, suffix)) {
s = s.slice(0, -suffix.length)
}
return s
}
-function _containsForbiddenCharacters(s: string): boolean {
- return s.includes(" ") || s.includes("#") || s.includes("?")
+function containsForbiddenCharacters(s: string): boolean {
+ return s.includes(" ") || s.includes("#") || s.includes("?") || s.includes("&")
}
function _hasFileExtension(s: string): boolean {
@@ -250,11 +266,11 @@
return s.match(/\.[A-Za-z0-9]+$/)?.[0]
}
-function _isRelativeSegment(s: string): boolean {
+function isRelativeSegment(s: string): boolean {
return /^\.{0,2}$/.test(s)
}
-export function _stripSlashes(s: string, onlyStripPrefix?: boolean): string {
+export function stripSlashes(s: string, onlyStripPrefix?: boolean): string {
if (s.startsWith("/")) {
s = s.substring(1)
}
--
Gitblit v1.10.0