make path and globbing more platform invariant

This commit is contained in:
Jacky Zhao 2023-08-02 22:10:13 -07:00
parent f0a2eb86e4
commit f38ed1f1c6
7 changed files with 45 additions and 54 deletions

View File

@ -66,7 +66,7 @@ const config: QuartzConfig = {
enableSiteMap: true, enableSiteMap: true,
enableRSS: true, enableRSS: true,
}), }),
Plugin.Assets({ attachmentsFolder: "attachments" }), Plugin.Assets(),
Plugin.Static(), Plugin.Static(),
], ],
}, },

View File

@ -2,7 +2,7 @@ import "source-map-support/register.js"
import path from "path" import path from "path"
import { PerfTimer } from "./perf" import { PerfTimer } from "./perf"
import { rimraf } from "rimraf" import { rimraf } from "rimraf"
import { globby, isGitIgnored } from "globby" import { isGitIgnored } from "globby"
import chalk from "chalk" import chalk from "chalk"
import http from "http" import http from "http"
import serveHandler from "serve-handler" import serveHandler from "serve-handler"
@ -15,6 +15,7 @@ import chokidar from "chokidar"
import { ProcessedContent } from "./plugins/vfile" import { ProcessedContent } from "./plugins/vfile"
import WebSocket, { WebSocketServer } from "ws" import WebSocket, { WebSocketServer } from "ws"
import { Argv, BuildCtx } from "./ctx" import { Argv, BuildCtx } from "./ctx"
import { glob, toPosixPath } from "./glob"
async function buildQuartz(argv: Argv, version: string) { async function buildQuartz(argv: Argv, version: string) {
const ctx: BuildCtx = { const ctx: BuildCtx = {
@ -42,13 +43,7 @@ async function buildQuartz(argv: Argv, version: string) {
console.log(`Cleaned output directory \`${output}\` in ${perf.timeSince("clean")}`) console.log(`Cleaned output directory \`${output}\` in ${perf.timeSince("clean")}`)
perf.addEvent("glob") perf.addEvent("glob")
const fps = ( const fps = await glob("**/*.md", argv.directory, cfg.configuration.ignorePatterns)
await globby("**/*.md", {
cwd: argv.directory,
ignore: cfg.configuration.ignorePatterns,
gitignore: true,
})
).map((fp) => fp.split(path.sep).join(path.posix.sep))
console.log( console.log(
`Found ${fps.length} input files from \`${argv.directory}\` in ${perf.timeSince("glob")}`, `Found ${fps.length} input files from \`${argv.directory}\` in ${perf.timeSince("glob")}`,
) )
@ -83,7 +78,7 @@ async function startServing(ctx: BuildCtx, initialContent: ProcessedContent[]) {
let toRebuild: Set<FilePath> = new Set() let toRebuild: Set<FilePath> = new Set()
let toRemove: Set<FilePath> = new Set() let toRemove: Set<FilePath> = new Set()
async function rebuild(fp: string, action: "add" | "change" | "delete") { async function rebuild(fp: string, action: "add" | "change" | "delete") {
fp = fp.split(path.sep).join(path.posix.sep) fp = toPosixPath(fp)
if (!ignored(fp)) { if (!ignored(fp)) {
const filePath = joinSegments(argv.directory, fp) as FilePath const filePath = joinSegments(argv.directory, fp) as FilePath
if (action === "add" || action === "change") { if (action === "add" || action === "change") {

18
quartz/glob.ts Normal file
View File

@ -0,0 +1,18 @@
import path from "path";
import { FilePath } from "./path";
import { globby } from "globby";
export function toPosixPath(fp: string): string {
return fp.split(path.sep).join("/")
}
export async function glob(pattern: string, cwd: string, ignorePatterns: string[]): Promise<FilePath[]> {
const fps = (
await globby(pattern, {
cwd,
ignore: ignorePatterns,
gitignore: true,
})
).map(toPosixPath)
return fps as FilePath[]
}

View File

@ -1,55 +1,33 @@
import { globbyStream } from "globby" import { FilePath, joinSegments, slugifyFilePath } from "../../path"
import { FilePath, slugifyFilePath } from "../../path"
import { QuartzEmitterPlugin } from "../types" import { QuartzEmitterPlugin } from "../types"
import path from "path" import path from "path"
import fs from "fs" import fs from "fs"
import { glob } from "../../glob"
interface Options { export const Assets: QuartzEmitterPlugin = () => {
attachmentsFolder: string | null
}
const defaultOptions: Options = {
attachmentsFolder: null,
}
export const Assets: QuartzEmitterPlugin<Options> = (userOpts?: Options) => {
const { attachmentsFolder } = { ...defaultOptions, ...userOpts }
return { return {
name: "Assets", name: "Assets",
getQuartzComponents() { getQuartzComponents() {
return [] return []
}, },
async emit({ argv }, _content, _resources, _emit): Promise<FilePath[]> { async emit({ argv, cfg }, _content, _resources, _emit): Promise<FilePath[]> {
// glob all non MD/MDX/HTML files in content folder and copy it over // glob all non MD/MDX/HTML files in content folder and copy it over
const assetsPath = path.join(argv.output, "assets") const assetsPath = joinSegments(argv.output, "assets")
const fps = await glob("**", argv.directory, ["**/*.md", ...cfg.configuration.ignorePatterns])
const fps: FilePath[] = [] const res: FilePath[] = []
for await (const rawFp of globbyStream("**", { for (const fp of fps) {
ignore: ["**/*.md"],
cwd: argv.directory,
})) {
const fp = rawFp as FilePath
const ext = path.extname(fp) const ext = path.extname(fp)
const src = path.join(argv.directory, fp) as FilePath const src = joinSegments(argv.directory, fp) as FilePath
let name = (slugifyFilePath(fp as FilePath) + ext) as FilePath const name = (slugifyFilePath(fp as FilePath) + ext) as FilePath
if (attachmentsFolder) { const dest = joinSegments(assetsPath, name) as FilePath
const segments = name.split("/")
if (segments.at(-2) === attachmentsFolder) {
segments.splice(-2, 1)
name = segments.join("/") as FilePath
}
}
const dest = path.join(assetsPath, name) as FilePath
const dir = path.dirname(dest) as FilePath const dir = path.dirname(dest) as FilePath
await fs.promises.mkdir(dir, { recursive: true }) // ensure dir exists await fs.promises.mkdir(dir, { recursive: true }) // ensure dir exists
await fs.promises.copyFile(src, dest) await fs.promises.copyFile(src, dest)
fps.push(path.join("assets", fp) as FilePath) res.push(joinSegments("assets", fp) as FilePath)
} }
return fps return res
}, },
} }
} }

View File

@ -1,18 +1,18 @@
import { globby } from "globby" import { FilePath, QUARTZ, joinSegments } from "../../path"
import { FilePath, QUARTZ } from "../../path"
import { QuartzEmitterPlugin } from "../types" import { QuartzEmitterPlugin } from "../types"
import path from "path" import path from "path"
import fs from "fs" import fs from "fs"
import { glob } from "../../glob"
export const Static: QuartzEmitterPlugin = () => ({ export const Static: QuartzEmitterPlugin = () => ({
name: "Static", name: "Static",
getQuartzComponents() { getQuartzComponents() {
return [] return []
}, },
async emit({ argv }, _content, _resources, _emit): Promise<FilePath[]> { async emit({ argv, cfg }, _content, _resources, _emit): Promise<FilePath[]> {
const staticPath = path.join(QUARTZ, "static") const staticPath = path.join(QUARTZ, "static")
const fps = await globby("*", { cwd: staticPath }) const fps = await glob("**", staticPath, cfg.configuration.ignorePatterns)
await fs.promises.cp(staticPath, path.join(argv.output, "static"), { recursive: true }) await fs.promises.cp(staticPath, joinSegments(argv.output, "static"), { recursive: true })
return fps.map((fp) => path.join("static", fp)) as FilePath[] return fps.map((fp) => joinSegments("static", fp)) as FilePath[]
}, },
}) })

View File

@ -100,7 +100,7 @@ export const CrawlLinks: QuartzTransformerPlugin<Partial<Options> | undefined> =
if (!isAbsoluteUrl(node.properties.src)) { if (!isAbsoluteUrl(node.properties.src)) {
const ext = path.extname(node.properties.src) const ext = path.extname(node.properties.src)
node.properties.src = node.properties.src =
transformLink(path.join("assets", node.properties.src)) + ext transformLink(joinSegments("assets", node.properties.src)) + ext
} }
} }
}) })

View File

@ -4,7 +4,7 @@ import { PerfTimer } from "../perf"
import { getStaticResourcesFromPlugins } from "../plugins" import { getStaticResourcesFromPlugins } from "../plugins"
import { EmitCallback } from "../plugins/types" import { EmitCallback } from "../plugins/types"
import { ProcessedContent } from "../plugins/vfile" import { ProcessedContent } from "../plugins/vfile"
import { FilePath } from "../path" import { FilePath, joinSegments } from "../path"
import { QuartzLogger } from "../log" import { QuartzLogger } from "../log"
import { trace } from "../trace" import { trace } from "../trace"
import { BuildCtx } from "../ctx" import { BuildCtx } from "../ctx"
@ -16,7 +16,7 @@ export async function emitContent(ctx: BuildCtx, content: ProcessedContent[]) {
log.start(`Emitting output files`) log.start(`Emitting output files`)
const emit: EmitCallback = async ({ slug, ext, content }) => { const emit: EmitCallback = async ({ slug, ext, content }) => {
const pathToPage = path.join(argv.output, slug + ext) as FilePath const pathToPage = joinSegments(argv.output, slug + ext) as FilePath
const dir = path.dirname(pathToPage) const dir = path.dirname(pathToPage)
await fs.promises.mkdir(dir, { recursive: true }) await fs.promises.mkdir(dir, { recursive: true })
await fs.promises.writeFile(pathToPage, content) await fs.promises.writeFile(pathToPage, content)