roadmap/quartz/bootstrap-cli.mjs

366 lines
11 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 prettyBytes from "pretty-bytes"
import { spawnSync } from "child_process"
2023-05-30 15:02:20 +00:00
2023-07-23 00:27:41 +00:00
const UPSTREAM_NAME = "upstream"
const QUARTZ_SOURCE_BRANCH = "v4-alpha"
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 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
},
force: {
boolean: true,
2023-07-23 00:27:41 +00:00
alias: ["f"],
2023-07-20 04:59:39 +00:00
default: true,
2023-07-23 00:27:41 +00:00
describe: "whether to apply the --force flag to git commands",
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
},
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",
},
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-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) {
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-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", CommonArgv, 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)
2023-07-23 00:27:41 +00:00
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() {
2023-07-06 23:56:30 +00:00
const contentStat = await fs.promises.lstat(contentFolder)
if (contentStat) {
if (contentStat.isSymbolicLink()) {
await fs.promises.unlink(contentFolder)
} else {
await rimraf(contentFolder)
}
}
}
2023-07-23 00:27:41 +00:00
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()
2023-07-23 00:27:41 +00:00
if (setupStrategy === "copy") {
2023-07-06 23:56:30 +00:00
await fs.promises.cp(originalFolder, contentFolder, { recursive: 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 rmContentFolder()
2023-07-06 23:56:30 +00:00
await fs.promises.mkdir(contentFolder)
2023-07-23 00:27:41 +00:00
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
// get a prefered link resolution strategy
2023-07-23 00:27:41 +00:00
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")
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/setup/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")
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.",
)
spawnSync("git", ["pull", UPSTREAM_NAME, QUARTZ_SOURCE_BRANCH], { stdio: "inherit" })
2023-07-20 04:59:39 +00:00
await popContentFolder(contentFolder)
2023-07-23 00:27:41 +00:00
console.log(chalk.green("Done!"))
})
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-07-23 00:27:41 +00:00
const currentTimestamp = new Date().toLocaleString("en-US", {
dateStyle: "medium",
timeStyle: "short",
})
spawnSync("git", ["commit", "-am", `Quartz sync: ${currentTimestamp}`], { stdio: "inherit" })
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.",
)
spawnSync("git", ["pull", "origin", QUARTZ_SOURCE_BRANCH], { stdio: "inherit" })
2023-07-20 04:59:39 +00:00
}
await popContentFolder(contentFolder)
if (argv.push) {
console.log("Pushing your changes")
2023-07-23 00:27:41 +00:00
const args = argv.force
? ["push", "-f", "origin", QUARTZ_SOURCE_BRANCH]
: ["push", "origin", QUARTZ_SOURCE_BRANCH]
spawnSync("git", args, { 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) => {
const result = await esbuild
.build({
entryPoints: [fp],
outfile: path.join("quartz", cacheFile),
bundle: true,
keepNames: true,
2023-07-24 00:58:35 +00:00
minify: true,
2023-07-23 00:27:41 +00:00
platform: "node",
format: "esm",
jsx: "automatic",
jsxImportSource: "preact",
packages: "external",
metafile: true,
sourcemap: true,
plugins: [
sassPlugin({
type: "css-text",
}),
{
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
2023-07-23 00:27:41 +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
2023-07-23 00:27:41 +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,
2023-07-24 00:58:35 +00:00
minify: true,
2023-07-23 00:27:41 +00:00
bundle: true,
platform: "browser",
format: "esm",
})
const rawMod = transpiled.outputFiles[0].text
return {
contents: rawMod,
loader: "text",
}
2023-06-03 19:07:19 +00:00
})
2023-07-23 00:27:41 +00:00
},
},
],
})
.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)
})
2023-05-30 15:02:20 +00:00
2023-07-24 00:58:35 +00:00
if (argv.bundleInfo) {
2023-07-23 00:27:41 +00:00
const outputFileName = "quartz/.quartz-cache/transpiled-build.mjs"
const meta = result.metafile.outputs[outputFileName]
2023-07-23 00:27:41 +00:00
console.log(
`Successfully transpiled ${Object.keys(meta.inputs).length} files (${prettyBytes(
meta.bytes,
)})`,
2023-07-23 00:27:41 +00:00
)
console.log(await esbuild.analyzeMetafile(result.metafile, { color: true }))
}
2023-07-21 04:51:55 +00:00
const { default: buildQuartz } = await import(cacheFile)
buildQuartz(argv, version)
2023-05-30 15:02:20 +00:00
})
.showHelpOnFail(false)
.help()
.strict()
2023-07-23 00:27:41 +00:00
.demandCommand().argv