remove checkout step from instructions as v4 is the default branch

Jacky Zhao

2023-08-20 425c9789a451e69adbba2d99193e38e8915e8804

 quartz/bootstrap-cli.mjs

@@ -9,11 +9,18 @@
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 { spawnSync } from "child_process"
import { execSync, spawnSync } from "child_process"
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"
@@ -48,12 +55,6 @@
    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",
  },
  pull: {
    boolean: true,
    default: true,
@@ -74,6 +75,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,
@@ -84,6 +90,10 @@
    default: false,
    describe: "show detailed bundle information",
  },
  concurrency: {
    number: true,
    describe: "how many threads to use to parse notes",
  },
}

function escapePath(fp) {
@@ -104,6 +114,7 @@
}

async function stashContentFolder(contentFolder) {
  await fs.promises.rm(contentCacheFolder, { force: true, recursive: true })
  await fs.promises.cp(contentFolder, contentCacheFolder, {
    force: true,
    recursive: true,
@@ -114,6 +125,7 @@
}

async function popContentFolder(contentFolder) {
  await fs.promises.rm(contentFolder, { force: true, recursive: true })
  await fs.promises.cp(contentCacheFolder, contentFolder, {
    force: true,
    recursive: true,
@@ -123,6 +135,14 @@
  await fs.promises.rm(contentCacheFolder, { force: true, recursive: true })
}

function gitPull(origin, branch) {
  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)
@@ -136,7 +156,7 @@
        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: "copy", label: "Copy an existing folder", hint: "overwrites `content`" },
          {
            value: "symlink",
            label: "Symlink an existing folder",
@@ -149,12 +169,10 @@

    async function rmContentFolder() {
      const contentStat = await fs.promises.lstat(contentFolder)
      if (contentStat) {
        if (contentStat.isSymbolicLink()) {
          await fs.promises.unlink(contentFolder)
        } else {
          await rimraf(contentFolder)
        }
      if (contentStat.isSymbolicLink()) {
        await fs.promises.unlink(contentFolder)
      } else {
        await rimraf(contentFolder)
      }
    }

@@ -179,7 +197,10 @@

      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")
      }
@@ -241,25 +262,60 @@
    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.",
    )
    spawnSync("git", ["pull", UPSTREAM_NAME, QUARTZ_SOURCE_BRANCH], { stdio: "inherit" })
    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)
@@ -268,96 +324,215 @@
      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" })
      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!"))
  })
  .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,
        minify: true,
        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")
    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,
      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")

                // remove default exports that we manually inserted
                text = text.replace("export default", "")
                text = text.replace("export", "")
              // 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",
                    resolveDir,
                    sourcefile,
                  },
                  write: false,
                  minify: true,
                  bundle: true,
                  platform: "browser",
                  format: "esm",
                })
                const rawMod = transpiled.outputFiles[0].text
                return {
                  contents: rawMod,
                  loader: "text",
                }
              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",
              })
            },
              const rawMod = transpiled.outputFiles[0].text
              return {
                contents: rawMod,
                loader: "text",
              }
            })
          },
        ],
      })
      .catch((err) => {
        },
      ],
    })

    const buildMutex = new Mutex()
    const timeoutIds = new Set()
    const build = async (clientRefresh) => {
      await buildMutex.acquire()
      const result = await ctx.rebuild().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.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 }))
      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()
      buildMutex.release()
    }

    const { default: buildQuartz } = await import(cacheFile)
    buildQuartz(argv, version)
    const rebuild = (clientRefresh) => {
      timeoutIds.forEach((id) => clearTimeout(id))
      timeoutIds.clear()
      timeoutIds.add(setTimeout(() => build(clientRefresh), 250))
    }

    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) => {
        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 () => {
          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(` ${argv.baseDir}${req.url}`))
        }

        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}${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..."))
          rebuild(clientRefresh)
        })
    } else {
      await build(() => {})
      ctx.dispose()
    }
  })
  .showHelpOnFail(false)
  .help()