详细介绍如何实现 pubDate 自动获取日期功能，以及如何只在文件修改时更新日期的完整解决方案
2025-09-01
作者：naiko
在博客或文档系统中，我们经常需要管理文章的发布日期和更新日期。手动维护这些日期不仅繁琐，还容易出错。理想情况下，我们希望实现以下功能：
pubDate本文将详细介绍如何在 Astro 项目中实现这一功能。
要实现 pubDate 的自动管理，我们需要考虑以下几个关键点：
区分创建时间和修改时间：
pubDate)：文件首次创建时的日期，后续不应自动改变updatedDate 或类似字段)：文件内容修改时自动更新的日期自动检测文件变化：
保持自动化与人工控制的平衡：
我们将采用 Git Hook + 脚本工具 的组合方案来实现这一功能，这是一个在业界广泛采用且成熟的解决方案。
Git Hook 是 Git 提供的一种机制，可以在特定的 Git 操作（如提交、推送等）前后执行自定义脚本。我们可以利用 pre-commit hook 在每次提交代码前检查文件是否被修改，并自动更新日期。
创建 pre-commit hook 脚本
在项目的 .git/hooks/ 目录下创建一个名为 pre-commit 的文件：
touch .git/hooks/pre-commit
chmod +x .git/hooks/pre-commit编写自动更新日期的脚本
在 pre-commit 文件中添加以下内容（根据你的操作系统和需求调整）：
#!/bin/sh
# 遍历所有暂存区中的 Markdown 文件
for file in $(git diff --cached --name-only --diff-filter=ACM | grep '\.md$'); do
# 检查文件中是否已包含 pubDate 字段
if grep -q '^pubDate:' "$file"; then
# 文件已存在 pubDate，检查文件内容是否有变化（不包括日期本身）
# 这里创建一个临时文件，移除 pubDate 行后比较内容
temp_file="${file}.temp"
grep -v '^pubDate:' "$file" > "$temp_file"
# 获取文件的上一个版本（如果存在）
if git rev-parse HEAD:"$file" > /dev/null 2>&1; then
temp_old="${file}.old.temp"
git show HEAD:"$file" | grep -v '^pubDate:' > "$temp_old"
# 比较内容是否有变化（不包括 pubDate）
if ! diff -q "$temp_file" "$temp_old" > /dev/null; then
# 内容有变化，更新 pubDate 为当前日期
sed -i "s/^pubDate:.*/pubDate: $(date +%Y-%m-%d)/" "$file"
git add "$file"
fi
rm -f "$temp_old"
fi
rm -f "$temp_file"
else
# 文件是新创建的，添加 pubDate 字段
# 找到合适的位置插入 pubDate（通常在 frontmatter 中）
if grep -q '^---' "$file"; then
# 在前两行之间插入 pubDate
sed -i "2i pubDate: $(date +%Y-%m-%d)" "$file"
git add "$file"
fi
fi
done注意：Windows 系统上的 sed 命令语法可能有所不同，需要相应调整。
这个脚本的工作原理可以用一个简单的流程图来表示：
检查暂存区中的 Markdown 文件
↓
文件是否包含 pubDate？
├── 是 → 检查内容是否有变化（排除 pubDate 行）
│ ├── 是 → 更新 pubDate 为当前日期
│ └── 否 → 保持原有 pubDate 不变
└── 否 → 为新文件添加 pubDate如果你的项目依赖于现代前端工具链，可以考虑使用专门的 Astro 插件或自定义构建脚本。
安装必要的依赖
npm install fs-extra chokidar --save-dev创建自定义构建脚本
在项目根目录创建一个 scripts/auto-date.js 文件：
const fs = require('fs-extra');
const path = require('path');
const chokidar = require('chokidar');
// 监听的文件路径
const watchPath = path.join(__dirname, '../src/pages/**/*.md');
// 上次修改时间记录
const lastModified = new Map();
// 监听文件变化
chokidar.watch(watchPath, {
ignoreInitial: true, // 忽略初始扫描
}).on('change', (filePath) => {
try {
console.log(`检测到文件变化: ${filePath}`);
// 读取文件内容
const content = fs.readFileSync(filePath, 'utf8');
const lines = content.split('\n');
// 检查是否包含 frontmatter
const frontmatterStart = lines.findIndex(line => line.trim() === '---');
const frontmatterEnd = frontmatterStart !== -1 ?
lines.findIndex((line, idx) => idx > frontmatterStart && line.trim() === '---') : -1;
if (frontmatterStart !== -1 && frontmatterEnd !== -1) {
let hasPubDate = false;
let modified = false;
// 检查并更新 frontmatter 中的 pubDate
for (let i = frontmatterStart + 1; i < frontmatterEnd; i++) {
const line = lines[i];
const trimmedLine = line.trim();
// 检查是否有 pubDate 字段
if (trimmedLine.startsWith('pubDate:')) {
hasPubDate = true;
// 获取文件的上次修改记录
const fileKey = filePath + '_content';
const currentContentWithoutDate = content.replace(/^pubDate:.*$/m, '').trim();
// 检查内容是否有实际变化（排除 pubDate 本身的变化）
if (lastModified.get(fileKey) !== currentContentWithoutDate) {
// 内容有变化，更新 pubDate 为当前日期
const today = new Date().toISOString().split('T')[0];
lines[i] = line.replace(/^pubDate:\s*(.*)$/, `pubDate: ${today}`);
modified = true;
// 更新记录
lastModified.set(fileKey, currentContentWithoutDate);
}
break;
}
}
// 如果没有 pubDate 字段，添加一个
if (!hasPubDate) {
const today = new Date().toISOString().split('T')[0];
lines.splice(frontmatterStart + 1, 0, `pubDate: ${today}`);
modified = true;
// 记录内容
const currentContentWithoutDate = content.replace(/^pubDate:.*$/m, '').trim();
lastModified.set(filePath + '_content', currentContentWithoutDate);
}
// 如果有修改，写回文件
if (modified) {
fs.writeFileSync(filePath, lines.join('\n'), 'utf8');
console.log(`已更新文件的 pubDate: ${filePath}`);
}
}
} catch (error) {
console.error(`处理文件时出错 ${filePath}:`, error);
}
});
console.log(`开始监听文件变化: ${watchPath}`);在 package.json 中添加脚本命令
"scripts": {
"watch:dates": "node scripts/auto-date.js",
"dev": "npm run watch:dates & astro dev"
}| 方案 | 优点 | 缺点 | 适用场景 |
|---|---|---|---|
| Git Hook | 1. 与版本控制系统紧密集成 2. 只在提交时执行，性能好 3. 不需要额外的运行时依赖 | 1. Windows 兼容性需要额外处理 2. 无法在开发预览时实时更新 | 适合以 Git 为主要工作流的团队 |
| 构建脚本 | 1. 跨平台兼容性更好 2. 可以实时监听文件变化 3. 更灵活的自定义逻辑 | 1. 需要额外的依赖 2. 会增加开发环境的资源消耗 | 适合需要实时预览和频繁修改的场景 |
如果你需要在 Windows 环境下使用 Git Hook，可以考虑使用 PowerShell 脚本：
#!/usr/bin/env pwsh
# 获取暂存区中的 Markdown 文件
$markdownFiles = git diff --cached --name-only --diff-filter=ACM | Where-Object { $_ -match '\.md$' }
foreach ($file in $markdownFiles) {
# 读取文件内容
$content = Get-Content -Path $file -Raw
# 检查文件中是否已包含 pubDate 字段
if ($content -match '^pubDate:') {
# 文件已存在 pubDate，创建临时内容（移除 pubDate 行）
$tempContent = $content -replace '^pubDate:.*\r?\n', ''
# 检查文件是否有上一个版本
try {
$oldContent = git show HEAD:"$file" -q 2>$null
if ($oldContent) {
# 移除旧版本中的 pubDate 行
$oldTempContent = $oldContent -replace '^pubDate:.*\r?\n', ''
# 比较内容是否有变化（不包括 pubDate）
if ($tempContent -ne $oldTempContent) {
# 内容有变化，更新 pubDate 为当前日期
$today = Get-Date -Format "yyyy-MM-dd"
$newContent = $content -replace '^pubDate:.*', "pubDate: $today"
Set-Content -Path $file -Value $newContent -NoNewline
git add $file
Write-Host "Updated pubDate in $file"
}
}
} catch {
# 文件是新添加的，不需要做任何操作
}
} else {
# 文件是新创建的，添加 pubDate 字段
if ($content -match '^---') {
# 在前两行之间插入 pubDate
$today = Get-Date -Format "yyyy-MM-dd"
$lines = $content -split '\r?\n'
$newLines = @()
$added = $false
foreach ($line in $lines) {
$newLines += $line
if ($line -eq '---' -and -not $added) {
$newLines += "pubDate: $today"
$added = $true
}
}
$newContent = $newLines -join "\n"
Set-Content -Path $file -Value $newContent -NoNewline
git add $file
Write-Host "Added pubDate to $file"
}
}
}备份重要文件： 在实施任何自动化脚本之前，确保你的代码已经备份，避免意外的数据丢失。
测试自动化流程： 在实际使用前，先在测试环境中验证自动化脚本的行为是否符合预期。
考虑添加更新日期字段：
除了 pubDate，你可能还想添加一个 updatedDate 字段来专门记录修改时间，这样可以同时保留原始发布日期和最后更新日期。
手动控制的保留： 考虑在脚本中添加条件，允许通过特定注释或标记来禁用自动更新日期的功能，以满足特殊需求。
团队协作沟通： 如果是团队项目，确保所有团队成员都了解并同意这个自动化流程，避免不必要的混乱。
Q: 为什么我的 Git Hook 不生效？
A: 确保 .git/hooks/pre-commit 文件具有执行权限。在 Unix/Linux 系统上，你可以使用 chmod +x .git/hooks/pre-commit 命令添加执行权限。在 Windows 上，需要确保文件扩展名正确，不应该有 .txt 等隐藏扩展名。
Q: 我可以同时保留创建日期和更新日期吗？
A: 当然可以。你可以在脚本中修改逻辑，为文件添加两个字段：pubDate（创建日期，只设置一次）和 updatedDate（更新日期，每次修改时更新）。
Q: 这个自动化方案会影响我的开发体验吗？ A: Git Hook 方案只在提交时执行，几乎不会影响开发体验。构建脚本方案会在后台运行，但通常资源消耗很小，对大多数项目来说影响可以忽略不计。
Q: 我使用的是其他静态站点生成器，这个方案还适用吗？ A: 是的，本文介绍的方案主要基于 Git 和文件系统操作，原则上适用于任何使用 Markdown 文件的静态站点生成器，包括 Jekyll、Hugo、Hexo 等。
实现 pubDate 自动获取日期且仅在文件修改时更新的功能，可以通过 Git Hook 或自定义构建脚本来实现。这两种方案各有优缺点，你可以根据项目需求和团队工作流选择最适合的方案。
无论选择哪种方案，自动化日期管理都能帮你节省手动维护日期的时间，减少错误，并确保你的内容日期信息始终保持准确。