hot content reload

Jacky Zhao

2023-07-22 8dd73704e6e95254d2addf51fede6329f90796b8

 quartz/bootstrap-cli.mjs

@@ -10,28 +10,18 @@
import { intro, isCancel, outro, select, text } from '@clack/prompts'
import { rimraf } from 'rimraf'
import prettyBytes from 'pretty-bytes'
import { spawnSync } from 'child_process'

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"
const fp = "./quartz/build.ts"
const { version } = JSON.parse(readFileSync("./package.json").toString())
const contentCacheFolder = path.join(cacheDir, "content-cache")

export const BuildArgv = {
  output: {
    string: true,
    alias: ['o'],
    default: 'public',
    describe: 'output folder for files'
  },
  serve: {
    boolean: true,
    default: false,
    describe: 'run a local server to preview your Quartz'
  },
  port: {
    number: true,
    default: 8080,
    describe: 'port to serve Quartz on'
  },
const CommonArgv = {
  directory: {
    string: true,
    alias: ['d'],
@@ -46,6 +36,52 @@
  }
}

const SyncArgv = {
  ...CommonArgv,
  commit: {
    boolean: true,
    default: true,
    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'
  },
  pull: {
    boolean: true,
    default: true,
    describe: 'pull updates from your Quartz fork'
  }
}

const BuildArgv = {
  ...CommonArgv,
  output: {
    string: true,
    alias: ['o'],
    default: 'public',
    describe: 'output folder for files'
  },
  serve: {
    boolean: true,
    default: false,
    describe: 'run a local server to live-preview your Quartz'
  },
  port: {
    number: true,
    default: 8080,
    describe: 'port to serve Quartz on'
  },
}


function escapePath(fp) {
  return fp
    .replace(/\\ /g, " ") // unescape spaces
@@ -64,15 +100,24 @@
  }
}

async function stashContentFolder(contentFolder) {
  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(contentCacheFolder, { force: true, recursive: true })
}

yargs(hideBin(process.argv))
  .scriptName("quartz")
  .version(version)
  .usage('$0 <cmd> [args]')
  .command('create', 'Initialize Quartz', async (_argv) => {
  .command('create', 'Initialize Quartz', CommonArgv, async argv => {
    console.log()
    intro(chalk.bgGreen.black(` Quartz v${version} `))
    const cwd = process.cwd()
    const contentFolder = path.join(cwd, "content")
    const contentFolder = path.join(cwd, argv.directory)
    const setupStrategy = exitIfCancel(await select({
      message: `Choose how to initialize the content in \`${contentFolder}\``,
      options: [
@@ -83,16 +128,6 @@
      ]
    }))

    // 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" },
      ]
    }))

    async function rmContentFolder() {
      const contentStat = await fs.promises.lstat(contentFolder)
      if (contentStat) {
@@ -137,6 +172,16 @@
`
      )
    }
    
    // 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")
@@ -150,13 +195,45 @@
   • Hosting your Quartz online (see: https://quartz.jzhao.xyz/setup/hosting)
`)
  })
  .command('update', 'Get the latest Quartz updates', () => {
    // TODO
  .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')
    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' })
    await popContentFolder(contentFolder)
    console.log(chalk.green('Done!'))
  })
  .command('push', 'Push your Quartz updates to GitHub', () => {
    // TODO
  .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 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' })
    }

    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' })
    }

    console.log(chalk.green('Done!'))
  })
  .command('build', 'Build Quartz into a bundle of static HTML files', BuildArgv, async (argv) => {
  .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),
@@ -178,6 +255,7 @@
          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', '')
@@ -215,11 +293,11 @@
    if (argv.verbose) {
      const outputFileName = 'quartz/.quartz-cache/transpiled-build.mjs'
      const meta = result.metafile.outputs[outputFileName]
      console.log(chalk.gray(`[debug] Successfully transpiled ${Object.keys(meta.inputs).length} files (${prettyBytes(meta.bytes)})`))
      console.log(`Successfully transpiled ${Object.keys(meta.inputs).length} files (${prettyBytes(meta.bytes)})`)
    }

    const { default: init } = await import(cacheFile)
    init(argv, version)
    const { default: buildQuartz } = await import(cacheFile)
    buildQuartz(argv, version)
  })
  .showHelpOnFail(false)
  .help()