From 0c199975f2d469ecdfd7efcf2ddd16ffa1dc492b Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Thu, 17 Aug 2023 07:55:28 +0000
Subject: [PATCH] various path fixes for links to extensions, fix relative paths in links
---
quartz/bootstrap-cli.mjs | 413 +++++++++++++++++++++++++++++++++++++++++-----------------
1 files changed, 289 insertions(+), 124 deletions(-)
diff --git a/quartz/bootstrap-cli.mjs b/quartz/bootstrap-cli.mjs
index f6f5543..8551e76 100755
--- a/quartz/bootstrap-cli.mjs
+++ b/quartz/bootstrap-cli.mjs
@@ -1,19 +1,25 @@
#!/usr/bin/env node
-import { promises, readFileSync } from 'fs'
-import yargs from 'yargs'
-import path from 'path'
-import { hideBin } from 'yargs/helpers'
-import esbuild from 'esbuild'
-import chalk from 'chalk'
-import { sassPlugin } from 'esbuild-sass-plugin'
-import fs from 'fs'
-import { intro, isCancel, outro, select, text } from '@clack/prompts'
-import { rimraf } from 'rimraf'
-import prettyBytes from 'pretty-bytes'
-import { spawnSync } from 'child_process'
+import { promises, readFileSync } from "fs"
+import yargs from "yargs"
+import path from "path"
+import { hideBin } from "yargs/helpers"
+import esbuild from "esbuild"
+import chalk from "chalk"
+import { sassPlugin } from "esbuild-sass-plugin"
+import fs from "fs"
+import { intro, isCancel, outro, select, text } from "@clack/prompts"
+import { rimraf } from "rimraf"
+import chokidar from "chokidar"
+import prettyBytes from "pretty-bytes"
+import { execSync, spawnSync } from "child_process"
+import http from "http"
+import serveHandler from "serve-handler"
+import { WebSocketServer } from "ws"
+import { randomUUID } from "crypto"
-const UPSTREAM_NAME = 'upstream'
-const QUARTZ_SOURCE_BRANCH = 'v4-alpha'
+const ORIGIN_NAME = "origin"
+const UPSTREAM_NAME = "upstream"
+const QUARTZ_SOURCE_BRANCH = "v4-alpha"
const cwd = process.cwd()
const cacheDir = path.join(cwd, ".quartz-cache")
const cacheFile = "./.quartz-cache/transpiled-build.mjs"
@@ -24,16 +30,16 @@
const CommonArgv = {
directory: {
string: true,
- alias: ['d'],
- default: 'content',
- describe: 'directory to look for content files'
+ alias: ["d"],
+ default: "content",
+ describe: "directory to look for content files",
},
verbose: {
boolean: true,
- alias: ['v'],
+ alias: ["v"],
default: false,
- describe: 'print out extra logging information'
- }
+ describe: "print out extra logging information",
+ },
}
const SyncArgv = {
@@ -41,47 +47,53 @@
commit: {
boolean: true,
default: true,
- describe: 'create a git commit for your unsaved changes'
+ describe: "create a git commit for your unsaved changes",
},
push: {
boolean: true,
default: true,
- describe: 'push updates to your Quartz fork'
- },
- force: {
- boolean: true,
- alias: ['f'],
- default: true,
- describe: 'whether to apply the --force flag to git commands'
+ describe: "push updates to your Quartz fork",
},
pull: {
boolean: true,
default: true,
- describe: 'pull updates from your Quartz fork'
- }
+ describe: "pull updates from your Quartz fork",
+ },
}
const BuildArgv = {
...CommonArgv,
output: {
string: true,
- alias: ['o'],
- default: 'public',
- describe: 'output folder for files'
+ alias: ["o"],
+ default: "public",
+ describe: "output folder for files",
},
serve: {
boolean: true,
default: false,
- describe: 'run a local server to preview your Quartz'
+ describe: "run a local server to live-preview your Quartz",
+ },
+ baseDir: {
+ string: true,
+ describe: "base path to serve your local server on",
},
port: {
number: true,
default: 8080,
- describe: 'port to serve Quartz on'
+ describe: "port to serve Quartz on",
+ },
+ bundleInfo: {
+ boolean: true,
+ default: false,
+ describe: "show detailed bundle information",
+ },
+ concurrency: {
+ number: true,
+ describe: "how many threads to use to parse notes",
},
}
-
function escapePath(fp) {
return fp
.replace(/\\ /g, " ") // unescape spaces
@@ -91,7 +103,6 @@
}
function exitIfCancel(val) {
-
if (isCancel(val)) {
outro(chalk.red("Exiting"))
process.exit(0)
@@ -101,42 +112,54 @@
}
async function stashContentFolder(contentFolder) {
- await fs.promises.cp(contentFolder, contentCacheFolder, { force: true, recursive: true, verbatimSymlinks: true, preserveTimestamps: true })
+ await fs.promises.cp(contentFolder, contentCacheFolder, {
+ force: true,
+ recursive: true,
+ verbatimSymlinks: true,
+ preserveTimestamps: true,
+ })
await fs.promises.rm(contentFolder, { force: true, recursive: true })
}
async function popContentFolder(contentFolder) {
- await fs.promises.cp(contentCacheFolder, contentFolder, { force: true, recursive: true, verbatimSymlinks: true, preserveTimestamps: true })
+ await fs.promises.rm(contentFolder, { force: true, recursive: true })
+ await fs.promises.cp(contentCacheFolder, contentFolder, {
+ force: true,
+ recursive: true,
+ verbatimSymlinks: true,
+ preserveTimestamps: true,
+ })
await fs.promises.rm(contentCacheFolder, { force: true, recursive: true })
}
+function gitPull(origin, branch) {
+ const flags = ["--no-rebase", "--autostash", "-s", "recursive", "-X", "ours", "--no-edit"]
+ spawnSync("git", ["pull", ...flags, origin, branch], { stdio: "inherit" })
+}
+
yargs(hideBin(process.argv))
.scriptName("quartz")
.version(version)
- .usage('$0 <cmd> [args]')
- .command('create', 'Initialize Quartz', CommonArgv, async argv => {
+ .usage("$0 <cmd> [args]")
+ .command("create", "Initialize Quartz", CommonArgv, 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" },
- ]
- }))
-
- // TODO
- 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" },
- ]
- }))
+ 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" },
+ ],
+ }),
+ )
async function rmContentFolder() {
const contentStat = await fs.promises.lstat(contentFolder)
@@ -149,44 +172,77 @@
}
}
- 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"
- }
- }
- })))
+ 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"
+ }
+ },
+ }),
+ ),
+ )
await rmContentFolder()
- if (setupStrategy === 'copy') {
+ if (setupStrategy === "copy") {
await fs.promises.cp(originalFolder, contentFolder, { recursive: true })
- } else if (setupStrategy === 'symlink') {
- await fs.promises.symlink(originalFolder, contentFolder, 'dir')
+ } else if (setupStrategy === "symlink") {
+ await fs.promises.symlink(originalFolder, contentFolder, "dir")
}
- } else if (setupStrategy === 'new') {
+ } else if (setupStrategy === "new") {
await rmContentFolder()
await fs.promises.mkdir(contentFolder)
- await fs.promises.writeFile(path.join(contentFolder, "index.md"),
+ await fs.promises.writeFile(
+ path.join(contentFolder, "index.md"),
`---
title: Welcome to Quartz
---
This is a blank Quartz installation.
See the [documentation](https://quartz.jzhao.xyz) for how to get started.
-`
+`,
)
}
+ // 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",
+ },
+ ],
+ }),
+ )
+
// now, do config changes
const configFilePath = path.join(cwd, "quartz.config.ts")
- let configContent = await fs.promises.readFile(configFilePath, { encoding: 'utf-8' })
- configContent = configContent.replace(/markdownLinkResolution: '(.+)'/, `markdownLinkResolution: '${linkResolutionStrategy}'`)
+ let configContent = await fs.promises.readFile(configFilePath, { encoding: "utf-8" })
+ configContent = configContent.replace(
+ /markdownLinkResolution: '(.+)'/,
+ `markdownLinkResolution: '${linkResolutionStrategy}'`,
+ )
await fs.promises.writeFile(configFilePath, configContent)
outro(`You're all set! Not sure what to do next? Try:
@@ -195,50 +251,62 @@
• Hosting your Quartz online (see: https://quartz.jzhao.xyz/setup/hosting)
`)
})
- .command('update', 'Get the latest Quartz updates', CommonArgv, async argv => {
+ .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')
+ console.log("Backing up your content")
await stashContentFolder(contentFolder)
- console.log("Pulling updates... you may need to resolve some `git` conflicts if you've made changes to components or plugins.")
- spawnSync('git', ['pull', UPSTREAM_NAME, QUARTZ_SOURCE_BRANCH], { stdio: 'inherit' })
+ 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(chalk.green('Done!'))
+ console.log("Ensuring dependencies are up to date")
+ spawnSync("npm", ["i"], { stdio: "inherit" })
+ console.log(chalk.green("Done!"))
})
- .command('sync', 'Sync your Quartz to and from GitHub.', SyncArgv, async argv => {
+ .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')
+ console.log("Backing up your content")
if (argv.commit) {
- const currentTimestamp = new Date().toLocaleString('en-US', { dateStyle: "medium", timeStyle: "short" })
- spawnSync('git', ['commit', '-am', `Quartz sync: ${currentTimestamp}`], { stdio: 'inherit' })
+ const currentTimestamp = new Date().toLocaleString("en-US", {
+ dateStyle: "medium",
+ timeStyle: "short",
+ })
+ spawnSync("git", ["commit", "-am", `Quartz sync: ${currentTimestamp}`], { stdio: "inherit" })
}
await stashContentFolder(contentFolder)
if (argv.pull) {
- console.log("Pulling updates from your repository. You may need to resolve some `git` conflicts if you've made changes to components or plugins.")
- spawnSync('git', ['pull', 'origin', QUARTZ_SOURCE_BRANCH], { stdio: 'inherit' })
+ console.log(
+ "Pulling updates from your repository. You may need to resolve some `git` conflicts if you've made changes to components or plugins.",
+ )
+ gitPull(ORIGIN_NAME, QUARTZ_SOURCE_BRANCH)
}
await popContentFolder(contentFolder)
if (argv.push) {
console.log("Pushing your changes")
- const args = argv.force ?
- ['push', '-f', 'origin', QUARTZ_SOURCE_BRANCH] :
- ['push', 'origin', QUARTZ_SOURCE_BRANCH]
- spawnSync('git', args, { stdio: 'inherit' })
+ spawnSync("git", ["push", "-f", ORIGIN_NAME, QUARTZ_SOURCE_BRANCH], { stdio: "inherit" })
}
- console.log(chalk.green('Done!'))
+ console.log(chalk.green("Done!"))
})
- .command('build', 'Build Quartz into a bundle of static HTML files', BuildArgv, async argv => {
- const result = await esbuild.build({
+ .command("build", "Build Quartz into a bundle of static HTML files", BuildArgv, async (argv) => {
+ console.log(chalk.bgGreen.black(`\n Quartz v${version} \n`))
+ const ctx = await esbuild.context({
entryPoints: [fp],
outfile: path.join("quartz", cacheFile),
bundle: true,
keepNames: true,
+ minifyWhitespace: true,
+ minifySyntax: true,
platform: "node",
format: "esm",
jsx: "automatic",
@@ -246,25 +314,28 @@
packages: "external",
metafile: true,
sourcemap: true,
+ sourcesContent: false,
plugins: [
sassPlugin({
- type: 'css-text',
+ type: "css-text",
+ cssImports: true,
}),
{
- name: 'inline-script-loader',
+ name: "inline-script-loader",
setup(build) {
build.onLoad({ filter: /\.inline\.(ts|js)$/ }, async (args) => {
- let text = await promises.readFile(args.path, 'utf8')
- // remove default exports that we manually inserted
- text = text.replace('export default', '')
- text = text.replace('export', '')
+ let text = await promises.readFile(args.path, "utf8")
- const sourcefile = path.relative(path.resolve('.'), args.path)
+ // remove default exports that we manually inserted
+ text = text.replace("export default", "")
+ text = text.replace("export", "")
+
+ const sourcefile = path.relative(path.resolve("."), args.path)
const resolveDir = path.dirname(sourcefile)
const transpiled = await esbuild.build({
stdin: {
contents: text,
- loader: 'ts',
+ loader: "ts",
resolveDir,
sourcefile,
},
@@ -276,30 +347,124 @@
const rawMod = transpiled.outputFiles[0].text
return {
contents: rawMod,
- loader: 'text',
+ loader: "text",
}
})
- }
- }
- ]
- }).catch(err => {
- console.error(`${chalk.red("Couldn't parse Quartz configuration:")} ${fp}`)
- console.log(`Reason: ${chalk.grey(err)}`)
- console.log("hint: make sure all the required dependencies are installed (run `npm install`)")
- process.exit(1)
+ },
+ },
+ ],
})
- if (argv.verbose) {
- const outputFileName = 'quartz/.quartz-cache/transpiled-build.mjs'
- const meta = result.metafile.outputs[outputFileName]
- console.log(`Successfully transpiled ${Object.keys(meta.inputs).length} files (${prettyBytes(meta.bytes)})`)
+ const build = async (clientRefresh) => {
+ 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)
+ })
+
+ if (argv.bundleInfo) {
+ const outputFileName = "quartz/.quartz-cache/transpiled-build.mjs"
+ const meta = result.metafile.outputs[outputFileName]
+ console.log(
+ `Successfully transpiled ${Object.keys(meta.inputs).length} files (${prettyBytes(
+ meta.bytes,
+ )})`,
+ )
+ console.log(await esbuild.analyzeMetafile(result.metafile, { color: true }))
+ }
+
+ // bypass module cache
+ // https://github.com/nodejs/modules/issues/307
+ const { default: buildQuartz } = await import(cacheFile + `?update=${randomUUID()}`)
+ await buildQuartz(argv, clientRefresh)
+ clientRefresh()
}
- const { default: init } = await import(cacheFile)
- init(argv, version)
+ 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"))
+
+ await build(clientRefresh)
+ const server = http.createServer(async (req, res) => {
+ const serve = async () => {
+ await serveHandler(req, res, {
+ public: argv.output,
+ directoryListing: false,
+ })
+ const status = res.statusCode
+ const statusString =
+ status >= 200 && status < 300 ? chalk.green(`[${status}]`) : chalk.red(`[${status}]`)
+ console.log(statusString + chalk.grey(` ${req.url}`))
+ }
+
+ const redirect = (newFp) => {
+ res.writeHead(302, {
+ Location: newFp,
+ })
+ console.log(chalk.yellow("[302]") + chalk.grey(` ${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}`))
+ 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)
+ })
+ } else {
+ await build(() => { })
+ ctx.dispose()
+ }
})
.showHelpOnFail(false)
.help()
.strict()
- .demandCommand()
- .argv
+ .demandCommand().argv
--
Gitblit v1.10.0