From 7bde99b4e2d49e30dad1e0d58ccc34c2e7482005 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Mon, 14 Aug 2023 00:47:18 +0000
Subject: [PATCH] fix: add trailing slash to local serving
---
quartz/path.test.ts | 267 ++++++++++++++++++++++++++++++++++++++++-------------
1 files changed, 200 insertions(+), 67 deletions(-)
diff --git a/quartz/path.test.ts b/quartz/path.test.ts
index c0ceacc..d86bca5 100644
--- a/quartz/path.test.ts
+++ b/quartz/path.test.ts
@@ -1,9 +1,10 @@
-import test, { describe } from 'node:test'
-import * as path from './path'
-import assert from 'node:assert'
+import test, { describe } from "node:test"
+import * as path from "./path"
+import assert from "node:assert"
+import { CanonicalSlug, ServerSlug, TransformOptions } from "./path"
-describe('typeguards', () => {
- test('isClientSlug', () => {
+describe("typeguards", () => {
+ test("isClientSlug", () => {
assert(path.isClientSlug("http://example.com"))
assert(path.isClientSlug("http://example.com/index"))
assert(path.isClientSlug("http://example.com/index.html"))
@@ -23,7 +24,7 @@
assert(!path.isClientSlug("https"))
})
- test('isCanonicalSlug', () => {
+ test("isCanonicalSlug", () => {
assert(path.isCanonicalSlug(""))
assert(path.isCanonicalSlug("abc"))
assert(path.isCanonicalSlug("notindex"))
@@ -41,7 +42,7 @@
assert(!path.isCanonicalSlug("index.html"))
})
- test('isRelativeURL', () => {
+ test("isRelativeURL", () => {
assert(path.isRelativeURL("."))
assert(path.isRelativeURL(".."))
assert(path.isRelativeURL("./abc/def"))
@@ -58,7 +59,7 @@
assert(!path.isRelativeURL("./abc/def.md"))
})
- test('isServerSlug', () => {
+ test("isServerSlug", () => {
assert(path.isServerSlug("index"))
assert(path.isServerSlug("abc/def"))
@@ -72,7 +73,7 @@
assert(!path.isServerSlug("note with spaces"))
})
- test('isFilePath', () => {
+ test("isFilePath", () => {
assert(path.isFilePath("content/index.md"))
assert(path.isFilePath("content/test.png"))
assert(!path.isFilePath("../test.pdf"))
@@ -81,79 +82,211 @@
})
})
-
-describe('transforms', () => {
- function asserts<Inp, Out>(pairs: [string, string][], transform: (inp: Inp) => Out, checkPre: (x: any) => x is Inp, checkPost: (x: any) => x is Out) {
+describe("transforms", () => {
+ function asserts<Inp, Out>(
+ pairs: [string, string][],
+ transform: (inp: Inp) => Out,
+ checkPre: (x: any) => x is Inp,
+ checkPost: (x: any) => x is Out,
+ ) {
for (const [inp, expected] of pairs) {
assert(checkPre(inp), `${inp} wasn't the expected input type`)
const actual = transform(inp)
- assert.strictEqual(actual, expected, `after transforming ${inp}, '${actual}' was not '${expected}'`)
+ assert.strictEqual(
+ actual,
+ expected,
+ `after transforming ${inp}, '${actual}' was not '${expected}'`,
+ )
assert(checkPost(actual), `${actual} wasn't the expected output type`)
}
}
- test('canonicalizeServer', () => {
- asserts([
- ["index", ""],
- ["abc/index", "abc"],
- ["abc/def", "abc/def"],
- ], path.canonicalizeServer, path.isServerSlug, path.isCanonicalSlug)
+ test("canonicalizeServer", () => {
+ asserts(
+ [
+ ["index", ""],
+ ["abc/index", "abc"],
+ ["abc/def", "abc/def"],
+ ],
+ path.canonicalizeServer,
+ path.isServerSlug,
+ path.isCanonicalSlug,
+ )
})
- test('canonicalizeClient', () => {
- asserts([
- ["http://localhost:3000", ""],
- ["http://localhost:3000/index", ""],
- ["http://localhost:3000/test", "test"],
- ["http://example.com", ""],
- ["http://example.com/index", ""],
- ["http://example.com/index.html", ""],
- ["http://example.com/", ""],
- ["https://example.com", ""],
- ["https://example.com/abc/def", "abc/def"],
- ["https://example.com/abc/def/", "abc/def"],
- ["https://example.com/abc/def#cool", "abc/def"],
- ["https://example.com/abc/def?field=1&another=2", "abc/def"],
- ["https://example.com/abc/def?field=1&another=2#cool", "abc/def"],
- ["https://example.com/abc/def.html?field=1&another=2#cool", "abc/def"],
- ], path.canonicalizeClient, path.isClientSlug, path.isCanonicalSlug)
+ test("canonicalizeClient", () => {
+ asserts(
+ [
+ ["http://localhost:3000", ""],
+ ["http://localhost:3000/index", ""],
+ ["http://localhost:3000/test", "test"],
+ ["http://example.com", ""],
+ ["http://example.com/index", ""],
+ ["http://example.com/index.html", ""],
+ ["http://example.com/", ""],
+ ["https://example.com", ""],
+ ["https://example.com/abc/def", "abc/def"],
+ ["https://example.com/abc/def/", "abc/def"],
+ ["https://example.com/abc/def#cool", "abc/def"],
+ ["https://example.com/abc/def?field=1&another=2", "abc/def"],
+ ["https://example.com/abc/def?field=1&another=2#cool", "abc/def"],
+ ["https://example.com/abc/def.html?field=1&another=2#cool", "abc/def"],
+ ],
+ path.canonicalizeClient,
+ path.isClientSlug,
+ path.isCanonicalSlug,
+ )
})
- describe('slugifyFilePath', () => {
- asserts([
- ["content/index.md", "content/index"],
- ["/content/index.md", "content/index"],
- ["content/cool.png", "content/cool"],
- ["index.md", "index"],
- ["note with spaces.md", "note-with-spaces"],
- ], path.slugifyFilePath, path.isFilePath, path.isServerSlug)
+ test("slugifyFilePath", () => {
+ asserts(
+ [
+ ["content/index.md", "content/index"],
+ ["content/_index.md", "content/index"],
+ ["/content/index.md", "content/index"],
+ ["content/cool.png", "content/cool"],
+ ["index.md", "index"],
+ ["test.mp4", "test"],
+ ["note with spaces.md", "note-with-spaces"],
+ ],
+ path.slugifyFilePath,
+ path.isFilePath,
+ path.isServerSlug,
+ )
})
- describe('transformInternalLink', () => {
- asserts([
- ["", "."],
- [".", "."],
- ["./", "."],
- ["./index", "."],
- ["./index.html", "."],
- ["./index.md", "."],
- ["content", "./content"],
- ["content/test.md", "./content/test"],
- ["./content/test.md", "./content/test"],
- ["../content/test.md", "../content/test"],
- ["tags/", "./tags"],
- ["/tags/", "./tags"],
- ["content/with spaces", "./content/with-spaces"],
- ["content/with spaces#and Anchor!", "./content/with-spaces#and-anchor"],
- ], path.transformInternalLink, (_x: string): _x is string => true, path.isRelativeURL)
+ test("transformInternalLink", () => {
+ asserts(
+ [
+ ["", "."],
+ [".", "."],
+ ["./", "."],
+ ["./index", "."],
+ ["./index.html", "."],
+ ["./index.md", "."],
+ ["content", "./content"],
+ ["content/test.md", "./content/test"],
+ ["./content/test.md", "./content/test"],
+ ["../content/test.md", "../content/test"],
+ ["tags/", "./tags"],
+ ["/tags/", "./tags"],
+ ["content/with spaces", "./content/with-spaces"],
+ ["content/with spaces#and Anchor!", "./content/with-spaces#and-anchor"],
+ ],
+ path.transformInternalLink,
+ (_x: string): _x is string => true,
+ path.isRelativeURL,
+ )
})
- describe('pathToRoot', () => {
- asserts([
- ["", "."],
- ["abc", ".."],
- ["abc/def", "../.."],
- ], path.pathToRoot, path.isCanonicalSlug, path.isRelativeURL)
+ test("pathToRoot", () => {
+ asserts(
+ [
+ ["", "."],
+ ["abc", ".."],
+ ["abc/def", "../.."],
+ ],
+ path.pathToRoot,
+ path.isCanonicalSlug,
+ path.isRelativeURL,
+ )
})
})
+describe("link strategies", () => {
+ const allSlugs = ["a/b/c", "a/b/d", "a/b/index", "e/f", "e/g/h", "index"] as ServerSlug[]
+
+ describe("absolute", () => {
+ const opts: TransformOptions = {
+ strategy: "absolute",
+ allSlugs,
+ }
+
+ test("from a/b/c", () => {
+ const cur = "a/b/c" as CanonicalSlug
+ assert.strictEqual(path.transformLink(cur, "a/b/d", opts), "../../../a/b/d")
+ assert.strictEqual(path.transformLink(cur, "a/b/index", opts), "../../../a/b")
+ assert.strictEqual(path.transformLink(cur, "e/f", opts), "../../../e/f")
+ assert.strictEqual(path.transformLink(cur, "e/g/h", opts), "../../../e/g/h")
+ assert.strictEqual(path.transformLink(cur, "index", opts), "../../..")
+ assert.strictEqual(path.transformLink(cur, "index#abc", opts), "../../../#abc")
+ assert.strictEqual(path.transformLink(cur, "tag/test", opts), "../../../tag/test")
+ assert.strictEqual(path.transformLink(cur, "a/b/c#test", opts), "../../../a/b/c#test")
+ })
+
+ test("from a/b/index", () => {
+ const cur = "a/b" as CanonicalSlug
+ assert.strictEqual(path.transformLink(cur, "a/b/d", opts), "../../a/b/d")
+ assert.strictEqual(path.transformLink(cur, "a/b", opts), "../../a/b")
+ assert.strictEqual(path.transformLink(cur, "index", opts), "../..")
+ })
+
+ test("from index", () => {
+ const cur = "" as CanonicalSlug
+ assert.strictEqual(path.transformLink(cur, "index", opts), ".")
+ assert.strictEqual(path.transformLink(cur, "a/b/c", opts), "./a/b/c")
+ assert.strictEqual(path.transformLink(cur, "a/b/index", opts), "./a/b")
+ })
+ })
+
+ describe("shortest", () => {
+ const opts: TransformOptions = {
+ strategy: "shortest",
+ allSlugs,
+ }
+
+ test("from a/b/c", () => {
+ const cur = "a/b/c" as CanonicalSlug
+ assert.strictEqual(path.transformLink(cur, "d", opts), "../../../a/b/d")
+ assert.strictEqual(path.transformLink(cur, "h", opts), "../../../e/g/h")
+ assert.strictEqual(path.transformLink(cur, "a/b/index", opts), "../../../a/b")
+ assert.strictEqual(path.transformLink(cur, "index", opts), "../../..")
+ })
+
+ test("from a/b/index", () => {
+ const cur = "a/b" as CanonicalSlug
+ assert.strictEqual(path.transformLink(cur, "d", opts), "../../a/b/d")
+ assert.strictEqual(path.transformLink(cur, "h", opts), "../../e/g/h")
+ assert.strictEqual(path.transformLink(cur, "a/b/index", opts), "../../a/b")
+ assert.strictEqual(path.transformLink(cur, "index", opts), "../..")
+ })
+
+ test("from index", () => {
+ const cur = "" as CanonicalSlug
+ assert.strictEqual(path.transformLink(cur, "d", opts), "./a/b/d")
+ assert.strictEqual(path.transformLink(cur, "h", opts), "./e/g/h")
+ assert.strictEqual(path.transformLink(cur, "a/b/index", opts), "./a/b")
+ assert.strictEqual(path.transformLink(cur, "index", opts), ".")
+ })
+ })
+
+ describe("relative", () => {
+ const opts: TransformOptions = {
+ strategy: "relative",
+ allSlugs,
+ }
+
+ test("from a/b/c", () => {
+ const cur = "a/b/c" as CanonicalSlug
+ assert.strictEqual(path.transformLink(cur, "d", opts), "./d")
+ assert.strictEqual(path.transformLink(cur, "index", opts), ".")
+ assert.strictEqual(path.transformLink(cur, "../../index", opts), "../..")
+ assert.strictEqual(path.transformLink(cur, "../../", opts), "../..")
+ assert.strictEqual(path.transformLink(cur, "../../e/g/h", opts), "../../e/g/h")
+ })
+
+ test("from a/b/index", () => {
+ const cur = "a/b" as CanonicalSlug
+ assert.strictEqual(path.transformLink(cur, "../../index", opts), "../..")
+ assert.strictEqual(path.transformLink(cur, "../../", opts), "../..")
+ assert.strictEqual(path.transformLink(cur, "../../e/g/h", opts), "../../e/g/h")
+ assert.strictEqual(path.transformLink(cur, "c", opts), "./c")
+ })
+
+ test("from index", () => {
+ const cur = "" as CanonicalSlug
+ assert.strictEqual(path.transformLink(cur, "e/g/h", opts), "./e/g/h")
+ assert.strictEqual(path.transformLink(cur, "a/b/index", opts), "./a/b")
+ })
+ })
+})
--
Gitblit v1.10.0