From c91e62c376d481534d89084e5c04846878dff6d3 Mon Sep 17 00:00:00 2001
From: Ben Schlegel <31989404+benschlegel@users.noreply.github.com>
Date: Sun, 27 Aug 2023 00:19:45 +0000
Subject: [PATCH] Fix search bar after navigate (#424)
---
quartz/bootstrap-cli.mjs | 410 ++++++++++++++++++++++++++++++++++++++++++++--------------
1 files changed, 309 insertions(+), 101 deletions(-)
diff --git a/quartz/bootstrap-cli.mjs b/quartz/bootstrap-cli.mjs
index d550aea..1deb18f 100755
--- a/quartz/bootstrap-cli.mjs
+++ b/quartz/bootstrap-cli.mjs
@@ -12,15 +12,15 @@
import chokidar from "chokidar"
import prettyBytes from "pretty-bytes"
import { execSync, spawnSync } from "child_process"
-import { transform as cssTransform } from "lightningcss"
import http from "http"
import serveHandler from "serve-handler"
import { WebSocketServer } from "ws"
import { randomUUID } from "crypto"
+import { Mutex } from "async-mutex"
const ORIGIN_NAME = "origin"
const UPSTREAM_NAME = "upstream"
-const QUARTZ_SOURCE_BRANCH = "v4-alpha"
+const QUARTZ_SOURCE_BRANCH = "v4"
const cwd = process.cwd()
const cacheDir = path.join(cwd, ".quartz-cache")
const cacheFile = "./.quartz-cache/transpiled-build.mjs"
@@ -43,6 +43,27 @@
},
}
+const CreateArgv = {
+ ...CommonArgv,
+ source: {
+ string: true,
+ alias: ["s"],
+ describe: "source directory to copy/create symlink from",
+ },
+ strategy: {
+ string: true,
+ alias: ["X"],
+ choices: ["new", "copy", "symlink"],
+ describe: "strategy for content folder setup",
+ },
+ links: {
+ string: true,
+ alias: ["l"],
+ choices: ["absolute", "shortest", "relative"],
+ describe: "strategy to resolve links",
+ },
+}
+
const SyncArgv = {
...CommonArgv,
commit: {
@@ -75,6 +96,11 @@
default: false,
describe: "run a local server to live-preview your Quartz",
},
+ baseDir: {
+ string: true,
+ default: "",
+ describe: "base path to serve your local server on",
+ },
port: {
number: true,
default: 8080,
@@ -85,6 +111,10 @@
default: false,
describe: "show detailed bundle information",
},
+ concurrency: {
+ number: true,
+ describe: "how many threads to use to parse notes",
+ },
}
function escapePath(fp) {
@@ -105,6 +135,7 @@
}
async function stashContentFolder(contentFolder) {
+ await fs.promises.rm(contentCacheFolder, { force: true, recursive: true })
await fs.promises.cp(contentFolder, contentCacheFolder, {
force: true,
recursive: true,
@@ -126,73 +157,129 @@
}
function gitPull(origin, branch) {
- const flags = ["-s", "recursive", "-X", "ours", "--no-edit"]
- spawnSync("git", ["pull", ...flags, origin, branch], { stdio: "inherit" })
+ const flags = ["--no-rebase", "--autostash", "-s", "recursive", "-X", "ours", "--no-edit"]
+ const out = spawnSync("git", ["pull", ...flags, origin, branch], { stdio: "inherit" })
+ if (out.stderr) {
+ throw new Error(`Error while pulling updates: ${out.stderr}`)
+ }
}
yargs(hideBin(process.argv))
.scriptName("quartz")
.version(version)
.usage("$0 <cmd> [args]")
- .command("create", "Initialize Quartz", CommonArgv, async (argv) => {
+ .command("create", "Initialize Quartz", CreateArgv, async (argv) => {
console.log()
intro(chalk.bgGreen.black(` Quartz v${version} `))
const contentFolder = path.join(cwd, argv.directory)
- const setupStrategy = exitIfCancel(
- await select({
- message: `Choose how to initialize the content in \`${contentFolder}\``,
- options: [
- { value: "new", label: "Empty Quartz" },
- { value: "copy", label: "Replace with an existing folder", hint: "overwrites `content`" },
- {
- value: "symlink",
- label: "Symlink an existing folder",
- hint: "don't select this unless you know what you are doing!",
- },
- { value: "keep", label: "Keep the existing files" },
- ],
- }),
- )
+ let setupStrategy = argv.strategy?.toLowerCase()
+ let linkResolutionStrategy = argv.links?.toLowerCase()
+ const sourceDirectory = argv.source
- async function rmContentFolder() {
- const contentStat = await fs.promises.lstat(contentFolder)
- if (contentStat) {
- if (contentStat.isSymbolicLink()) {
- await fs.promises.unlink(contentFolder)
+ // If all cmd arguments were provided, check if theyre valid
+ if (setupStrategy && linkResolutionStrategy) {
+ // If setup isn't, "new", source argument is required
+ if (setupStrategy !== "new") {
+ // Error handling
+ if (!sourceDirectory) {
+ outro(
+ chalk.red(
+ `Setup strategies (arg '${chalk.yellow(
+ `-${CreateArgv.strategy.alias[0]}`,
+ )}') other than '${chalk.yellow(
+ "new",
+ )}' require content folder argument ('${chalk.yellow(
+ `-${CreateArgv.source.alias[0]}`,
+ )}') to be set`,
+ ),
+ )
+ process.exit(1)
} else {
- await rimraf(contentFolder)
+ if (!fs.existsSync(sourceDirectory)) {
+ outro(
+ chalk.red(
+ `Input directory to copy/symlink 'content' from not found ('${chalk.yellow(
+ sourceDirectory,
+ )}', invalid argument "${chalk.yellow(`-${CreateArgv.source.alias[0]}`)})`,
+ ),
+ )
+ process.exit(1)
+ } else if (!fs.lstatSync(sourceDirectory).isDirectory()) {
+ outro(
+ chalk.red(
+ `Source directory to copy/symlink 'content' from is not a directory (found file at '${chalk.yellow(
+ sourceDirectory,
+ )}', invalid argument ${chalk.yellow(`-${CreateArgv.source.alias[0]}`)}")`,
+ ),
+ )
+ process.exit(1)
+ }
}
}
}
- if (setupStrategy === "copy" || setupStrategy === "symlink") {
- const originalFolder = escapePath(
- exitIfCancel(
- await text({
- message: "Enter the full path to existing content folder",
- placeholder:
- "On most terminal emulators, you can drag and drop a folder into the window and it will paste the full path",
- validate(fp) {
- const fullPath = escapePath(fp)
- if (!fs.existsSync(fullPath)) {
- return "The given path doesn't exist"
- } else if (!fs.lstatSync(fullPath).isDirectory()) {
- return "The given path is not a folder"
- }
+ // Use cli process if cmd args werent provided
+ if (!setupStrategy) {
+ setupStrategy = exitIfCancel(
+ await select({
+ message: `Choose how to initialize the content in \`${contentFolder}\``,
+ options: [
+ { value: "new", label: "Empty Quartz" },
+ { value: "copy", label: "Copy an existing folder", hint: "overwrites `content`" },
+ {
+ value: "symlink",
+ label: "Symlink an existing folder",
+ hint: "don't select this unless you know what you are doing!",
},
- }),
- ),
+ ],
+ }),
)
+ }
+
+ async function rmContentFolder() {
+ const contentStat = await fs.promises.lstat(contentFolder)
+ if (contentStat.isSymbolicLink()) {
+ await fs.promises.unlink(contentFolder)
+ } else {
+ await rimraf(contentFolder)
+ }
+ }
+
+ await fs.promises.unlink(path.join(contentFolder, ".gitkeep"))
+ if (setupStrategy === "copy" || setupStrategy === "symlink") {
+ let originalFolder = sourceDirectory
+
+ // If input directory was not passed, use cli
+ if (!sourceDirectory) {
+ originalFolder = escapePath(
+ exitIfCancel(
+ await text({
+ message: "Enter the full path to existing content folder",
+ placeholder:
+ "On most terminal emulators, you can drag and drop a folder into the window and it will paste the full path",
+ validate(fp) {
+ const fullPath = escapePath(fp)
+ if (!fs.existsSync(fullPath)) {
+ return "The given path doesn't exist"
+ } else if (!fs.lstatSync(fullPath).isDirectory()) {
+ return "The given path is not a folder"
+ }
+ },
+ }),
+ ),
+ )
+ }
await rmContentFolder()
if (setupStrategy === "copy") {
- await fs.promises.cp(originalFolder, contentFolder, { recursive: true })
+ await fs.promises.cp(originalFolder, contentFolder, {
+ recursive: true,
+ preserveTimestamps: true,
+ })
} else if (setupStrategy === "symlink") {
await fs.promises.symlink(originalFolder, contentFolder, "dir")
}
} else if (setupStrategy === "new") {
- await rmContentFolder()
- await fs.promises.mkdir(contentFolder)
await fs.promises.writeFile(
path.join(contentFolder, "index.md"),
`---
@@ -205,29 +292,32 @@
)
}
- // get a prefered link resolution strategy
- const linkResolutionStrategy = exitIfCancel(
- await select({
- message: `Choose how Quartz should resolve links in your content. You can change this later in \`quartz.config.ts\`.`,
- options: [
- {
- value: "absolute",
- label: "Treat links as absolute path",
- hint: "for content made for Quartz 3 and Hugo",
- },
- {
- value: "shortest",
- label: "Treat links as shortest path",
- hint: "for most Obsidian vaults",
- },
- {
- value: "relative",
- label: "Treat links as relative paths",
- hint: "for just normal Markdown files",
- },
- ],
- }),
- )
+ // Use cli process if cmd args werent provided
+ if (!linkResolutionStrategy) {
+ // get a preferred link resolution strategy
+ linkResolutionStrategy = exitIfCancel(
+ await select({
+ message: `Choose how Quartz should resolve links in your content. You can change this later in \`quartz.config.ts\`.`,
+ options: [
+ {
+ value: "absolute",
+ label: "Treat links as absolute path",
+ hint: "for content made for Quartz 3 and Hugo",
+ },
+ {
+ value: "shortest",
+ label: "Treat links as shortest path",
+ hint: "for most Obsidian vaults",
+ },
+ {
+ value: "relative",
+ label: "Treat links as relative paths",
+ hint: "for just normal Markdown files",
+ },
+ ],
+ }),
+ )
+ }
// now, do config changes
const configFilePath = path.join(cwd, "quartz.config.ts")
@@ -241,37 +331,67 @@
outro(`You're all set! Not sure what to do next? Try:
• Customizing Quartz a bit more by editing \`quartz.config.ts\`
• Running \`npx quartz build --serve\` to preview your Quartz locally
- • Hosting your Quartz online (see: https://quartz.jzhao.xyz/setup/hosting)
+ • Hosting your Quartz online (see: https://quartz.jzhao.xyz/hosting)
`)
})
.command("update", "Get the latest Quartz updates", CommonArgv, async (argv) => {
const contentFolder = path.join(cwd, argv.directory)
console.log(chalk.bgGreen.black(`\n Quartz v${version} \n`))
console.log("Backing up your content")
+ execSync(
+ `git remote show upstream || git remote add upstream https://github.com/jackyzha0/quartz.git`,
+ )
await stashContentFolder(contentFolder)
console.log(
"Pulling updates... you may need to resolve some `git` conflicts if you've made changes to components or plugins.",
)
- execSync(
- `git remote show upstream || git remote add upstream https://github.com/jackyzha0/quartz.git`,
- )
gitPull(UPSTREAM_NAME, QUARTZ_SOURCE_BRANCH)
await popContentFolder(contentFolder)
console.log("Ensuring dependencies are up to date")
spawnSync("npm", ["i"], { stdio: "inherit" })
console.log(chalk.green("Done!"))
})
+ .command(
+ "restore",
+ "Try to restore your content folder from the cache",
+ CommonArgv,
+ async (argv) => {
+ const contentFolder = path.join(cwd, argv.directory)
+ await popContentFolder(contentFolder)
+ },
+ )
.command("sync", "Sync your Quartz to and from GitHub.", SyncArgv, async (argv) => {
const contentFolder = path.join(cwd, argv.directory)
console.log(chalk.bgGreen.black(`\n Quartz v${version} \n`))
console.log("Backing up your content")
if (argv.commit) {
+ const contentStat = await fs.promises.lstat(contentFolder)
+ if (contentStat.isSymbolicLink()) {
+ const linkTarg = await fs.promises.readlink(contentFolder)
+ console.log(chalk.yellow("Detected symlink, trying to dereference before committing"))
+
+ // stash symlink file
+ await stashContentFolder(contentFolder)
+
+ // follow symlink and copy content
+ await fs.promises.cp(linkTarg, contentFolder, {
+ recursive: true,
+ preserveTimestamps: true,
+ })
+ }
+
const currentTimestamp = new Date().toLocaleString("en-US", {
dateStyle: "medium",
timeStyle: "short",
})
- spawnSync("git", ["commit", "-am", `Quartz sync: ${currentTimestamp}`], { stdio: "inherit" })
+ spawnSync("git", ["add", "."], { stdio: "inherit" })
+ spawnSync("git", ["commit", "-m", `Quartz sync: ${currentTimestamp}`], { stdio: "inherit" })
+
+ if (contentStat.isSymbolicLink()) {
+ // put symlink back
+ await popContentFolder(contentFolder)
+ }
}
await stashContentFolder(contentFolder)
@@ -298,27 +418,20 @@
outfile: path.join("quartz", cacheFile),
bundle: true,
keepNames: true,
- minify: true,
+ minifyWhitespace: true,
+ minifySyntax: true,
platform: "node",
format: "esm",
jsx: "automatic",
jsxImportSource: "preact",
packages: "external",
metafile: true,
- sourcemap: "inline",
+ sourcemap: true,
sourcesContent: false,
plugins: [
sassPlugin({
type: "css-text",
cssImports: true,
- async transform(css) {
- const { code } = cssTransform({
- filename: "style.css",
- code: Buffer.from(css),
- minify: true,
- })
- return code.toString()
- },
}),
{
name: "inline-script-loader",
@@ -355,12 +468,29 @@
],
})
+ const buildMutex = new Mutex()
+ let lastBuildMs = 0
+ let cleanupBuild = null
const build = async (clientRefresh) => {
+ const buildStart = new Date().getTime()
+ lastBuildMs = buildStart
+ const release = await buildMutex.acquire()
+ if (lastBuildMs > buildStart) {
+ release()
+ return
+ }
+
+ if (cleanupBuild) {
+ await cleanupBuild()
+ console.log(chalk.yellow("Detected a source code change, doing a hard rebuild..."))
+ }
+
const result = await ctx.rebuild().catch((err) => {
console.error(`${chalk.red("Couldn't parse Quartz configuration:")} ${fp}`)
console.log(`Reason: ${chalk.grey(err)}`)
process.exit(1)
})
+ release()
if (argv.bundleInfo) {
const outputFileName = "quartz/.quartz-cache/transpiled-build.mjs"
@@ -374,42 +504,120 @@
}
// bypass module cache
+ // https://github.com/nodejs/modules/issues/307
const { default: buildQuartz } = await import(cacheFile + `?update=${randomUUID()}`)
- await buildQuartz(argv, clientRefresh)
+ cleanupBuild = await buildQuartz(argv, buildMutex, clientRefresh)
clientRefresh()
}
if (argv.serve) {
- const wss = new WebSocketServer({ port: 3001 })
const connections = []
- wss.on("connection", (ws) => connections.push(ws))
const clientRefresh = () => connections.forEach((conn) => conn.send("rebuild"))
+ if (argv.baseDir !== "" && !argv.baseDir.startsWith("/")) {
+ argv.baseDir = "/" + argv.baseDir
+ }
+
await build(clientRefresh)
const server = http.createServer(async (req, res) => {
- await serveHandler(req, res, {
- public: argv.output,
- directoryListing: false,
- })
- const status = res.statusCode
- const statusString =
- status >= 200 && status < 300
- ? chalk.green(`[${status}]`)
- : status >= 300 && status < 400
- ? chalk.yellow(`[${status}]`)
- : chalk.red(`[${status}]`)
- console.log(statusString + chalk.grey(` ${req.url}`))
+ if (argv.baseDir && !req.url?.startsWith(argv.baseDir)) {
+ console.log(
+ chalk.red(
+ `[404] ${req.url} (warning: link outside of site, this is likely a Quartz bug)`,
+ ),
+ )
+ res.writeHead(404)
+ res.end()
+ return
+ }
+
+ // strip baseDir prefix
+ req.url = req.url?.slice(argv.baseDir.length)
+
+ const serve = async () => {
+ const release = await buildMutex.acquire()
+ await serveHandler(req, res, {
+ public: argv.output,
+ directoryListing: false,
+ headers: [
+ {
+ source: "**/*.html",
+ headers: [{ key: "Content-Disposition", value: "inline" }],
+ },
+ ],
+ })
+ const status = res.statusCode
+ const statusString =
+ status >= 200 && status < 300 ? chalk.green(`[${status}]`) : chalk.red(`[${status}]`)
+ console.log(statusString + chalk.grey(` ${argv.baseDir}${req.url}`))
+ release()
+ }
+
+ const redirect = (newFp) => {
+ newFp = argv.baseDir + newFp
+ res.writeHead(302, {
+ Location: newFp,
+ })
+ console.log(chalk.yellow("[302]") + chalk.grey(` ${argv.baseDir}${req.url} -> ${newFp}`))
+ res.end()
+ }
+
+ let fp = req.url?.split("?")[0] ?? "/"
+
+ // handle redirects
+ if (fp.endsWith("/")) {
+ // /trailing/
+ // does /trailing/index.html exist? if so, serve it
+ const indexFp = path.posix.join(fp, "index.html")
+ if (fs.existsSync(path.posix.join(argv.output, indexFp))) {
+ req.url = fp
+ return serve()
+ }
+
+ // does /trailing.html exist? if so, redirect to /trailing
+ let base = fp.slice(0, -1)
+ if (path.extname(base) === "") {
+ base += ".html"
+ }
+ if (fs.existsSync(path.posix.join(argv.output, base))) {
+ return redirect(fp.slice(0, -1))
+ }
+ } else {
+ // /regular
+ // does /regular.html exist? if so, serve it
+ let base = fp
+ if (path.extname(base) === "") {
+ base += ".html"
+ }
+ if (fs.existsSync(path.posix.join(argv.output, base))) {
+ req.url = fp
+ return serve()
+ }
+
+ // does /regular/index.html exist? if so, redirect to /regular/
+ let indexFp = path.posix.join(fp, "index.html")
+ if (fs.existsSync(path.posix.join(argv.output, indexFp))) {
+ return redirect(fp + "/")
+ }
+ }
+
+ return serve()
})
server.listen(argv.port)
- console.log(chalk.cyan(`Started a Quartz server listening at http://localhost:${argv.port}`))
+ const wss = new WebSocketServer({ port: 3001 })
+ wss.on("connection", (ws) => connections.push(ws))
+ console.log(
+ chalk.cyan(
+ `Started a Quartz server listening at http://localhost:${argv.port}${argv.baseDir}`,
+ ),
+ )
console.log("hint: exit with ctrl+c")
chokidar
.watch(["**/*.ts", "**/*.tsx", "**/*.scss", "package.json"], {
ignoreInitial: true,
})
.on("all", async () => {
- console.log(chalk.yellow("Detected a source code change, doing a hard rebuild..."))
- await build(clientRefresh)
+ build(clientRefresh)
})
} else {
await build(() => {})
--
Gitblit v1.10.0