docs: improve first-time git setup

Jacky Zhao

2024-01-28 bf5a556cc15edd311cf5cb7faab2509569e6af0a

 quartz/plugins/transformers/lastmod.ts

@@ -2,6 +2,7 @@
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")[]
@@ -11,7 +12,6 @@
  priority: ["frontmatter", "git", "filesystem"],
}

type MaybeDate = undefined | string | number
export const CreatedModifiedDate: QuartzTransformerPlugin<Partial<Options> | undefined> = (
  userOpts,
) => {
@@ -23,35 +23,51 @@
        () => {
          let repo: Repository | undefined = undefined
          return async (_tree, file) => {
            let created: MaybeDate = undefined
            let modified: MaybeDate = undefined
            let published: MaybeDate = undefined
            let created: Date | undefined = undefined
            let modified: Date | undefined = undefined
            let published: Date | undefined = undefined

            const fp = path.posix.join(file.cwd, file.data.filePath as string)
            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(fp)
                created ||= st.birthtimeMs
                modified ||= st.mtimeMs
                const st = await fs.promises.stat(fullFp)
                created ||= new Date(st.birthtimeMs)
                modified ||= new Date(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
                created ||= file.data.frontmatter.created
                modified ||= file.data.frontmatter.modified
                published ||= file.data.frontmatter.published
              } 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(file.cwd)
                }

                modified ||= await repo.getFileLatestModifiedDateAsync(file.data.filePath!)
                try {
                  modified ||= new Date(
                    await repo.getFileLatestModifiedDateAsync(file.data.filePath!),
                  )
                } catch {
                  console.log(
                    chalk.yellow(
                      `\nWarning: ${file.data
                        .filePath!} isn't yet tracked by git, last modification date is not available for this file`,
                    ),
                  )
                }
              }
            }

            created ||= new Date()
            modified ||= new Date()
            published ||= new Date()
            file.data.dates = {
              created: created ? new Date(created) : new Date(),
              modified: modified ? new Date(modified) : new Date(),
              published: published ? new Date(published) : new Date(),
              created,
              modified,
              published,
            }
          }
        },