quartz-research-note/quartz/plugins/transformers/lastmod.ts

88 lines
2.7 KiB
TypeScript
Raw Normal View History

2023-05-30 15:02:20 +00:00
import fs from "fs"
2023-07-23 00:27:41 +00:00
import path from "path"
2023-05-30 15:02:20 +00:00
import { Repository } from "@napi-rs/simple-git"
import { QuartzTransformerPlugin } from "../types"
import chalk from "chalk"
2023-05-30 15:02:20 +00:00
export interface Options {
2023-07-23 00:27:41 +00:00
priority: ("frontmatter" | "git" | "filesystem")[]
2023-05-30 15:02:20 +00:00
}
const defaultOptions: Options = {
2023-07-23 00:27:41 +00:00
priority: ["frontmatter", "git", "filesystem"],
2023-05-30 15:02:20 +00:00
}
function coerceDate(fp: string, d: any): Date {
const dt = new Date(d)
2023-09-24 21:47:30 +00:00
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
}
2023-07-07 01:45:38 +00:00
type MaybeDate = undefined | string | number
2023-07-23 00:27:41 +00:00
export const CreatedModifiedDate: QuartzTransformerPlugin<Partial<Options> | undefined> = (
userOpts,
) => {
const opts = { ...defaultOptions, ...userOpts }
return {
name: "CreatedModifiedDate",
markdownPlugins() {
return [
() => {
let repo: Repository | undefined = undefined
return async (_tree, file) => {
2023-07-07 01:45:38 +00:00
let created: MaybeDate = undefined
let modified: MaybeDate = undefined
let published: MaybeDate = undefined
2023-05-30 15:02:20 +00:00
const fp = file.data.filePath!
const fullFp = path.posix.join(file.cwd, fp)
for (const source of opts.priority) {
if (source === "filesystem") {
const st = await fs.promises.stat(fullFp)
2023-07-07 01:45:38 +00:00
created ||= st.birthtimeMs
modified ||= st.mtimeMs
} else if (source === "frontmatter" && file.data.frontmatter) {
created ||= file.data.frontmatter.date
modified ||= file.data.frontmatter.lastmod
modified ||= file.data.frontmatter.updated
modified ||= file.data.frontmatter["last-modified"]
published ||= file.data.frontmatter.publishDate
} else if (source === "git") {
if (!repo) {
repo = new Repository(file.cwd)
}
2023-05-30 15:02:20 +00:00
2023-07-07 01:45:38 +00:00
modified ||= await repo.getFileLatestModifiedDateAsync(file.data.filePath!)
2023-05-30 15:02:20 +00:00
}
}
file.data.dates = {
created: coerceDate(fp, created),
modified: coerceDate(fp, modified),
published: coerceDate(fp, published),
}
2023-05-30 15:02:20 +00:00
}
2023-07-23 00:27:41 +00:00
},
]
},
2023-05-30 15:02:20 +00:00
}
}
2023-07-23 00:27:41 +00:00
declare module "vfile" {
2023-05-30 15:02:20 +00:00
interface DataMap {
dates: {
created: Date
modified: Date
published: Date
}
}
}