jekyll_strict_front_matter 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6cd43a41318abb600cf58558180d3b7b8ee47fb5
+  data.tar.gz: 6da73ed26fbdae74c4d4385bcae23811399f81e2
+SHA512:
+  metadata.gz: 9ae3b00a9e3ed1813534614b09735323ac2cb73b92bafa114ead6e3ebdcd756f4e1104fa216b826006d62f7aa32b979e35939c9bdb791d46a851ebbd10d4e3a8
+  data.tar.gz: 962446c2ad38d7bf278b8f45f3c38399518c2afe434baef362c742b18e78879a765290e8f1e796bbbf13a197e91748253181a08aa23602c82e1b0092a35c948e

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2017 Jonathan Hooper
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,21 @@
+By default, if a page or a post in a Jekyll site has a syntax error in the front matter, Jekyll logs an error, does not render anything for the given document, and continues. The result is a site without any content for the page with the syntax errors.
+
+This can be confusing for people who build sites without looking at the CLI, such as those of us whose sites build in a CI. In these cases, we may wish for our build to fail if there are front matter syntax errors. [This PR](https://github.com/jekyll/jekyll/pull/5832/files) seeks to add a config option for that, but in the meantime this plugin exists to fill the gap. This plugin may also be used to add the option to sites using an older version of Jekyll.
+
+# Gettings Started
+
+To use this plugin, first add the plugin to your Gemfile and run `bundle install`.
+
+```ruby
+group :jekyll_plugins do
+  gem "jekyll_strict_front_matter"
+end
+```
+
+Next, enable `strict_front_matter` by adding the option to your `_config.yml`:
+
+```yaml
+strict_front_matter: true
+```
+
+Now, a syntax error in the YAML should raise an error, stop the build, and result in a non-zero exit code.

data/lib/jekyll_strict_front_matter.rb

@@ -0,0 +1,23 @@
+module Jekyll
+  class StrictFrontMatterError < StandardError
+  end
+
+  Hooks.register :documents, :post_init do |document|
+    if !document.site.config["strict_front_matter"]
+      next
+    end
+
+    contents = File.read(document.path)
+
+    match_data = Document::YAML_FRONT_MATTER_REGEXP.match(contents)
+    if match_data
+      yaml = match_data[1]
+      begin
+        SafeYAML.load(yaml)
+      rescue => e
+        Jekyll.logger.error "Error:", "YAML Exception reading #{document.path}: #{e.message}"
+        raise StrictFrontMatterError
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_strict_front_matter
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jonathan Hooper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+description: |2
+      By default, if a page or a post in a Jekyll site has a syntax error in the
+      front matter, Jekyll logs an error, does not render anything for the given
+      page, and continues. The result is a site without any content for the
+      page with the syntax error.
+
+      This can be confusing for people who build sites without looking at the CLI,
+      such as those of us whose sites build in a CI. In these cases, we may wish
+      for our build to fail if there are front matter syntax errors.
+      [This PR](https://github.com/jekyll/jekyll/pull/5832/files) seeks to add a
+      config option for that, but in the meantime this plugin exists to fill the
+      gap. This plugin may also be used to add the option to sites using an older
+      version of Jekyll.
+email: jon9820@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/jekyll_strict_front_matter.rb
+homepage: http://rubygems.org/gems/jekyll-strict-front-matter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A jekyll plugin for raising for YAML front matter syntax errors
+test_files: []