查找不正确的 YAML 标头

这是一种方法。我假设您有 bash（通过文件递归循环）、sed 和 awk。除了使用 bash，您还可以使用findwith-exec来搜索文件。

一般流程是：

1. *.md递归地向 bash 询问文件列表
2. 将每个文件传递sed给以提取 YAML 标头
3. 将该 YAML 标头传递给 awk 进行验证
4. 如果标头验证失败，则打印文件名

剧本：

#!/bin/bash
shopt -s globstar

for file in **/*.md
do
  # use sed for the header
  sed -n /^---$/,/^---$/p "$file" |
  awk '
        BEGIN {
                good_title=0
                good_lang=0
                good_extaut=0
        }
        /^title: .*/             { good_title=1  }
        /^language: [a-z][a-z]$/ { good_lang=1   }
        /^author: .*/            { good_extaut=1 }
        /^external: .*/          { good_extaut=1 }
        END {
                if (good_title && good_lang && good_extaut)
                        exit 0
                else
                        exit 1
        }
        '  \
  || printf "Incorrect header found in %s\n" "$file"
done

您可以轻松地将 awk 脚本中的正则表达式匹配模式调整为更严格或更宽松，具体取决于您的具体要求（也许您想要字母数字字符而不是“任何”，如.示例中的当前字符）。

该sed语句通过以下方式提取 YAML 标头：

• 抑制默认打印 ( -n)
• 要求匹配模式的地址行：行首，---行尾；第二个模式必须出现在第一个模式之后。
• p然后打印该地址范围

该awk脚本有点过度构建，但为了清楚起见，我想将其拼写出来。每次调用 awk 时，它都会将三个标志变量设置为零或假。如果我们看到符合我们标准的行，我们将相应的标志设置为 one/true。一旦看到所有行，我们将根据这些标志的状态返回成功或失败——它们必须全部为真才能“通过”验证。

将这些适当命名的示例文件分散到当前目录和一个子目录中：

$ tree .
.
├── bad1.md
├── good1.md
├── good2.md
└── subdir
    ├── bad1.md
    └── good1.md

1 directory, 5 files

...脚本输出：

Incorrect header found in bad1.md
Incorrect header found in subdir/bad1.md

要提取文件的标题，我们可以sed这样使用：

sed -e '1,/^---$/!d' -e '/^---$/d' filename

这将删除文件中的所有内容，除了第 1 行和下一行之间的行---。第二个表达式还删除---了数据中的所有行，这样您就只剩下 YAML 标头了。

我将使用来自 Andrey Kislyukyq的基于 Python 的实用程序。由于这是对多功能 JSON 解析器的方便包装，我们可以轻松检测对应于键的值是、非还是特定字符串等。jqnullnull

在jq语法中，我们可以测试一个键，keyname，是否存在于一个带有 的对象中has("keyname")。我们还可以使用 测试键的值是否与特定的正则表达式RE匹配.keyname | test("RE")。

问题中提到的测试可以翻译成以下jq表达式：

has("title")            and
(.title | test("."))    and
has("language")         and
(.language | test("[a-z]{2}"))  and
(has("external") or has("author"))

或者，更短但表现力较低，

(.title? != null) and
(.language? | test("[a-z]{2}")) and
(has("external") or has("author"))

这确保每个键都存在，并且需要具有非null值的键的值是正确的。

在三个示例文件上运行它，我们的测试在脚本文件中validate：

$ sed -e '1,/^---$/!d' -e '/^---$/d' file1.md | yq -f validate
true
$ sed -e '1,/^---$/!d' -e '/^---$/d' file2.md | yq -f validate
true
$ sed -e '1,/^---$/!d' -e '/^---$/d' file3.md | yq -f validate
false

我们可以将其概括为测试.md当前目录或以下目录中的所有文件，如下所示find：

find . -name '*.md' -type f -exec sh -c '
    for pathname do
        if ! sed -e "1,/^---\$/!d" -e "/^---\$/d" "$pathname" |
             yq -e -f validate >/dev/null
        then
            printf "Invalid YAML header: %s\n" "$pathname"
        fi
    done' sh {} +

或者，使用任何支持通配模式的 shell （使用in**启用）：shopt -s globstarbash

for pathname in ./**/*.md
do
    if ! sed -e '1,/^---$/!d' -e '/^---$/d' "$pathname" |
         yq -e -f validate >/dev/null
    then
        printf 'Invalid YAML header: %s\n' "$pathname"
    fi
done

在这里，我们还丢弃了输出yq，而是使用该工具及其-e选项。这使得实用程序的退出状态反映了最后计算的表达式的值，即在这种情况下，零表示true，非零表示false 。这使得直接在语句中使用我们的sed+管道变得容易。yqif

使用我们的三个测试文件运行它，我们得到

Invalid YAML header: ./file3.md