update spinners

This commit is contained in:
Jacky Zhao 2023-06-04 13:37:43 -04:00
parent 9ad89997a5
commit 1406ee0f05
7 changed files with 128 additions and 102 deletions

View file

@ -24,10 +24,10 @@ export default async function buildQuartz(argv: Argv, version: string) {
const perf = new PerfTimer()
const output = argv.output
const pluginCount = Object.values(cfg.plugins).flat().length
const pluginNames = (key: 'transformers' | 'filters' | 'emitters') => cfg.plugins[key].map(plugin => plugin.name)
console.log(`Loaded ${pluginCount} plugins`)
if (argv.verbose) {
const pluginCount = Object.values(cfg.plugins).flat().length
const pluginNames = (key: 'transformers' | 'filters' | 'emitters') => cfg.plugins[key].map(plugin => plugin.name)
console.log(`Loaded ${pluginCount} plugins`)
console.log(` Transformers: ${pluginNames('transformers').join(", ")}`)
console.log(` Filters: ${pluginNames('filters').join(", ")}`)
console.log(` Emitters: ${pluginNames('emitters').join(", ")}`)
@ -37,9 +37,7 @@ export default async function buildQuartz(argv: Argv, version: string) {
if (argv.clean) {
perf.addEvent('clean')
await rimraf(output)
if (argv.verbose) {
console.log(`Cleaned output directory \`${output}\` in ${perf.timeSince('clean')}`)
}
console.log(`Cleaned output directory \`${output}\` in ${perf.timeSince('clean')}`)
}
// glob
@ -49,11 +47,7 @@ export default async function buildQuartz(argv: Argv, version: string) {
ignore: cfg.configuration.ignorePatterns,
gitignore: true,
})
if (argv.verbose) {
console.log(`Found ${fps.length} input files in ${perf.timeSince('glob')}`)
}
console.log(`Found ${fps.length} input files in ${perf.timeSince('glob')}`)
const filePaths = fps.map(fp => `${argv.directory}${path.sep}${fp}`)
const parsedFiles = await parseMarkdown(cfg.plugins.transformers, argv.directory, filePaths, argv.verbose)

26
quartz/log.ts Normal file
View file

@ -0,0 +1,26 @@
import { Spinner } from 'cli-spinner'
export class QuartzLogger {
verbose: boolean
spinner: Spinner | undefined
constructor(verbose: boolean) {
this.verbose = verbose
}
start(text: string) {
if (this.verbose) {
console.log(text)
} else {
this.spinner = new Spinner(`%s ${text}`)
this.spinner.setSpinnerString(18)
this.spinner.start()
}
}
success(text: string) {
if (!this.verbose) {
this.spinner!.stop(true)
}
console.log(text)
}
}

View file

@ -7,6 +7,7 @@ import { EmitCallback } from "../plugins/types"
import { ProcessedContent } from "../plugins/vfile"
import { QUARTZ, slugify } from "../path"
import { globbyStream } from "globby"
import chalk from "chalk"
export async function emitContent(contentFolder: string, output: string, cfg: QuartzConfig, content: ProcessedContent[], verbose: boolean) {
const perf = new PerfTimer()
@ -23,13 +24,18 @@ export async function emitContent(contentFolder: string, output: string, cfg: Qu
let emittedFiles = 0
for (const emitter of cfg.plugins.emitters) {
const emitted = await emitter.emit(cfg.configuration, content, staticResources, emit)
emittedFiles += emitted.length
try {
const emitted = await emitter.emit(cfg.configuration, content, staticResources, emit)
emittedFiles += emitted.length
if (verbose) {
for (const file of emitted) {
console.log(`[emit:${emitter.name}] ${file}`)
if (verbose) {
for (const file of emitted) {
console.log(`[emit:${emitter.name}] ${file}`)
}
}
} catch (err) {
console.log(chalk.red(`Failed to emit from plugin \`${emitter.name}\`: `) + err)
process.exit(1)
}
}

View file

@ -12,9 +12,11 @@ import path from 'path'
import os from 'os'
import workerpool, { Promise as WorkerPromise } from 'workerpool'
import { QuartzTransformerPlugin } from '../plugins/types'
import { QuartzLogger } from '../log'
import chalk from 'chalk'
export type QuartzProcessor = Processor<MDRoot, HTMLRoot, void>
export function createProcessor(transformers: QuartzTransformerPlugin[]): any {
export function createProcessor(transformers: QuartzTransformerPlugin[]): QuartzProcessor {
// base Markdown -> MD AST
let processor = unified().use(remarkParse)
@ -41,15 +43,11 @@ function* chunks<T>(arr: T[], n: number) {
}
}
async function transpileWorkerScript(verbose: boolean) {
async function transpileWorkerScript() {
// transpile worker script
const cacheFile = "./.quartz-cache/transpiled-worker.mjs"
const fp = "./quartz/worker.ts"
if (verbose) {
console.log("Transpiling worker script")
}
await esbuild.build({
return esbuild.build({
entryPoints: [fp],
outfile: path.join("quartz", cacheFile),
bundle: true,
@ -75,31 +73,50 @@ async function transpileWorkerScript(verbose: boolean) {
})
}
export function createFileParser(baseDir: string, fps: string[], verbose: boolean) {
return async (processor: QuartzProcessor) => {
const res: ProcessedContent[] = []
for (const fp of fps) {
try {
const file = await read(fp)
// base data properties that plugins may use
file.data.slug = slugify(path.relative(baseDir, file.path))
file.data.filePath = fp
const ast = processor.parse(file)
const newAst = await processor.run(ast, file)
res.push([newAst, file])
if (verbose) {
console.log(`[process] ${fp} -> ${file.data.slug}`)
}
} catch (err) {
console.log(chalk.red(`Failed to process \`${fp}\`: `) + err)
process.exit(1)
}
}
return res
}
}
export async function parseMarkdown(transformers: QuartzTransformerPlugin[], baseDir: string, fps: string[], verbose: boolean): Promise<ProcessedContent[]> {
const perf = new PerfTimer()
const log = new QuartzLogger(verbose)
const CHUNK_SIZE = 128
let concurrency = fps.length < CHUNK_SIZE ? 1 : os.availableParallelism()
const res: ProcessedContent[] = []
let res: ProcessedContent[] = []
log.start(`Parsing input files using ${concurrency} threads`)
if (concurrency === 1) {
// single-thread
const processor = createProcessor(transformers)
for (const fp of fps) {
const file = await read(fp)
// base data properties that plugins may use
file.data.slug = slugify(path.relative(baseDir, file.path))
file.data.filePath = fp
const ast = processor.parse(file)
res.push([await processor.run(ast, file), file])
if (verbose) {
console.log(`[process] ${fp} -> ${file.data.slug}`)
}
}
const parse = createFileParser(baseDir, fps, verbose)
res = await parse(processor)
} else {
await transpileWorkerScript(verbose)
await transpileWorkerScript()
const pool = workerpool.pool(
'./quartz/bootstrap-worker.mjs',
{
@ -113,11 +130,12 @@ export async function parseMarkdown(transformers: QuartzTransformerPlugin[], bas
for (const chunk of chunks(fps, CHUNK_SIZE)) {
childPromises.push(pool.exec('parseFiles', [baseDir, chunk, verbose]))
}
const results: ProcessedContent[][] = await WorkerPromise.all(childPromises)
res.push(...results.flat())
res = results.flat()
await pool.terminate()
}
console.log(`Parsed and transformed ${res.length} Markdown files with ${concurrency} cores in ${perf.timeSince()}`)
log.success(`Parsed ${res.length} Markdown files in ${perf.timeSince()}`)
return res
}

View file

@ -1,30 +1,11 @@
import { read } from "to-vfile"
import config from "../quartz.config"
import { createProcessor } from "./processors/parse"
import { slugify } from "./path"
import path from "path"
import { ProcessedContent } from "./plugins/vfile"
import { createFileParser, createProcessor } from "./processors/parse"
const transformers = config.plugins.transformers
const processor = createProcessor(transformers)
// only called from worker thread
export async function parseFiles(baseDir: string, fps: string[], verbose: boolean) {
const res: ProcessedContent[] = []
for (const fp of fps) {
const file = await read(fp)
// base data properties that plugins may use
file.data.slug = slugify(path.relative(baseDir, file.path))
file.data.filePath = fp
const ast = processor.parse(file)
res.push([await processor.run(ast, file), file])
if (verbose) {
console.log(`[process] ${fp} -> ${file.data.slug}`)
}
}
return res
const parse = createFileParser(baseDir, fps, verbose)
return parse(processor)
}