Jacky Zhao
2023-12-18 78b33fc2fb2d2b30e0cdf6fbd50c74efceac1c56
quartz/util/path.ts
@@ -1,5 +1,5 @@
import { slug } from "github-slugger"
import type { ElementContent, Element as HastElement } from "hast"
import { slug as slugAnchor } from "github-slugger"
import type { Element as HastElement } from "hast"
// this file must be isomorphic so it can't use node libs (e.g. path)
export const QUARTZ = "quartz"
@@ -25,7 +25,7 @@
/** 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.startsWith("/"))
  const validStart = !(s.startsWith(".") || (s.length > 1 && s.startsWith("/")))
  const validEnding = !(s.endsWith("/index") || s === "index")
  return validStart && !_containsForbiddenCharacters(s) && validEnding && !_hasFileExtension(s)
}
@@ -43,6 +43,14 @@
  return res
}
function sluggify(s: string): string {
  return s
    .split("/")
    .map((segment) => segment.replace(/\s/g, "-").replace(/%/g, "-percent").replace(/\?/g, "-q")) // slugify all segments
    .join("/") // always use / as sep
    .replace(/\/$/, "")
}
export function slugifyFilePath(fp: FilePath, excludeExt?: boolean): FullSlug {
  fp = _stripSlashes(fp) as FilePath
  let ext = _getFileExtension(fp)
@@ -51,11 +59,7 @@
    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")) {
@@ -156,14 +160,10 @@
  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("/")
}