From 6d49d975598cd7f48e2b7347c2b83d8aac6a2f56 Mon Sep 17 00:00:00 2001
From: Aswanth <aswanth366@gmail.com>
Date: Sat, 24 May 2025 04:55:07 +0000
Subject: [PATCH] fix(analytics): streamline posthog script loading and event capturing (#1974)
---
quartz/cli/handlers.js | 117 ++++++++++++++++++++++++++++++++++++++++++++--------------
1 files changed, 88 insertions(+), 29 deletions(-)
diff --git a/quartz/cli/handlers.js b/quartz/cli/handlers.js
index 8460dad..0cb371b 100644
--- a/quartz/cli/handlers.js
+++ b/quartz/cli/handlers.js
@@ -5,6 +5,7 @@
import { sassPlugin } from "esbuild-sass-plugin"
import fs from "fs"
import { intro, 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"
@@ -14,13 +15,13 @@
import { randomUUID } from "crypto"
import { Mutex } from "async-mutex"
import { CreateArgv } from "./args.js"
+import { globby } from "globby"
import {
exitIfCancel,
escapePath,
gitPull,
popContentFolder,
stashContentFolder,
- rmrf,
} from "./helpers.js"
import {
UPSTREAM_NAME,
@@ -33,18 +34,27 @@
} from "./constants.js"
/**
+ * Resolve content directory path
+ * @param contentPath path to resolve
+ */
+function resolveContentPath(contentPath) {
+ if (path.isAbsolute(contentPath)) return path.relative(cwd, contentPath)
+ return path.join(cwd, contentPath)
+}
+
+/**
* Handles `npx quartz create`
* @param {*} argv arguments for `create`
*/
export async function handleCreate(argv) {
console.log()
intro(chalk.bgGreen.black(` Quartz v${version} `))
- const contentFolder = path.join(cwd, argv.directory)
+ const contentFolder = resolveContentPath(argv.directory)
let setupStrategy = argv.strategy?.toLowerCase()
let linkResolutionStrategy = argv.links?.toLowerCase()
const sourceDirectory = argv.source
- // If all cmd arguments were provided, check if theyre valid
+ // If all cmd arguments were provided, check if they're valid
if (setupStrategy && linkResolutionStrategy) {
// If setup isn't, "new", source argument is required
if (setupStrategy !== "new") {
@@ -109,7 +119,7 @@
if (contentStat.isSymbolicLink()) {
await fs.promises.unlink(contentFolder)
} else {
- await rmrf(contentFolder)
+ await rimraf(contentFolder)
}
}
@@ -168,22 +178,20 @@
// 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\`.`,
+ message: `Choose how Quartz should resolve links in your content. This should match Obsidian's link format. 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",
+ hint: "(default)",
+ },
+ {
+ value: "absolute",
+ label: "Treat links as absolute path",
},
{
value: "relative",
label: "Treat links as relative paths",
- hint: "for just normal Markdown files",
},
],
}),
@@ -202,6 +210,7 @@
// setup remote
execSync(
`git remote show upstream || git remote add upstream https://github.com/jackyzha0/quartz.git`,
+ { stdio: "ignore" },
)
outro(`You're all set! Not sure what to do next? Try:
@@ -216,6 +225,10 @@
* @param {*} argv arguments for `build`
*/
export async function handleBuild(argv) {
+ if (argv.serve) {
+ argv.watch = true
+ }
+
console.log(chalk.bgGreen.black(`\n Quartz v${version} \n`))
const ctx = await esbuild.context({
entryPoints: [fp],
@@ -237,6 +250,11 @@
type: "css-text",
cssImports: true,
}),
+ sassPlugin({
+ filter: /\.inline\.scss$/,
+ type: "css",
+ cssImports: true,
+ }),
{
name: "inline-script-loader",
setup(build) {
@@ -258,6 +276,7 @@
},
write: false,
bundle: true,
+ minify: true,
platform: "browser",
format: "esm",
})
@@ -285,8 +304,8 @@
}
if (cleanupBuild) {
- await cleanupBuild()
console.log(chalk.yellow("Detected a source code change, doing a hard rebuild..."))
+ await cleanupBuild()
}
const result = await ctx.rebuild().catch((err) => {
@@ -316,9 +335,10 @@
clientRefresh()
}
+ let clientRefresh = () => {}
if (argv.serve) {
const connections = []
- const clientRefresh = () => connections.forEach((conn) => conn.send("rebuild"))
+ clientRefresh = () => connections.forEach((conn) => conn.send("rebuild"))
if (argv.baseDir !== "" && !argv.baseDir.startsWith("/")) {
argv.baseDir = "/" + argv.baseDir
@@ -347,9 +367,18 @@
directoryListing: false,
headers: [
{
- source: "**/*.html",
+ source: "**/*.*",
headers: [{ key: "Content-Disposition", value: "inline" }],
},
+ {
+ source: "**/*.webp",
+ headers: [{ key: "Content-Type", value: "image/webp" }],
+ },
+ // fixes bug where avif images are displayed as text instead of images (future proof)
+ {
+ source: "**/*.avif",
+ headers: [{ key: "Content-Type", value: "image/avif" }],
+ },
],
})
const status = res.statusCode
@@ -409,6 +438,7 @@
return serve()
})
+
server.listen(argv.port)
const wss = new WebSocketServer({ port: argv.wsPort })
wss.on("connection", (ws) => connections.push(ws))
@@ -417,18 +447,28 @@
`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 () => {
- build(clientRefresh)
- })
} else {
- await build(() => {})
+ await build(clientRefresh)
ctx.dispose()
}
+
+ if (argv.watch) {
+ const paths = await globby([
+ "**/*.ts",
+ "quartz/cli/*.js",
+ "quartz/static/**/*",
+ "**/*.tsx",
+ "**/*.scss",
+ "package.json",
+ ])
+ chokidar
+ .watch(paths, { ignoreInitial: true })
+ .on("add", () => build(clientRefresh))
+ .on("change", () => build(clientRefresh))
+ .on("unlink", () => build(clientRefresh))
+
+ console.log(chalk.grey("hint: exit with ctrl+c"))
+ }
}
/**
@@ -436,7 +476,7 @@
* @param {*} argv arguments for `update`
*/
export async function handleUpdate(argv) {
- const contentFolder = path.join(cwd, argv.directory)
+ const contentFolder = resolveContentPath(argv.directory)
console.log(chalk.bgGreen.black(`\n Quartz v${version} \n`))
console.log("Backing up your content")
execSync(
@@ -457,7 +497,25 @@
await popContentFolder(contentFolder)
console.log("Ensuring dependencies are up to date")
- const res = spawnSync("npm", ["i"], { stdio: "inherit" })
+
+ /*
+ On Windows, if the command `npm` is really `npm.cmd', this call fails
+ as it will be unable to find `npm`. This is often the case on systems
+ where `npm` is installed via a package manager.
+
+ This means `npx quartz update` will not actually update dependencies
+ on Windows, without a manual `npm i` from the caller.
+
+ However, by spawning a shell, we are able to call `npm.cmd`.
+ See: https://nodejs.org/api/child_process.html#spawning-bat-and-cmd-files-on-windows
+ */
+
+ const opts = { stdio: "inherit" }
+ if (process.platform === "win32") {
+ opts.shell = true
+ }
+
+ const res = spawnSync("npm", ["i"], opts)
if (res.status === 0) {
console.log(chalk.green("Done!"))
} else {
@@ -470,7 +528,7 @@
* @param {*} argv arguments for `restore`
*/
export async function handleRestore(argv) {
- const contentFolder = path.join(cwd, argv.directory)
+ const contentFolder = resolveContentPath(argv.directory)
await popContentFolder(contentFolder)
}
@@ -479,7 +537,7 @@
* @param {*} argv arguments for `sync`
*/
export async function handleSync(argv) {
- const contentFolder = path.join(cwd, argv.directory)
+ const contentFolder = resolveContentPath(argv.directory)
console.log(chalk.bgGreen.black(`\n Quartz v${version} \n`))
console.log("Backing up your content")
@@ -531,7 +589,8 @@
await popContentFolder(contentFolder)
if (argv.push) {
console.log("Pushing your changes")
- const res = spawnSync("git", ["push", "-uf", ORIGIN_NAME, QUARTZ_SOURCE_BRANCH], {
+ const currentBranch = execSync("git rev-parse --abbrev-ref HEAD").toString().trim()
+ const res = spawnSync("git", ["push", "-uf", ORIGIN_NAME, currentBranch], {
stdio: "inherit",
})
if (res.status !== 0) {
--
Gitblit v1.10.0