quartz-research-note/quartz/bootstrap-cli.mjs

229 lines
7.5 KiB
JavaScript
Raw Normal View History

2023-05-29 00:44:08 +00:00
#!/usr/bin/env node
2023-06-03 19:07:19 +00:00
import { promises, readFileSync } from 'fs'
2023-05-30 15:02:20 +00:00
import yargs from 'yargs'
2023-06-03 19:07:19 +00:00
import path from 'path'
2023-05-30 15:02:20 +00:00
import { hideBin } from 'yargs/helpers'
import esbuild from 'esbuild'
import chalk from 'chalk'
2023-06-01 21:35:31 +00:00
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'
2023-05-30 15:02:20 +00:00
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())
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'
},
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'
}
}
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-05-30 15:02:20 +00:00
yargs(hideBin(process.argv))
.scriptName("quartz")
.version(version)
.usage('$0 <cmd> [args]')
.command('create', 'Initialize Quartz', async (_argv) => {
console.log()
intro(chalk.bgGreen.black(` Quartz v${version} `))
const cwd = process.cwd()
const contentFolder = path.join(cwd, "content")
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" },
]
}))
// 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() {
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)
}
}
}
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) {
2023-07-06 23:56:30 +00:00
const fullPath = escapePath(fp)
if (!fs.existsSync(fullPath)) {
return "The given path doesn't exist"
2023-07-06 23:56:30 +00:00
} else if (!fs.lstatSync(fullPath).isDirectory()) {
return "The given path is not a folder"
}
}
})))
await rmContentFolder()
if (setupStrategy === 'copy') {
2023-07-06 23:56:30 +00:00
await fs.promises.cp(originalFolder, contentFolder, { recursive: true })
} else if (setupStrategy === 'symlink') {
2023-07-06 23:56:30 +00:00
await fs.promises.symlink(originalFolder, contentFolder, 'dir')
}
} else if (setupStrategy === 'new') {
await rmContentFolder()
2023-07-06 23:56:30 +00:00
await fs.promises.mkdir(contentFolder)
await fs.promises.writeFile(path.join(contentFolder, "index.md"),
`---
title: Welcome to Quartz
---
This is a blank Quartz installation.
See the [documentation](https://quartz.jzhao.xyz) for how to get started.
`
)
}
// 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\`
Running \`npx quartz build --serve\` to preview your Quartz locally
Hosting your Quartz online (see: https://quartz.jzhao.xyz/setup/hosting)
`)
})
.command('update', 'Get the latest Quartz updates', () => {
// TODO
})
.command('push', 'Push your Quartz updates to GitHub', () => {
// TODO
})
2023-05-30 15:02:20 +00:00
.command('build', 'Build Quartz into a bundle of static HTML files', BuildArgv, async (argv) => {
const result = await esbuild.build({
2023-05-30 15:02:20 +00:00
entryPoints: [fp],
2023-06-04 16:35:45 +00:00
outfile: path.join("quartz", cacheFile),
2023-05-30 15:02:20 +00:00
bundle: true,
keepNames: true,
platform: "node",
2023-06-04 16:35:45 +00:00
format: "esm",
2023-05-30 15:02:20 +00:00
jsx: "automatic",
jsxImportSource: "preact",
2023-06-04 16:35:45 +00:00
packages: "external",
metafile: true,
sourcemap: true,
2023-06-03 19:07:19 +00:00
plugins: [
sassPlugin({
2023-07-02 20:08:29 +00:00
type: 'css-text',
2023-06-03 19:07:19 +00:00
}),
{
name: 'inline-script-loader',
setup(build) {
build.onLoad({ filter: /\.inline\.(ts|js)$/ }, async (args) => {
let text = await promises.readFile(args.path, 'utf8')
2023-06-10 02:58:58 +00:00
// remove default exports that we manually inserted
text = text.replace('export default', '')
text = text.replace('export', '')
2023-06-20 03:37:45 +00:00
const sourcefile = path.relative(path.resolve('.'), args.path)
const resolveDir = path.dirname(sourcefile)
2023-06-03 19:07:19 +00:00
const transpiled = await esbuild.build({
stdin: {
contents: text,
2023-06-07 02:48:37 +00:00
loader: 'ts',
2023-06-20 03:37:45 +00:00
resolveDir,
sourcefile,
2023-06-03 19:07:19 +00:00
},
write: false,
bundle: true,
platform: "browser",
format: "esm",
})
const rawMod = transpiled.outputFiles[0].text
return {
contents: rawMod,
loader: 'text',
}
})
}
}
]
2023-05-30 15:02:20 +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)
})
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)})`))
}
2023-06-04 16:35:45 +00:00
const { default: init } = await import(cacheFile)
2023-05-30 15:02:20 +00:00
init(argv, version)
})
.showHelpOnFail(false)
.help()
.strict()
.demandCommand()
.argv