fix: revert parsing dates in frontmatter

This commit is contained in:
Jacky Zhao 2024-01-28 21:27:16 -08:00
parent bf5a556cc1
commit 85f05ea99b
2 changed files with 29 additions and 49 deletions

View file

@ -5,7 +5,6 @@ import yaml from "js-yaml"
import toml from "toml" import toml from "toml"
import { slugTag } from "../../util/path" import { slugTag } from "../../util/path"
import { QuartzPluginData } from "../vfile" import { QuartzPluginData } from "../vfile"
import chalk from "chalk"
export interface Options { export interface Options {
delims: string | string[] delims: string | string[]
@ -17,23 +16,6 @@ const defaultOptions: Options = {
language: "yaml", language: "yaml",
} }
function coerceDate(fp: string, d: unknown): Date | undefined {
if (d === undefined || d === null) return undefined
const dt = new Date(d as string | number)
const invalidDate = isNaN(dt.getTime()) || dt.getTime() === 0
if (invalidDate) {
console.log(
chalk.yellow(
`\nWarning: found invalid date "${d}" in \`${fp}\`. Supported formats: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date#date_time_string_format`,
),
)
return undefined
}
return dt
}
function coalesceAliases(data: { [key: string]: any }, aliases: string[]) { function coalesceAliases(data: { [key: string]: any }, aliases: string[]) {
for (const alias of aliases) { for (const alias of aliases) {
if (data[alias] !== undefined && data[alias] !== null) return data[alias] if (data[alias] !== undefined && data[alias] !== null) return data[alias]
@ -66,7 +48,6 @@ export const FrontMatter: QuartzTransformerPlugin<Partial<Options> | undefined>
[remarkFrontmatter, ["yaml", "toml"]], [remarkFrontmatter, ["yaml", "toml"]],
() => { () => {
return (_, file) => { return (_, file) => {
const fp = file.data.filePath!
const { data } = matter(Buffer.from(file.value), { const { data } = matter(Buffer.from(file.value), {
...opts, ...opts,
engines: { engines: {
@ -88,16 +69,6 @@ export const FrontMatter: QuartzTransformerPlugin<Partial<Options> | undefined>
if (aliases) data.aliases = aliases if (aliases) data.aliases = aliases
const cssclasses = coerceToArray(coalesceAliases(data, ["cssclasses", "cssclass"])) const cssclasses = coerceToArray(coalesceAliases(data, ["cssclasses", "cssclass"]))
if (cssclasses) data.cssclasses = cssclasses if (cssclasses) data.cssclasses = cssclasses
const created = coerceDate(fp, coalesceAliases(data, ["created", "date"]))
if (created) data.created = created
const modified = coerceDate(
fp,
coalesceAliases(data, ["modified", "lastmod", "updated", "last-modified"]),
)
if (modified) data.modified = modified
const published = coerceDate(fp, coalesceAliases(data, ["published", "publishDate"]))
if (published) data.published = published
// fill in frontmatter // fill in frontmatter
file.data.frontmatter = data as QuartzPluginData["frontmatter"] file.data.frontmatter = data as QuartzPluginData["frontmatter"]
@ -120,9 +91,6 @@ declare module "vfile" {
draft: boolean draft: boolean
enableToc: string enableToc: string
cssclasses: string[] cssclasses: string[]
created: Date
modified: Date
published: Date
}> }>
} }
} }

View file

@ -12,6 +12,21 @@ const defaultOptions: Options = {
priority: ["frontmatter", "git", "filesystem"], priority: ["frontmatter", "git", "filesystem"],
} }
function coerceDate(fp: string, d: any): Date {
const dt = new Date(d)
const invalidDate = isNaN(dt.getTime()) || dt.getTime() === 0
if (invalidDate && d !== undefined) {
console.log(
chalk.yellow(
`\nWarning: found invalid date "${d}" in \`${fp}\`. Supported formats: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date#date_time_string_format`,
),
)
}
return invalidDate ? new Date() : dt
}
type MaybeDate = undefined | string | number
export const CreatedModifiedDate: QuartzTransformerPlugin<Partial<Options> | undefined> = ( export const CreatedModifiedDate: QuartzTransformerPlugin<Partial<Options> | undefined> = (
userOpts, userOpts,
) => { ) => {
@ -23,21 +38,23 @@ export const CreatedModifiedDate: QuartzTransformerPlugin<Partial<Options> | und
() => { () => {
let repo: Repository | undefined = undefined let repo: Repository | undefined = undefined
return async (_tree, file) => { return async (_tree, file) => {
let created: Date | undefined = undefined let created: MaybeDate = undefined
let modified: Date | undefined = undefined let modified: MaybeDate = undefined
let published: Date | undefined = undefined let published: MaybeDate = undefined
const fp = file.data.filePath! const fp = file.data.filePath!
const fullFp = path.posix.join(file.cwd, fp) const fullFp = path.posix.join(file.cwd, fp)
for (const source of opts.priority) { for (const source of opts.priority) {
if (source === "filesystem") { if (source === "filesystem") {
const st = await fs.promises.stat(fullFp) const st = await fs.promises.stat(fullFp)
created ||= new Date(st.birthtimeMs) created ||= st.birthtimeMs
modified ||= new Date(st.mtimeMs) modified ||= st.mtimeMs
} else if (source === "frontmatter" && file.data.frontmatter) { } else if (source === "frontmatter" && file.data.frontmatter) {
created ||= file.data.frontmatter.created created ||= file.data.frontmatter.date as MaybeDate
modified ||= file.data.frontmatter.modified modified ||= file.data.frontmatter.lastmod as MaybeDate
published ||= file.data.frontmatter.published modified ||= file.data.frontmatter.updated as MaybeDate
modified ||= file.data.frontmatter["last-modified"] as MaybeDate
published ||= file.data.frontmatter.publishDate as MaybeDate
} else if (source === "git") { } else if (source === "git") {
if (!repo) { if (!repo) {
// Get a reference to the main git repo. // Get a reference to the main git repo.
@ -47,9 +64,7 @@ export const CreatedModifiedDate: QuartzTransformerPlugin<Partial<Options> | und
} }
try { try {
modified ||= new Date( modified ||= await repo.getFileLatestModifiedDateAsync(file.data.filePath!)
await repo.getFileLatestModifiedDateAsync(file.data.filePath!),
)
} catch { } catch {
console.log( console.log(
chalk.yellow( chalk.yellow(
@ -61,13 +76,10 @@ export const CreatedModifiedDate: QuartzTransformerPlugin<Partial<Options> | und
} }
} }
created ||= new Date()
modified ||= new Date()
published ||= new Date()
file.data.dates = { file.data.dates = {
created, created: coerceDate(fp, created),
modified, modified: coerceDate(fp, modified),
published, published: coerceDate(fp, published),
} }
} }
}, },