From b7966ff7fa2829ac9d128f1d560a2b98149514ac Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Fri, 21 Jul 2023 04:51:55 +0000
Subject: [PATCH] update features list
---
quartz/bootstrap-cli.mjs | 166 ++++++++++++++++++++++++++++++++++++++++++++-----------
1 files changed, 133 insertions(+), 33 deletions(-)
diff --git a/quartz/bootstrap-cli.mjs b/quartz/bootstrap-cli.mjs
index bb83fe0..411a70e 100755
--- a/quartz/bootstrap-cli.mjs
+++ b/quartz/bootstrap-cli.mjs
@@ -10,12 +10,59 @@
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 = {
+const CommonArgv = {
+ directory: {
+ string: true,
+ alias: ['d'],
+ default: 'content',
+ describe: 'directory to look for content files'
+ },
+ verbose: {
+ boolean: true,
+ alias: ['v'],
+ default: false,
+ describe: 'print out extra logging information'
+ }
+}
+
+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'],
@@ -32,20 +79,9 @@
default: 8080,
describe: 'port to serve Quartz on'
},
- directory: {
- string: true,
- alias: ['d'],
- default: 'content',
- describe: 'directory to look for content files'
- },
- verbose: {
- boolean: true,
- alias: ['v'],
- default: false,
- describe: 'print out extra logging information'
- }
}
+
function escapePath(fp) {
return fp
.replace(/\\ /g, " ") // unescape spaces
@@ -54,15 +90,35 @@
.trim()
}
+function exitIfCancel(val) {
+
+ if (isCancel(val)) {
+ outro(chalk.red("Exiting"))
+ process.exit(0)
+ } else {
+ return val
+ }
+}
+
+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 contentFolder = path.join(process.cwd(), "content")
- const setupStrategy = await select({
+ const contentFolder = path.join(cwd, argv.directory)
+ const setupStrategy = exitIfCancel(await select({
message: `Choose how to initialize the content in \`${contentFolder}\``,
options: [
{ value: 'new', label: "Empty Quartz" },
@@ -70,12 +126,7 @@
{ 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" },
]
- })
-
- if (isCancel(setupStrategy)) {
- outro(chalk.red("Exiting"))
- process.exit(0)
- }
+ }))
async function rmContentFolder() {
const contentStat = await fs.promises.lstat(contentFolder)
@@ -89,7 +140,7 @@
}
if (setupStrategy === 'copy' || setupStrategy === 'symlink') {
- const originalFolder = escapePath(await text({
+ 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) {
@@ -100,12 +151,7 @@
return "The given path is not a folder"
}
}
- }))
-
- if (isCancel(originalFolder)) {
- outro(chalk.red("Exiting"))
- process.exit(0)
- }
+ })))
await rmContentFolder()
if (setupStrategy === 'copy') {
@@ -126,6 +172,22 @@
`
)
}
+
+ // 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")
+ 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\`
@@ -133,7 +195,45 @@
• Hosting your Quartz online (see: https://quartz.jzhao.xyz/setup/hosting)
`)
})
- .command('build', 'Build Quartz into a bundle of static HTML files', BuildArgv, async (argv) => {
+ .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('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 => {
const result = await esbuild.build({
entryPoints: [fp],
outfile: path.join("quartz", cacheFile),
@@ -192,11 +292,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()
--
Gitblit v1.10.0