如何使用 Git Hooks 设置创建日期和修改日期

在这篇文章中，我将解释如何使用 pre-commit Git hook 来自动化在 AstroPaper 博客主题 frontmatter 中输入创建日期（pubDatetime）和修改日期（modDatetime）。

让它们无处不在

Git hooks 非常适合自动化任务，比如将分支名称添加到提交信息或检查分支名称，或者阻止你提交明文密码。它们最大的缺点是客户端 hooks 是每台机器独立的。

你可以通过创建一个 hooks 目录并手动将它们复制到 .git/hooks 目录或设置符号链接来解决这个问题，但这都需要你记得去设置它，而这是我并不擅长的事情。

由于这个项目使用 npm，我们可以利用一个名为 Husky 的包（它已经在 AstroPaper 中安装了）来自动安装 hooks。

更新！在 AstroPaper v4.3.0 中，pre-commit hook 已被移除，改为使用 GitHub Actions。不过，你可以自己轻松地安装 Husky。

Hook 脚本

由于我们希望这个 hook 在我们提交代码时运行以更新日期，然后将其作为我们更改的一部分，我们将使用 pre-commit hook。这已经由这个 AstroPaper 项目设置好了，但如果没有的话，你可以运行 npx husky add .husky/pre-commit 'echo "This is our new pre-commit hook"'。

导航到 hooks/pre-commit 文件，我们将添加以下一个或两个代码片段。

当文件被编辑时更新修改日期

更新：

本节已更新为一个更智能的新版本 hook。现在它不会增加 modDatetime，直到文章被发布。在首次发布时，将 draft 状态设置为 first，然后见证奇迹发生。

# Modified files, update the modDatetime
git diff --cached --name-status |
grep -i '^M.*\.md$' |
while read _ file; do
  filecontent=$(cat "$file")
  frontmatter=$(echo "$filecontent" | awk -v RS='---' 'NR==2{print}')
  draft=$(echo "$frontmatter" | awk '/^draft: /{print $2}')
  if [ "$draft" = "false" ]; then
    echo "$file modDateTime updated"
    cat $file | sed "/---.*/,/---.*/s/^modDatetime:.*$/modDatetime: $(date -u "+%Y-%m-%dT%H:%M:%SZ")/" > tmp
    mv tmp $file
    git add $file
  fi
  if [ "$draft" = "first" ]; then
    echo "First release of $file, draft set to false and modDateTime removed"
    cat $file | sed "/---.*/,/---.*/s/^modDatetime:.*$/modDatetime:/" | sed "/---.*/,/---.*/s/^draft:.*$/draft: false/" > tmp
    mv tmp $file
    git add $file
  fi
done

git diff --cached --name-status 获取已经暂存准备提交的 git 文件。输出看起来像这样：

A       src/content/blog/setting-dates-via-git-hooks.md

开头的字母表示已执行的操作，在上面的例子中，文件已被添加。已修改的文件显示为 M。

我们将该输出通过管道传递给 grep 命令，在那里我们会检查每一行以找出被修改的文件。该行需要以 M（^(M)）开头，后面可以有任意数量的字符（.*），并以 .md 文件扩展名（.(md)$）结尾。这将过滤掉不是已修改 markdown 文件的行 egrep -i "^(M).*\.(md)$"。

改进 - 更明确

可以添加此项仅查找 blog 目录中的 markdown 文件，因为只有这些文件才会有正确的 frontmatter。

正则表达式将捕获两个部分：字母和文件路径。我们将这个列表通过管道传入一个 while 循环，以遍历匹配的行，并将字母分配给 a，路径分配给 b。我们暂时忽略 a。

要了解文件的 draft 状态，我们需要其 frontmatter。在以下代码中，我们使用 cat 获取文件内容，然后使用 awk 按 frontmatter 分隔符（---）分割文件，并获取第二个块（frontmatter，即 --- 之间的部分）。从这里我们再次使用 awk 来查找 draft 键并打印其值。

  filecontent=$(cat "$file")
  frontmatter=$(echo "$filecontent" | awk -v RS='---' 'NR==2{print}')
  draft=$(echo "$frontmatter" | awk '/^draft: /{print $2}')

现在我们有了 draft 的值，我们将做三件事之一：将 modDatetime 设置为当前时间（当 draft 为 false 时 if [ "$draft" = "false" ]; then），清除 modDatetime 并将 draft 设置为 false（当 draft 设置为 first 时 if [ "$draft" = "first" ]; then），或者什么都不做（在任何其他情况下）。

接下来的 sed 命令部分对我来说有些神奇，因为我不常用它，它是从另一篇类似操作的博客文章复制过来的。本质上，它在文件的 frontmatter 标签（---）内查找 pubDatetime: 键，获取完整行并将其替换为 pubDatetime: $(date -u "+%Y-%m-%dT%H:%M:%SZ")/" 相同的键和正确格式的当前日期时间。

这个替换是在整个文件的上下文中进行的，所以我们把它放入一个临时文件（> tmp），然后我们将新文件移动（mv）到旧文件的位置，覆盖它。然后将其添加到 git 中，就像我们自己做的更改一样，准备提交。

注意

要使 sed 生效，frontmatter 中需要已经有 modDatetime 键。你还需要做一些其他的更改，以便应用程序能够在日期为空的情况下构建，请参见下方。

为新文件添加日期

为新文件添加日期的过程与上述相同，但这次我们查找的是已添加的行（A），并且我们要替换 pubDatetime 的值。

# New files, add/update the pubDatetime
git diff --cached --name-status | egrep -i "^(A).*\.(md)$" | while read a b; do
  cat $b | sed "/---.*/,/---.*/s/^pubDatetime:.*$/pubDatetime: $(date -u "+%Y-%m-%dT%H:%M:%SZ")/" > tmp
  mv tmp $b
  git add $b
done

改进 - 只循环一次

我们可以使用 a 变量在循环内切换，在一个循环中要么更新 modDatetime，要么添加 pubDatetime。

填充 frontmatter

如果你的 IDE 支持代码片段，那么可以选择创建一个自定义代码片段来填充 frontmatter。AstroPaper v4 将默认附带一个用于 VSCode 的代码片段。

空的 `modDatetime` 更改

为了允许 Astro 编译 markdown 并完成其工作，它需要知道 frontmatter 中期望的内容。它通过 src/content/config.ts 中的配置来实现这一点。

为了允许键存在但值为空，我们需要编辑第 10 行以添加 .nullable() 函数。

const blog = defineCollection({
  type: "content",
  schema: ({ image }) =>
    z.object({
      author: z.string().default(SITE.author),
      pubDatetime: z.date(),
      modDatetime: z.date().optional(),
      modDatetime: z.date().optional().nullable(),
      title: z.string(),
      featured: z.boolean().optional(),
      draft: z.boolean().optional(),
      tags: z.array(z.string()).default(["others"]),
      ogImage: image().or(z.string()).optional(),
      description: z.string(),
      canonicalURL: z.string().optional(),
      readingTime: z.string().optional(),
    }),
});

为了阻止 IDE 在博客引擎文件中报错，我还做了以下操作：

在 src/layouts/Layout.astro 的第 15 行添加了 | null，使其看起来像：

export interface Props {
  title?: string;
  author?: string;
  description?: string;
  ogImage?: string;
  canonicalURL?: string;
  pubDatetime?: Date;
  modDatetime?: Date | null;
}

在 src/components/Datetime.tsx 的第 5 行添加了 | null，使其看起来像：

interface DatetimesProps {
  pubDatetime: string | Date;
  modDatetime: string | Date | undefined | null;
}