Jacky Zhao
2025-03-16 a7372079817fb1a1e69b2632405d759f9c5e913d
quartz/plugins/transformers/lastmod.ts
@@ -1,65 +1,90 @@
import fs from "fs"
import path from 'path'
import path from "path"
import { Repository } from "@napi-rs/simple-git"
import { QuartzTransformerPlugin } from "../types"
import chalk from "chalk"
export interface Options {
  priority: ('frontmatter' | 'git' | 'filesystem')[],
  priority: ("frontmatter" | "git" | "filesystem")[]
}
const defaultOptions: Options = {
  priority: ['frontmatter', 'git', 'filesystem']
  priority: ["frontmatter", "git", "filesystem"],
}
export const CreatedModifiedDate: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
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>> = (userOpts) => {
  const opts = { ...defaultOptions, ...userOpts }
  return {
    name: "CreatedModifiedDate",
    markdownPlugins() {
    markdownPlugins(ctx) {
      return [
        () => {
          let repo: Repository | undefined = undefined
          return async (_tree, file) => {
            let created: undefined | Date = undefined
            let modified: undefined | Date = undefined
            let published: undefined | Date = undefined
            let created: MaybeDate = undefined
            let modified: MaybeDate = undefined
            let published: MaybeDate = undefined
            const fp = path.join(file.cwd, file.data.filePath as string)
            const fp = file.data.relativePath!
            const fullFp = path.posix.join(ctx.argv.directory, fp)
            for (const source of opts.priority) {
              if (source === "filesystem") {
                const st = await fs.promises.stat(fp)
                created ||= new Date(st.birthtimeMs)
                modified ||= new Date(st.mtimeMs)
                const st = await fs.promises.stat(fullFp)
                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["last-modified"]
                published ||= file.data.frontmatter.publishDate
                created ||= file.data.frontmatter.created as MaybeDate
                modified ||= file.data.frontmatter.modified as MaybeDate
                published ||= file.data.frontmatter.published as MaybeDate
              } else if (source === "git") {
                if (!repo) {
                  repo = new Repository(file.cwd)
                  // Get a reference to the main git repo.
                  // It's either the same as the workdir,
                  // or 1+ level higher in case of a submodule/subtree setup
                  repo = Repository.discover(ctx.argv.directory)
                }
                modified ||= new Date(await repo.getFileLatestModifiedDateAsync(file.data.filePath!))
                try {
                  modified ||= await repo.getFileLatestModifiedDateAsync(fullFp)
                } catch {
                  console.log(
                    chalk.yellow(
                      `\nWarning: ${file.data
                        .filePath!} isn't yet tracked by git, last modification date is not available for this file`,
                    ),
                  )
                }
              }
            }
            file.data.dates = {
              created: created ?? new Date(),
              modified: modified ?? new Date(),
              published: published ?? new Date()
              created: coerceDate(fp, created),
              modified: coerceDate(fp, modified),
              published: coerceDate(fp, published),
            }
          }
        }
        },
      ]
    },
    htmlPlugins() {
      return []
    }
  }
}
declare module 'vfile' {
declare module "vfile" {
  interface DataMap {
    dates: {
      created: Date