deref symlink on quartz sync

Jacky Zhao

2023-08-18 a7cca3242ad7adc5163d70aa2cc8ee23c92211e5

deref symlink on quartz sync

 content/features/upcoming features.md

@@ -1,12 +1,6 @@
---
draft: true
---

## todo

- dereference symlink for npx quartz sync
  - prompt user as to whether to do it (it's expensive for large vaults)

## high priority backlog

- block links: https://help.obsidian.md/Linking+notes+and+files/Internal+links#Link+to+a+block+in+a+note

 quartz/bootstrap-cli.mjs

@@ -112,6 +112,7 @@
}

async function stashContentFolder(contentFolder) {
  await fs.promises.rm(contentCacheFolder, { force: true, recursive: true })
  await fs.promises.cp(contentFolder, contentCacheFolder, {
    force: true,
    recursive: true,
@@ -150,7 +151,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",
@@ -163,14 +164,12 @@

    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 (setupStrategy === "copy" || setupStrategy === "symlink") {
      const originalFolder = escapePath(
@@ -274,11 +273,32 @@
    console.log("Backing up your content")

    if (argv.commit) {
      const contentStat = await fs.promises.lstat(contentFolder)
      if (contentStat.isSymbolicLink()) {
        console.log(chalk.yellow("Detected symlink, trying to dereference before committing"))

        // stash symlink file
        await stashContentFolder(contentFolder)

        // follow symlink and copy content
        const linkTarg = await fs.promises.readlink(contentFolder)
        await fs.promises.cp(linkTarg, contentFolder, {
          force: true,
          recursive: true,
          preserveTimestamps: true,
        })
      }

      const currentTimestamp = new Date().toLocaleString("en-US", {
        dateStyle: "medium",
        timeStyle: "short",
      })
      spawnSync("git", ["commit", "-am", `Quartz sync: ${currentTimestamp}`], { stdio: "inherit" })

      if (contentStat.isSymbolicLink()) {
        // put symlink back
        await popContentFolder()
      }
    }

    await stashContentFolder(contentFolder)