如果指定的YAML字段丢失,则在Jekyll构建期间引发异常?

时间:2017-05-10 19:42:08

标签: ruby jekyll liquid jekyll-extensions

我想在Jekyll网站中构建逻辑,以便某个layout的页面将验证其YAML,如果缺少特定字段,或者具有错误的值类型等,则构建错误

一种解决方法是为Liquid过滤器编写一个kludgy插件,它只会收到错误消息并引发异常:

module Jekyll
  module ExceptionFilter
    def raise_error(msg)
        bad_file = @context.registers[:page]['path']
        err_msg = "On #{bad_file}: #{msg}"
      raise err_msg
    end
  end
end

Liquid::Template.register_filter(Jekyll::ExceptionFilter)

然后,在模板中,例如,我可以包含这个:

{% unless page.necessary_field %}
    {{ "You're missing necessary_field" | raise_error }}
{% endunless %}

这种方式可以完成工作。

我遇到的一个问题是,在发现一个错误时,构建过程会立即停止。我希望能够在repo中的所有.md文件中继续构建,并收集所有页面中的错误列表以在最后显示。 Based on the Jekyll docs,我认为liquid: error_mode: warn中的_config.yml会这样做,但事实并非如此。

1 个答案:

答案 0 :(得分:2)

您可以(ab)使用Generator在构建之前检查所有文件。您可以这样做:

module MyModule

  class WarningGenerator < Jekyll::Generator
    def generate(site)

      errors = Array.new

      site.posts.docs.each do |p|
        unless p.data['my_property'].any? {
           errors = "On #{p.title}: My Property is missing"

        }
      end

      errors.each do |error|
        puts error
      end

      raise "There were errors"
    end
  end
end

注意,此代码未经过测试:)

它将遍历您的所有页面,检查特定属性,如果未找到则向数组添加消息并在之后引发错误。