hjerpbakk/jekyll-front-matter-analyser

Jekyll YAML前置内容验证器

镜像概述

该镜像针对Jekyll静态博客的文章YAML前置内容进行合规性验证，解决Jekyll对前置内容类型检查宽松导致的潜在问题，帮助用户快速定位错误（如缺失字段、无效路径、未来日期等），确保文章格式符合预期。

核心功能

验证以下类别规则：

• 分类（Categories）：检查分类是否包含指定值、分类为link时是否存在有效URL等。
• 日期（Date）：检查日期是否缺失、是否为未来日期、last_modified_at是否与最新文章一致等。
• 描述（Description）：检查meta_description是否缺失、包含TODO、长度是否在25-160字符之间等。
• 图片（Image）：检查图片字段是否缺失、路径是否存在等。
• 布局（Layout）：检查布局是否为指定值（如post）。
• 标签（Tags）：检查是否至少有一个标签、标签是否存在于指定子文件夹等。
• 标题（Title）：检查标题是否缺失、包含TODO等。

使用场景

1. 本地验证：通过Docker或dotnet-script在本地快速验证文章前置内容。
2. 持续集成：集成到CI pipeline（如CircleCI）中，自动验证文章格式合规性。

配置说明

白名单文件

在Jekyll根目录添加.frontmatterignore文件，每行填写需忽略的文件名，跳过对应文件的验证：

text
2014-1-16-os-x-script-for-fetching-app-store-icons.html
2018-06-29-beautiful-code-fira-code.md

忽略特定规则

在文章前置内容中添加ignore列表，指定需忽略的规则代码：

yaml
---
ignore:
- IM0001
- TA0001
---

部署示例

Docker运行

在Jekyll根目录执行：

bash
docker run --rm -it --volume="$PWD:/scripts:ro" docker.xuanyuan.run/hjerpbakk/jekyll-front-matter-analyser

CI集成（CircleCI）

配置.circleci/config.yml：

yaml
version: 2
jobs:
  build:
    machine: true
    steps:
      - checkout
      - run: chmod +x ./test.sh
      - run: ./test.sh

test.sh脚本：

bash
#!/usr/bin/env bash
set -e
docker pull docker.xuanyuan.run/hjerpbakk/jekyll-front-matter-analyser
docker run --rm -it --volume="$PWD:/scripts:ro" docker.xuanyuan.run/hjerpbakk/jekyll-front-matter-analyser