quartz-research-note/quartz/bootstrap-cli.mjs

631 lines
20 KiB
JavaScript
Raw Normal View History

2023-05-29 00:44:08 +00:00
#!/usr/bin/env node
2023-07-23 00:27:41 +00:00
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"
2023-07-23 00:27:41 +00:00
import prettyBytes from "pretty-bytes"
2023-08-04 06:08:04 +00:00
import { execSync, spawnSync } from "child_process"
import http from "http"
import serveHandler from "serve-handler"
import { WebSocketServer } from "ws"
2023-08-05 23:43:50 +00:00
import { randomUUID } from "crypto"
import { Mutex } from "async-mutex"
2023-05-30 15:02:20 +00:00
2023-08-03 06:29:28 +00:00
const ORIGIN_NAME = "origin"
2023-07-23 00:27:41 +00:00
const UPSTREAM_NAME = "upstream"
2023-08-19 01:24:09 +00:00
const QUARTZ_SOURCE_BRANCH = "v4"
2023-07-20 04:59:39 +00:00
const cwd = process.cwd()
const cacheDir = path.join(cwd, ".quartz-cache")
2023-06-04 16:35:45 +00:00
const cacheFile = "./.quartz-cache/transpiled-build.mjs"
const fp = "./quartz/build.ts"
2023-05-30 15:02:20 +00:00
const { version } = JSON.parse(readFileSync("./package.json").toString())
2023-07-20 04:59:39 +00:00
const contentCacheFolder = path.join(cacheDir, "content-cache")
2023-05-30 15:02:20 +00:00
2023-07-20 04:59:39 +00:00
const CommonArgv = {
directory: {
string: true,
2023-07-23 00:27:41 +00:00
alias: ["d"],
default: "content",
describe: "directory to look for content files",
2023-07-20 04:59:39 +00:00
},
verbose: {
boolean: true,
2023-07-23 00:27:41 +00:00
alias: ["v"],
2023-07-20 04:59:39 +00:00
default: false,
2023-07-23 00:27:41 +00:00
describe: "print out extra logging information",
},
2023-07-20 04:59:39 +00:00
}
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",
},
}
2023-07-20 04:59:39 +00:00
const SyncArgv = {
...CommonArgv,
commit: {
boolean: true,
default: true,
2023-07-23 00:27:41 +00:00
describe: "create a git commit for your unsaved changes",
2023-07-20 04:59:39 +00:00
},
push: {
boolean: true,
default: true,
2023-07-23 00:27:41 +00:00
describe: "push updates to your Quartz fork",
2023-07-20 04:59:39 +00:00
},
pull: {
boolean: true,
default: true,
2023-07-23 00:27:41 +00:00
describe: "pull updates from your Quartz fork",
},
2023-07-20 04:59:39 +00:00
}
const BuildArgv = {
...CommonArgv,
2023-05-30 15:02:20 +00:00
output: {
string: true,
2023-07-23 00:27:41 +00:00
alias: ["o"],
default: "public",
describe: "output folder for files",
2023-05-30 15:02:20 +00:00
},
serve: {
boolean: true,
default: false,
2023-07-23 00:27:41 +00:00
describe: "run a local server to live-preview your Quartz",
2023-05-30 15:02:20 +00:00
},
baseDir: {
string: true,
default: "",
describe: "base path to serve your local server on",
},
2023-05-30 15:02:20 +00:00
port: {
number: true,
default: 8080,
2023-07-23 00:27:41 +00:00
describe: "port to serve Quartz on",
2023-05-30 15:02:20 +00:00
},
2023-07-24 00:58:35 +00:00
bundleInfo: {
boolean: true,
default: false,
describe: "show detailed bundle information",
},
concurrency: {
number: true,
2023-08-09 05:53:01 +00:00
describe: "how many threads to use to parse notes",
},
2023-05-30 15:02:20 +00:00
}
2023-07-06 23:56:30 +00:00
function escapePath(fp) {
return fp
.replace(/\\ /g, " ") // unescape spaces
.replace(/^".*"$/, "$1")
.replace(/^'.*"$/, "$1")
.trim()
}
function exitIfCancel(val) {
if (isCancel(val)) {
outro(chalk.red("Exiting"))
process.exit(0)
} else {
return val
}
}
2023-07-20 04:59:39 +00:00
async function stashContentFolder(contentFolder) {
2023-08-18 04:07:40 +00:00
await fs.promises.rm(contentCacheFolder, { force: true, recursive: true })
2023-07-23 00:27:41 +00:00
await fs.promises.cp(contentFolder, contentCacheFolder, {
force: true,
recursive: true,
verbatimSymlinks: true,
preserveTimestamps: true,
})
2023-07-20 04:59:39 +00:00
await fs.promises.rm(contentFolder, { force: true, recursive: true })
}
async function popContentFolder(contentFolder) {
await fs.promises.rm(contentFolder, { force: true, recursive: true })
2023-07-23 00:27:41 +00:00
await fs.promises.cp(contentCacheFolder, contentFolder, {
force: true,
recursive: true,
verbatimSymlinks: true,
preserveTimestamps: true,
})
2023-07-20 04:59:39 +00:00
await fs.promises.rm(contentCacheFolder, { force: true, recursive: true })
}
2023-08-03 06:29:28 +00:00
function gitPull(origin, branch) {
2023-08-09 16:10:40 +00:00
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}`)
}
2023-08-03 06:29:28 +00:00
}
2023-05-30 15:02:20 +00:00
yargs(hideBin(process.argv))
.scriptName("quartz")
.version(version)
2023-07-23 00:27:41 +00:00
.usage("$0 <cmd> [args]")
.command("create", "Initialize Quartz", CreateArgv, async (argv) => {
console.log()
intro(chalk.bgGreen.black(` Quartz v${version} `))
2023-07-20 04:59:39 +00:00
const contentFolder = path.join(cwd, 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 (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 {
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)
}
}
}
}
// 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() {
2023-07-06 23:56:30 +00:00
const contentStat = await fs.promises.lstat(contentFolder)
2023-08-18 04:07:40 +00:00
if (contentStat.isSymbolicLink()) {
await fs.promises.unlink(contentFolder)
} else {
await rimraf(contentFolder)
}
}
await fs.promises.unlink(path.join(contentFolder, ".gitkeep"))
2023-07-23 00:27:41 +00:00
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()
2023-07-23 00:27:41 +00:00
if (setupStrategy === "copy") {
2023-08-18 04:54:42 +00:00
await fs.promises.cp(originalFolder, contentFolder, {
recursive: true,
preserveTimestamps: true,
})
2023-07-23 00:27:41 +00:00
} else if (setupStrategy === "symlink") {
await fs.promises.symlink(originalFolder, contentFolder, "dir")
}
2023-07-23 00:27:41 +00:00
} else if (setupStrategy === "new") {
await fs.promises.writeFile(
path.join(contentFolder, "index.md"),
2023-07-06 23:56:30 +00:00
`---
title: Welcome to Quartz
---
This is a blank Quartz installation.
See the [documentation](https://quartz.jzhao.xyz) for how to get started.
2023-07-23 00:27:41 +00:00
`,
)
}
2023-07-23 00:27:41 +00:00
// 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")
2023-07-23 00:27:41 +00:00
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:
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/hosting)
`)
})
2023-07-23 00:27:41 +00:00
.command("update", "Get the latest Quartz updates", CommonArgv, async (argv) => {
2023-07-20 04:59:39 +00:00
const contentFolder = path.join(cwd, argv.directory)
console.log(chalk.bgGreen.black(`\n Quartz v${version} \n`))
2023-07-23 00:27:41 +00:00
console.log("Backing up your content")
execSync(
`git remote show upstream || git remote add upstream https://github.com/jackyzha0/quartz.git`,
)
2023-07-20 04:59:39 +00:00
await stashContentFolder(contentFolder)
2023-07-23 00:27:41 +00:00
console.log(
"Pulling updates... you may need to resolve some `git` conflicts if you've made changes to components or plugins.",
)
2023-08-03 06:29:28 +00:00
gitPull(UPSTREAM_NAME, QUARTZ_SOURCE_BRANCH)
2023-07-20 04:59:39 +00:00
await popContentFolder(contentFolder)
2023-07-24 04:53:34 +00:00
console.log("Ensuring dependencies are up to date")
spawnSync("npm", ["i"], { stdio: "inherit" })
2023-07-23 00:27:41 +00:00
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)
},
)
2023-07-23 00:27:41 +00:00
.command("sync", "Sync your Quartz to and from GitHub.", SyncArgv, async (argv) => {
2023-07-20 04:59:39 +00:00
const contentFolder = path.join(cwd, argv.directory)
console.log(chalk.bgGreen.black(`\n Quartz v${version} \n`))
2023-07-23 00:27:41 +00:00
console.log("Backing up your content")
2023-07-20 04:59:39 +00:00
if (argv.commit) {
2023-08-18 04:07:40 +00:00
const contentStat = await fs.promises.lstat(contentFolder)
if (contentStat.isSymbolicLink()) {
const linkTarg = await fs.promises.readlink(contentFolder)
2023-08-18 04:07:40 +00:00
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,
})
}
2023-07-23 00:27:41 +00:00
const currentTimestamp = new Date().toLocaleString("en-US", {
dateStyle: "medium",
timeStyle: "short",
})
2023-08-18 04:49:58 +00:00
spawnSync("git", ["add", "."], { stdio: "inherit" })
spawnSync("git", ["commit", "-m", `Quartz sync: ${currentTimestamp}`], { stdio: "inherit" })
2023-08-18 04:07:40 +00:00
if (contentStat.isSymbolicLink()) {
// put symlink back
await popContentFolder(contentFolder)
2023-08-18 04:07:40 +00:00
}
2023-07-20 04:59:39 +00:00
}
await stashContentFolder(contentFolder)
if (argv.pull) {
2023-07-23 00:27:41 +00:00
console.log(
"Pulling updates from your repository. You may need to resolve some `git` conflicts if you've made changes to components or plugins.",
)
2023-08-03 06:29:28 +00:00
gitPull(ORIGIN_NAME, QUARTZ_SOURCE_BRANCH)
2023-07-20 04:59:39 +00:00
}
await popContentFolder(contentFolder)
if (argv.push) {
console.log("Pushing your changes")
2023-08-03 06:42:49 +00:00
spawnSync("git", ["push", "-f", ORIGIN_NAME, QUARTZ_SOURCE_BRANCH], { stdio: "inherit" })
2023-07-20 04:59:39 +00:00
}
2023-07-23 00:27:41 +00:00
console.log(chalk.green("Done!"))
})
2023-07-23 00:27:41 +00:00
.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",
jsxImportSource: "preact",
packages: "external",
metafile: true,
sourcemap: true,
2023-08-05 23:43:50 +00:00
sourcesContent: false,
plugins: [
sassPlugin({
type: "css-text",
cssImports: true,
}),
{
name: "inline-script-loader",
setup(build) {
build.onLoad({ filter: /\.inline\.(ts|js)$/ }, async (args) => {
let text = await promises.readFile(args.path, "utf8")
2023-07-22 23:06:36 +00:00
// remove default exports that we manually inserted
text = text.replace("export default", "")
text = text.replace("export", "")
2023-06-10 02:58:58 +00:00
const sourcefile = path.relative(path.resolve("."), args.path)
const resolveDir = path.dirname(sourcefile)
const transpiled = await esbuild.build({
stdin: {
contents: text,
loader: "ts",
resolveDir,
sourcefile,
},
write: false,
bundle: true,
platform: "browser",
format: "esm",
2023-06-03 19:07:19 +00:00
})
const rawMod = transpiled.outputFiles[0].text
return {
contents: rawMod,
loader: "text",
}
})
2023-07-23 00:27:41 +00:00
},
},
],
})
const buildMutex = new Mutex()
let lastBuildMs = 0
let cleanupBuild = null
2023-08-05 22:34:10 +00:00
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) => {
2023-07-23 00:27:41 +00:00
console.error(`${chalk.red("Couldn't parse Quartz configuration:")} ${fp}`)
console.log(`Reason: ${chalk.grey(err)}`)
process.exit(1)
})
release()
2023-05-30 15:02:20 +00:00
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
2023-08-05 23:43:50 +00:00
const { default: buildQuartz } = await import(cacheFile + `?update=${randomUUID()}`)
cleanupBuild = await buildQuartz(argv, buildMutex, clientRefresh)
clientRefresh()
}
if (argv.serve) {
const connections = []
2023-08-05 22:34:10 +00:00
const clientRefresh = () => connections.forEach((conn) => conn.send("rebuild"))
if (argv.baseDir !== "" && !argv.baseDir.startsWith("/")) {
argv.baseDir = "/" + argv.baseDir
}
2023-08-05 22:34:10 +00:00
await build(clientRefresh)
const server = http.createServer(async (req, res) => {
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)
2023-08-21 01:41:37 +00:00
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 () => {
build(clientRefresh)
})
} else {
2023-08-18 04:08:26 +00:00
await build(() => {})
ctx.dispose()
}
2023-05-30 15:02:20 +00:00
})
.showHelpOnFail(false)
.help()
.strict()
2023-07-23 00:27:41 +00:00
.demandCommand().argv