301 lines
12 KiB
TypeScript
301 lines
12 KiB
TypeScript
import { slug } from "github-slugger"
|
|
// this file must be isomorphic so it can't use node libs (e.g. path)
|
|
|
|
// Quartz Paths
|
|
// Things in boxes are not actual types but rather sources which these types can be acquired from
|
|
//
|
|
// ┌────────────┐
|
|
// ┌───────────┤ Browser ├────────────┐
|
|
// │ └────────────┘ │
|
|
// │ │
|
|
// ▼ ▼
|
|
// ┌────────┐ ┌─────────────┐
|
|
// ┌───────────────────┤ Window │ │ LinkElement │
|
|
// │ └────┬───┘ └──────┬──────┘
|
|
// │ │ │
|
|
// │ getClientSlug() │ .href │
|
|
// │ ▼ ▼
|
|
// │
|
|
// │ Client Slug ┌───► Relative URL
|
|
// getCanonicalSlug() │ https://test.ca/note/abc#anchor?query=123 │ ../note/def#anchor
|
|
// │ │
|
|
// │ canonicalizeClient() │ │ ▲ ▲
|
|
// │ ▼ │ │ │
|
|
// │ pathToRoot() │ │ │
|
|
// └───────────────► Canonical Slug ────────────────┘ │ │
|
|
// note/abc │ │
|
|
// ──────────────────────────┘ │
|
|
// ▲ resolveRelative() │
|
|
// canonicalizeServer() │ │
|
|
// │
|
|
// HTML File Server Slug │
|
|
// note/abc/index.html ◄───────────── note/abc/index │
|
|
// │
|
|
// ▲ ┌────────┴────────┐
|
|
// slugifyFilePath() │ transformLink() │ │
|
|
// │ │ │
|
|
// ┌─────────┴──────────┐ ┌─────┴─────┐ ┌────────┴──────┐
|
|
// │ File Path │ │ Wikilinks │ │ Markdown Link │
|
|
// │ note/abc/index.md │ └───────────┘ └───────────────┘
|
|
// └────────────────────┘ ▲ ▲
|
|
// ▲ │ │
|
|
// │ ┌─────────┐ │ │
|
|
// └────────────┤ MD File ├─────┴─────────────────┘
|
|
// └─────────┘
|
|
|
|
export const QUARTZ = "quartz"
|
|
|
|
/// Utility type to simulate nominal types in TypeScript
|
|
type SlugLike<T> = string & { __brand: T }
|
|
|
|
/** Client-side slug, usually obtained through `window.location` */
|
|
export type ClientSlug = SlugLike<"client">
|
|
export function isClientSlug(s: string): s is ClientSlug {
|
|
const res = /^https?:\/\/.+/.test(s)
|
|
return res
|
|
}
|
|
|
|
/** Canonical slug, should be used whenever you need to refer to the location of a file/note.
|
|
* On the client, this is normally stored in `document.body.dataset.slug`
|
|
*/
|
|
export type CanonicalSlug = SlugLike<"canonical">
|
|
export function isCanonicalSlug(s: string): s is CanonicalSlug {
|
|
const validStart = !(s.startsWith(".") || s.startsWith("/"))
|
|
const validEnding = !(s.endsWith("/") || s.endsWith("/index") || s === "index")
|
|
return validStart && !_containsForbiddenCharacters(s) && validEnding && !_hasFileExtension(s)
|
|
}
|
|
|
|
/** A relative link, 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")
|
|
return validStart && validEnding && ![".md", ".html"].includes(_getFileExtension(s) ?? "")
|
|
}
|
|
|
|
/** A server side slug. This is what Quartz uses to emit files so uses index suffixes */
|
|
export type ServerSlug = SlugLike<"server">
|
|
export function isServerSlug(s: string): s is ServerSlug {
|
|
const validStart = !(s.startsWith(".") || s.startsWith("/"))
|
|
const validEnding = !s.endsWith("/")
|
|
return validStart && validEnding && !_containsForbiddenCharacters(s)
|
|
}
|
|
|
|
/** The real file path to a file on disk */
|
|
export type FilePath = SlugLike<"filepath">
|
|
export function isFilePath(s: string): s is FilePath {
|
|
const validStart = !s.startsWith(".")
|
|
return validStart && _hasFileExtension(s)
|
|
}
|
|
|
|
export function getClientSlug(window: Window): ClientSlug {
|
|
const res = window.location.href as ClientSlug
|
|
return res
|
|
}
|
|
|
|
export function getCanonicalSlug(window: Window): CanonicalSlug {
|
|
const res = window.document.body.dataset.slug! as CanonicalSlug
|
|
return res
|
|
}
|
|
|
|
export function canonicalizeClient(slug: ClientSlug): CanonicalSlug {
|
|
const { pathname } = new URL(slug)
|
|
let fp = pathname.slice(1)
|
|
fp = fp.replace(new RegExp(_getFileExtension(fp) + "$"), "")
|
|
const res = _canonicalize(fp) as CanonicalSlug
|
|
return res
|
|
}
|
|
|
|
export function canonicalizeServer(slug: ServerSlug): CanonicalSlug {
|
|
let fp = slug as string
|
|
const res = _canonicalize(fp) as CanonicalSlug
|
|
return res
|
|
}
|
|
|
|
export function slugifyFilePath(fp: FilePath, excludeExt?: boolean): ServerSlug {
|
|
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, "-")) // slugify all segments
|
|
.join("/") // always use / as sep
|
|
.replace(/\/$/, "") // remove trailing slash
|
|
|
|
// treat _index as index
|
|
if (_endsWith(slug, "_index")) {
|
|
slug = slug.replace(/_index$/, "index")
|
|
}
|
|
|
|
return (slug + ext) as ServerSlug
|
|
}
|
|
|
|
export function transformInternalLink(link: string): RelativeURL {
|
|
let [fplike, anchor] = splitAnchor(decodeURI(link))
|
|
|
|
const folderPath =
|
|
fplike.endsWith("index") ||
|
|
fplike.endsWith("index.md") ||
|
|
fplike.endsWith("index.html") ||
|
|
fplike.endsWith("/")
|
|
|
|
let segments = fplike.split("/").filter((x) => x.length > 0)
|
|
let prefix = segments.filter(_isRelativeSegment).join("/")
|
|
let fp = segments.filter((seg) => !_isRelativeSegment(seg)).join("/")
|
|
|
|
// manually add ext here as we want to not strip 'index' if it has an extension
|
|
fp = canonicalizeServer(slugifyFilePath(fp as FilePath) as ServerSlug)
|
|
const joined = joinSegments(_stripSlashes(prefix), _stripSlashes(fp))
|
|
const trail = folderPath ? "/" : ""
|
|
const res = (_addRelativeToStart(joined) + trail + anchor) as RelativeURL
|
|
return res
|
|
}
|
|
|
|
// resolve /a/b/c to ../../..
|
|
export function pathToRoot(slug: CanonicalSlug): RelativeURL {
|
|
let rootPath = slug
|
|
.split("/")
|
|
.filter((x) => x !== "")
|
|
.map((_) => "..")
|
|
.join("/")
|
|
|
|
const res = _addRelativeToStart(rootPath) as RelativeURL
|
|
return res
|
|
}
|
|
|
|
export function resolveRelative(current: CanonicalSlug, target: CanonicalSlug): RelativeURL {
|
|
const res = joinSegments(pathToRoot(current), target) as RelativeURL
|
|
return res
|
|
}
|
|
|
|
export function splitAnchor(link: string): [string, string] {
|
|
let [fp, anchor] = link.split("#", 2)
|
|
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))
|
|
.join("/")
|
|
}
|
|
|
|
export function joinSegments(...args: string[]): string {
|
|
return args.filter((segment) => segment !== "").join("/")
|
|
}
|
|
|
|
export function getAllSegmentPrefixes(tags: string): string[] {
|
|
const segments = tags.split("/")
|
|
const results: string[] = []
|
|
for (let i = 0; i < segments.length; i++) {
|
|
results.push(segments.slice(0, i + 1).join("/"))
|
|
}
|
|
return results
|
|
}
|
|
|
|
export interface TransformOptions {
|
|
strategy: "absolute" | "relative" | "shortest"
|
|
allSlugs: ServerSlug[]
|
|
}
|
|
|
|
export function transformLink(
|
|
src: CanonicalSlug,
|
|
target: string,
|
|
opts: TransformOptions,
|
|
): RelativeURL {
|
|
let targetSlug: string = transformInternalLink(target)
|
|
|
|
if (opts.strategy === "relative") {
|
|
return _addRelativeToStart(targetSlug) as RelativeURL
|
|
} else {
|
|
const folderTail = targetSlug.endsWith("/") ? "/" : ""
|
|
const canonicalSlug = _stripSlashes(targetSlug.slice(".".length))
|
|
let [targetCanonical, targetAnchor] = splitAnchor(canonicalSlug)
|
|
|
|
if (opts.strategy === "shortest") {
|
|
// if the file name is unique, then it's just the filename
|
|
const matchingFileNames = opts.allSlugs.filter((slug) => {
|
|
const parts = slug.split("/")
|
|
const fileName = parts.at(-1)
|
|
return targetCanonical === fileName
|
|
})
|
|
|
|
// only match, just use it
|
|
if (matchingFileNames.length === 1) {
|
|
const targetSlug = canonicalizeServer(matchingFileNames[0])
|
|
return (resolveRelative(src, targetSlug) + targetAnchor) as RelativeURL
|
|
}
|
|
}
|
|
|
|
// if it's not unique, then it's the absolute path from the vault root
|
|
return (joinSegments(pathToRoot(src), canonicalSlug) + folderTail) as RelativeURL
|
|
}
|
|
}
|
|
|
|
function _canonicalize(fp: string): string {
|
|
fp = _trimSuffix(fp, "index")
|
|
return _stripSlashes(fp)
|
|
}
|
|
|
|
function _endsWith(s: string, suffix: string): boolean {
|
|
return s === suffix || s.endsWith("/" + 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 _hasFileExtension(s: string): boolean {
|
|
return _getFileExtension(s) !== undefined
|
|
}
|
|
|
|
function _getFileExtension(s: string): string | undefined {
|
|
return s.match(/\.[A-Za-z0-9]+$/)?.[0]
|
|
}
|
|
|
|
function _isRelativeSegment(s: string): boolean {
|
|
return /^\.{0,2}$/.test(s)
|
|
}
|
|
|
|
export function _stripSlashes(s: string): string {
|
|
if (s.startsWith("/")) {
|
|
s = s.substring(1)
|
|
}
|
|
|
|
if (s.endsWith("/")) {
|
|
s = s.slice(0, -1)
|
|
}
|
|
|
|
return s
|
|
}
|
|
|
|
function _addRelativeToStart(s: string): string {
|
|
if (s === "") {
|
|
s = "."
|
|
}
|
|
|
|
if (!s.startsWith(".")) {
|
|
s = joinSegments(".", s)
|
|
}
|
|
|
|
return s
|
|
}
|